Boonton CPS2000 User Programming Manual

True-average connected power sensors
Hide thumbs Also See for CPS2000:
Table of Contents

Advertisement

PROGRAMMING REFERNCE
MANUAL
CPS2000
True-Average Connected Power Sensors
P/N: 98408300A
Rev. 20180720

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the CPS2000 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Boonton CPS2000

  • Page 1 PROGRAMMING REFERNCE MANUAL CPS2000 True-Average Connected Power Sensors P/N: 98408300A Rev. 20180720...
  • Page 2: Table Of Contents

    Table of Contents Introduction ............................5 1.1 Scope ..............................5 1.2 Referenced Documents ........................5 1.3 Definitions ............................5 Command Syntax ............................ 6 2.1 Command Parameters & Response Types ..................6 2.1.1 Numeric Parameters & Response Types ................6 2.1.2 Boolean Parameters & Response Types ................6 2.1.3 Discrete (Enumeration) Parameters &...
  • Page 3 Command Reference ..........................27 7.1 Common Commands (IEE488.2 Commands) ................. 27 *CLS 27 *ESE 27 *ESE? 27 *ESR? 28 *IDN? 28 *OPC 28 *OPC? 29 *RST 29 *SRE 30 *SRE? 30 *STB? 30 *TST? 31 7.2 Measurement Subsystem (MEASurement Commands) ..............31 FETCh[:SCALar][:POWer:AC]? ......................
  • Page 4 SYSTem:COMMunicate[:NETwork]:IP? ..................47 SYSTem:COMMunicate[:NETwork]:SUBNet .................. 47 SYSTem:COMMunicate[:NETwork]:SUBNet?................. 48 SYSTem:COMMunicate[:NETwork]:GATeway................48 SYSTem:COMMunicate[:NETwork]:GATeway? ................49 SYSTem:VERSion? .......................... 49 SYSTem:INFO? ..........................50 SYSTem:INFO:EXTended? ......................50 7.6 Trigger Subsystem (TRIGger Commands) ..................51 TRIGger:SOURce ..........................51 TRIGger:SOURce? ........................... 51 TRIGger[:IMMediate] ........................52 INITiate[:IMMediate] ........................52 INITiate:CONTinuous........................
  • Page 5: Introduction

    This document is intended to serve as a specification and reference for the instrument commands supported by the CPS2000 Series True-Average Connected Power Sensors. It is not intended to fully describe the SCPI language, as that information can be retrieved from the SCPI Consortium and/or IEEE.
  • Page 6: Command Syntax

    2 Command Syntax SCPI Commands and queries are sent as standard ASCII strings through various interfaces. Following standard SCPI ’99 syntax, the CPS2000 SCPI commands are made up of keywords, parameters, and various punctuation. Commands consist of one or more keywords, separated by colon “:” characters, with zero or more parameters starting with a <space>...
  • Page 7: Discrete (Enumeration) Parameters & Response Types

    SCPI commands and responses are terminated upon receipt of a message terminator. The CPS2000 series of power sensors make use of a new-line (\n) character as its message terminator. Additionally, for the CPS2000 series of devices, the maximum length allowed for a single command is 256 bytes.
  • Page 8: Syntax Conventions

    2.3 Syntax Conventions Specific syntax conventions are as follows: CHARACTERS DESCRIPTION EXAMPLE A vertical pipe character between UNIT:POWer <DBM|W> keywords and/or parameters indicates DBM and W are both accepted, but alternate choices. alternate choices. Indicates that the enclosed keywords are INITiate[:IMMediate] optional when composing a command.
  • Page 9 CHARACTERS DESCRIPTION EXAMPLE Upper-case Indicates the minimum set of characters SENSe:FREQuency? keyword for a command. In this command, only the SENS characters FREQ characters are required. As such, an equivalent command would be: SENS:FREQ? Lower-case Additional, optional characters for a INITiate:CONTinuous keyword command.
  • Page 10: Status Reporting

    In general, the status registers are always-positive (unsigned) 16-bit registers. Although SCPI supports the use of transition filters, the CPS2000 series of devices does not make use of any transition filters. Additionally, the SCPI specification includes an optional feature for remapping bits within the Operation and Questionable Status Registers.
  • Page 11: Transition Filter Registers

    3.1.2 Transition Filter Registers Although the SCPI specification defines a set of Transition Filter Registers, the CPS2000 devices do not include support for any transition filters. Instead, anytime a bit transitions from 0 to 1 in the Condition Register occcurs, the corresponding bit in the Event Register is set to 1.
  • Page 12 DESCRIPTION Waiting for Trigger bit Set when the instrument is in the WAITING_FOR_TRIGGER state. See Section 5 Measurement Sequence for more details. Waiting for ARM bit Not Used Correcting bit Not Used Not Used 8–12 Instrument Summary bit Not Used Programming Running bit Not Used Always Zero...
  • Page 13: Questionable Status

    3.3 Questionable Status The Questionable Status provides information indicating the quality of various aspects of the device. A bit set within the Questionable Status Condition Register indicates that the associated data is of questionable quality due to some condition affecting that parameter. For example, if the Temperature bit is set, that means the accuracy of the Temperature reading is of questionable quality.
  • Page 14: Standard Event Status

    DESCRIPTION Instrument Summary bit Not Used Command Warning bit Not Used Always Zero 3.4 Standard Event Status The Standard Event Status is a register described by IEEE 488.2. In general, it contains various error status information and basic operation information. From the full Status Registers Model, the Standard Event Status only consists of 2 registers: one containing the real-time status of standard events, and one to enable bits for generation of the Standard Event Status Summary Bit.
  • Page 15: Standard Event Status Enable Register

    DESCRIPTION Power On bit Not Used 3.4.2 Standard Event Status Enable Register The Standard Event Status Enable Register is read/write and configures which bits of the Standard Event Status Register constitute a 1 in the Standard Event Status Summary Bit. If a bit of the Standard Event Status Enable Register is configured as 1 and the corresponding bit of the Standard Event Status Register is also 1, the Standard Event Status Summary Bit will be set to a 1.
  • Page 16: Service Request Enable Register

    1 in the Service Request bit. The Service Request Enable Register can be configured using the *SRE command. 3.6 Error Codes The list of SCPI error codes that are reported by the CPS2000 series of devices is as follows: ERROR DESCRIPTION CODE General command error...
  • Page 17 ERROR DESCRIPTION CODE Unexpected number of parameters -115 Numeric data error -120 Suffix error -130 Character data error -140 String data error -150 Block data error -160 Expression error -170 General execution error -200 General parameter error -220 Data out of range error -222 Data corrupt or stale error -230...
  • Page 18: Scpi Conformance Information

    The CPS2000 series of devices complies with the specifications of SCPI version 1999.0. You can determine the exact SCPI version that a device implements using the SYSTem:VERSion? Query. The following commands are device-specific for the CPS2000 series of devices, and are not included in the 1999.0 revision of the SCPI standard: SENSe:FILTer:STATe SENSe:FILTer:STATe?
  • Page 19: Measurement Sequence

    5 Measurement Sequence The CPS2000 series of devices follows certain sequences when taking power measurements, depending on the configuration. Two different measurement modes are supported: a Single Measurement Mode and a Continuous Measurement Mode. The default measurement mode of the device is Single Measurement Mode.
  • Page 20: Continuous Measurement Mode

    STATE DESCRIPTION Device is idle, and no power measurement has been IDLE started or initiated. A power measurement is initiated, but waiting for a WAITING_FOR_TRIGGER trigger event. The power measurement is in-progress. MEASURING If a FETCh? command is received while the device is in this state, the resulting power measurement will be returned to the caller after the measurement is complete.
  • Page 21: Power Measurements

    Continuous Measurement Mode using the INITiate:CONTinuous command. 5.3.2 Power Measurement Averaging As an alternative to the Power Measurement Aperture, the CPS2000 series of devices also support basic averaging of data. Averaging of power measurements is controllable with the commands. Generally, when SENSe:AVERage:COUNt:AUTO...
  • Page 22 Filtering If Filtering is enabled, the first time FETCh? is sent (assuming the device is in the MEASURING state) the power measurement will be returned after a delay approximately equivalent to the filter time (aperture) window. Subsequence requests using FETCh? will incur no delay, but will instead immediately return with the latest power measurement.
  • Page 23: Example Command Sequences

    6 Example Command Sequences 6.1 Taking a Power Measurement with Software Triggering The following command sequence sets the trigger source for software triggering, initiates a power measurement, triggers the measurement, waits for the device to take the measurement, and then retrieves the actual power measurement.
  • Page 24: Setting Units, Offset, And Correction Frequency

    Set Offset to 12.3 dBm 12.3 Set Frequency to 1.5 GHz SENSe:FREQuency 1500000000 6.4 Retrieving Device Information This command sequence retrieves general device information. Query basic information *IDN? Boonton,CPS2008,000025,1.0.0 Request first group of extended SYSTem:INFO:EXTended? 0 information cal_date=2017-11-18; EXAMPLE COMMAND SEQUENCES Page 24...
  • Page 25: Enabling Operation Status Information & Detecting Status Changes

    6.5 Enabling Operation Status Information & Detecting Status Changes The following command sequence configures the Operation Status Register to enable bit 4 (measuring status bit) as a bit that sets the Operation Status Summary bit of the Status Byte, and then polls the register values until the Operation Status Summary bit is set.
  • Page 26 Set device’s static IP Address SYSTem:COMMunicate:NETwork:IP 192.168.1.101 Set device’s static Subnet Address SYSTem:COMMunicate:NETwork:SUBNET 255.255.255.0 Set device’s static Gateway Address SYSTem:COMMunicate:NETwork:GW 192.168.1.1 Query DHCP Enabled state SYSTem:COMMunicate:NETwork:DHCP? Query device IP Address SYSTem:COMMunicate:NETwork:IP? 192.168.1.101 Query device Subnet Address SYSTem:COMMunicate:NETwork:SUBNET? 255.255.255.0 Query device Gateway SYSTem:COMMunicate:NETwork:GW? 192.168.1.1 EXAMPLE COMMAND SEQUENCES...
  • Page 27: Command Reference

    7 Command Reference 7.1 Common Commands (IEE488.2 Commands) *CLS Syntax *CLS Parameters None Response None Description Clear Status command. Clears device status data structures. The Questionable Status Event Register, Operation Status Event Register, Standard Event Status Register, and Status Byte, and the Error/Event queue are all cleared by this command. *ESE Syntax *ESE <numerical_value>...
  • Page 28: Esr

    Basic identification information, including manufacturer, device model, device serial number, and device firmware version. Description Identification query. Retrieves basic identity information for the device. Example Request: *IDN? Response: Boonton,CPS2008,000025,1.0.0 *OPC Syntax *OPC Parameters None Response None Description Operation Complete command. COMMAND REFERENCE...
  • Page 29: Opc

    Sets bit 0 of the Standard Event Status register after all pending operations have completed. *OPC? Syntax *OPC? Parameters None Response <Boolean> Description Operation Complete query. Returns the ASCII character 1 when all pending operations have finished. *RST Syntax *RST Parameters None Response None Description Reset command.
  • Page 30: Sre

    *SRE Syntax *SRE Parameters <numerical_value> A numerical value serving as a bitmask for the bits that will be enabled. Range 0 – 255 Response None Description Service Request Enable command. Sets the value of the Service Request Enable register. See section 3.5 Status Byte for more information. *SRE? Syntax *SRE?
  • Page 31: Tst

    *TST? Syntax *TST? Parameters None Response <numerical_value> All tests passed One or more tests failed Description Self-Test query. Initiates an internal self-test and returns the result of that test. 7.2 Measurement Subsystem (MEASurement Commands) FETCh[:SCALar][:POWer:AC]? Syntax FETCh[:SCALar][:POWer:AC]? Parameters None Response <numerical_value>...
  • Page 32: Read[:Scalar][:Power:ac]

    For more details regarding the measurement cycles and when power measurements are available, see section 5 Measurement Sequence. Example Request: FETCh:SCALar:POWer:AC? Response: -3.566245e+01 READ[:SCALar][:POWer:AC]? Syntax READ[:SCALar][:POWer:AC]? Parameters None Response <numerical_value> A numerical power measurement in units as configured using the UNIT:POWer command.
  • Page 33: Fetch[:Scalar]:Temperature

    FETCh[:SCALar]:TEMPerature? Syntax FETCh[:SCALar]:TEMPerature? Parameters None Response <numerical_value> The current temperature reading from the device, in degrees Celsius. Description Retrieves the latest temperature measurement from the device. Unlike power measurements, temperature readings are always available and considered valid, with no measurement initiation, triggering, or sequencing required.
  • Page 34: Sense Subsystem (Sense Commands)

    7.3 Sense Subsystem (SENSe Commands) SENSe:AVERage:COUNt Syntax SENSe:AVERage:COUNt <numerical_value> Parameters <numerical_value> The averaging count to set. Only supports integer values. Range 1 – 2000 Default Value Response None Description Sets the averaging count in use by the device for power measurements. NOTE: Sending this command automatically disables automatic averaging.
  • Page 35: Sense:average:count:auto

    SENSe:AVERage:COUNt:AUTO Syntax SENSe:AVERage:COUNt:AUTO <Boolean> Parameters <Boolean> to enable automatic averaging by the device. to disable automatic averaging by the device. Default Value Response None Description Enables or disables automatic averaging for power measurements taken by the device. When set to 1, averaging of power measurements is automatically handled by the device and the averaging count is ignored.
  • Page 36: Sense:correction:offset[:Magnitude]

    SENSe:CORRection:OFFset[:MAGNitude] Syntax SENSe:CORRection:OFFset[:MAGNitude] <numerical_value> Parameters <numerical_value> The offset to use for power measurements, in dBm. Range -200.000 to 200.000 Default 0.000 Value Response None Description Sets an offset to use when the device takes power measurements, in dBm. Example SENSe:CORRection:OFFset:MAGNitude 12.510 SENSe:CORRection:OFFset[:MAGNitude]? Syntax SENSe:CORRection:OFFset[:MAGNitude]?
  • Page 37: Sense:filter:state

    SENSe:FILTer:STATe Syntax SENSe:FILTer:STATe <Boolean> Parameters <Boolean> A string corresponding to the mode to use for the power measurement filter. The power measurement filter is disabled and not used The power measurement filter is enabled and used according to the time configured with the command.
  • Page 38: Sense:filter:time

    Example Request: SENSe:FILTer:STATe? Response: SENSe:FILTer:TIMe Syntax SENSe:FILTer:TIMe <numeric_value> Parameters <numeric_value> The power measurement filter time to set, in milliseconds. Range 1 – 2000 Default Value Response None Description Configures the time-length of the power measurement filter. If the power measurement filter is disabled, this command will force the state to ON.
  • Page 39: Sense:frequency

    Example Request: SENSe:FILTer:TIMe? Response: SENSe:FREQuency Syntax SENSe:FREQuency <numerical_value><suffix> Parameters <numerical_value><suffix> The Correction Frequency to use for power measurements. Range 50MHZ - 8GHZ Default 1GHZ Value Supported HZ, KHZ, MHZ, GHZ Suffixes Response None Description Sets the correction frequency in use when taking power measurements. Note: Changing the correction frequency of the device will reset any filter or averaging buffers in use and as such, will incur a slight delay before the next...
  • Page 40: Status Subsystem (Status Commands)

    7.4 Status Subsystem (STATus Commands) STATus:OPERation[:EVENt]? Syntax STATus:OPERation[:EVENt]? Parameters None Response <numerical_value> The contents of the Operation Status Event Register Description Retrieves the value of the Operation Status Event Register. For details on the register definition, see section 3.2 Operation Status. NOTE: After returning the value of the Operation Status Event Register, the register value is cleared.
  • Page 41: Status:operation:enable

    STATus:OPERation:ENABle Syntax STATus:OPERation:ENABle Parameters <numerical_value> A bitmask corresponding to the bits that are to be enabled for generating the Operation Status Summary bit. Response None Description Enables bits for generating the Operation Status Summary bit. If a bit is set to 1 in the Operation Status Enable register using this command, and its associated bit in the Operation Status Event register is also set, then the Operation Status Summary bit in the Status Byte will be set to a 1.
  • Page 42: Status:questionable[:Event]

    STATus:QUEStionable[:EVENt]? Syntax STATus:QUEStionable[:EVENt]? Parameters None Response <numerical_value> The contents of the Questionable Event Status register Description Retrieves the value of the Questionable Event Status register. For details on the register itself, see section 0 Questionable Status. NOTE: After returning the value of the Questionable Status Event Register, the register value is cleared.
  • Page 43: Status:questionable:enable

    STATus:QUEStionable:ENABle Syntax STATus:QUEStionable:ENABle Parameters <numerical_value> A bitmask corresponding to the bits that are to be enabled in the Questionable Event Status register. Response None Description Enables true conditions for the Questionable Event Status register. If a bit is set to 1 in the enable register by this command, its associated event bit transitions are enabled.
  • Page 44: Status:preset

    STATus:PRESet Syntax STATus:PRESet Parameters None Response None Description Resets the device to power-on-reset settings. Includes resetting the device settings according to the *RST command and clearing the status registers according to the *CLS command, and resets the following status registers: Register PRESet Value Operation Event Register...
  • Page 45: System Subsystem (System Commands)

    7.5 System Subsystem (SYSTem Commands) SYSTem:ERRor[:NEXT]? Syntax SYSTem:ERRor[:NEXT]? Parameters None Response <numeric_value>,<string-description> <numeric_value> An error/event number corresponding to the error/event retrieved from the device’s error/event queue. <string-description> A brief textual description of the error/event retrieved from the device’s error/event queue. Description Retrieves the next error/event from the device’s error/event queue.
  • Page 46: System:communicate[:Network]:Dhcp

    SYSTem:COMMunicate[:NETwork]:DHCP Syntax SYSTem:COMMunicate[:NETwork]:DHCP <Boolean> Parameters <Boolean> to enable use of DHCP and dynamic IP configuration. to disable use of DHCP and dynamic IP configuration. Default Value Response None Description Configures whether or not the device uses DHCP to obtain a dynamic IP address.
  • Page 47: System:communicate[:Network]:Ip

    SYSTem:COMMunicate[:NETwork]:IP Syntax SYSTem:COMMunicate[:NETwork]:IP <string-IP Address> Parameters <string-IP Address> The IP address to use when DHCP is disabled. Must be a properly formatted IP v4 address formatted as: xx.xx.xx.xx where is a number in the range of 0 – 255. Response None Description Configures the static IP address to use when DHCP is disabled.
  • Page 48: System:communicate[:Network]:Subnet

    xx.xx.xx.xx where is a number in the range of 0 – 255. Response None Description Configures the Subnet Mask to use when DHCP is disabled. Has no effect unless DHCP is disabled, as configured using the SYSTem:COMMunicate[:NETwork]:DHCP command. SYSTem:COMMunicate[:NETwork]:SUBNet? Syntax SYSTem:COMMunicate[:NETwork]:SUBNet? Parameters None Response...
  • Page 49: System:communicate[:Network]:Gateway

    SYSTem:COMMunicate[:NETwork]:GATeway? Syntax SYSTem:COMMunicate[:NETwork]:GATeway? Parameters None Response <string-IP Address> The Default Gateway IP address in use by the device, in the form of: xx.xx.xx.xx where is a number in the range of 0 – 255. Description Retrieves the current Default Gateway IP address in use by the device. If DHCP is enabled, this address corresponds to the Gateway IP address automatically obtained via DHCP.
  • Page 50: System:info

    SYSTem:INFO? Syntax SYSTem:INFO? <string-item> Parameters <string-item> Name of the extended information field to retrieve Response <string-item-value> Value of the extended information field requested Description Retrieves a specific field of the extended device information. Example Request: SYSTem:INFO? cal_date Response: 2017-11-18 SYSTem:INFO:EXTended? Syntax SYSTem:INFO:EXTended? <numeric_value>...
  • Page 51: Trigger Subsystem (Trigger Commands)

    7.6 Trigger Subsystem (TRIGger Commands) TRIGger:SOURce Syntax TRIGger:SOURce <HOLD|IMMediate|BUS> Parameters <HOLD|IMMediate|BUS> A string corresponding to the trigger source used when taking power measurements. Supported options include: Triggering is suspended. Waits to take a power HOLD measurement until a trigger event is signaled using the TRIGger[:IMMediate] command.
  • Page 52: Trigger[:Immediate]

    Possible options include: Triggering is suspended. Waits to take a power HOLD measurement until a trigger event is signaled using the TRIGger[:IMMediate] command. Use an immediate trigger, that is, do not wait on a IMMediate specific triggering event before taking a power measurement.
  • Page 53: Initiate:continuous

    INITiate:CONTinuous Syntax INITiate:CONTinuous <Boolean> Parameters <Boolean> to enable continuous triggering mode. to disable continuous triggering mode. Response None Description Selects whether the triggering system is continuously initiated or not. When set to 0, the triggering system remains idle until Continuous mode is enabled or until an INITiate:IMMediate command is received.
  • Page 54: Unit Subsystem (Unit Commands)

    7.7 Unit Subsystem (UNIT Commands) UNIT:POWer Syntax UNIT:POWer <DBM|W> Parameters <DBM|W> A string corresponding to the units to use when taking power measurements. Supported options include: Power ratio in decibels (dB) in reference to one milliwatt (mW) Power in Watts Default Value Response None...
  • Page 55: Revision Notes

    Wireless Telecom Group Inc. 25 Eastmans Rd Parsippany, NJ 07054 United States of America Tel: +1 973 386 9696 Fax: +1 973 386 9191 www.boonton.com © Copyright 2018 All rights reserved. Note: Specifications, terms and conditions are subject to change without prior notice.

Table of Contents