ZTS Series Solid-State Switch Systems

Transcription

1 Test Solutions - Programming Manual ZTS Series Solid-State Switch Systems PO Box , Brooklyn, NY sales@minicircuits.com

2 Important Notice This guide is owned by Mini-Circuits and is protected by copyright, trademark and other intellectual property laws. The information in this guide is provided by Mini-Circuits as an accommodation to our customers and may be used only to promote and accompany the purchase of Mini-Circuits parts. This guide may not be reproduced, modified, distributed, published, stored in an electronic database, or transmitted and the information contained herein may not be exploited in any form or by any means, electronic, mechanical recording or otherwise, without prior written permission from Mini-Circuits. This guide is subject to change, qualifications, variations, adjustments or modifications without notice and may contain errors, omissions, inaccuracies, mistakes or deficiencies. Mini-Circuits assumes no responsibility for, and will have no liability on account of, any of the foregoing. Accordingly, this guide should be used as a guideline only. Trademarks Microsoft, Windows, Visual Basic, Visual C# and Visual C++ are registered trademarks of Microsoft Corporation. LabVIEW and CVI are registered trademarks of National Instruments Corporation. Delphi is a registered trademark of Delphi Technologies, Inc. MATLAB is a registered trademark of The MathWorks, Inc. Agilent VEE is a registered trademark of Agilent Technologies, Inc. Linux is a registered trademark of Linus Torvalds. Mac is a registered trademark of Apple Inc. Python is a registered trademark of Python Software Foundation Corporation. All other trademarks cited within this guide are the property of their respective owners. Neither Mini-Circuits nor the Mini-Circuits PTE (portable test equipment) series are affiliated with or endorsed or sponsored by the owners of the above referenced trademarks. Mini-Circuits and the Mini-Circuits logo are registered trademarks of Scientific Components Corporation. Mini-Circuits 13 Neptune Avenue Brooklyn, NY 11235, USA Phone: sales@minicircuits.com Web:

3 1 - Overview SCPI Commands for Control of ZTS Series Switch Systems SCPI Address Structure Control Options System Queries (a) - Get Model Name (b) - Get Serial Number (c) - Count Number of Switch Modules (d) - Get Firmware Switch Control (a) - Set SPDT Switch (b) - Query SPDT Switch State (c) - Set SP8T Switch (d) - Query SP8T Switch State (e) - Set All Switches (f) - Set Multiple Switches (g) - Set All Switches in Ascending Pattern Manual Trigger Control (a) - Reset Trigger In (b) - Query Trigger In (c) - Set Trigger Out Switch Sequence Configuration (a) - Set Number of Steps (b) - Query Number of Steps (c) - Set Indexed Step (d) - Query Indexed Step Number (e) - Set Switch Command for Indexed Step (f) - Query Switch Command for Indexed Step (g) - Set Dwell Time for Indexed Step (h) - Query Dwell Time for Indexed Step (i) - Set Continuous Mode (j) - Query Continuous Mode (k) - Set Number of Cycles (l) - Query Number of Cycles (m) - Set Trigger-In Mode (n) - Query Trigger-In Mode (o) - Set Trigger-Out Mode (p) - Query Trigger-Out Mode (q) - Start / Stop Switch Sequence SCPI - Ethernet Configuration Commands (a) - Set Static IP Address (b) - Get Static IP Address (c) - Set Static Subnet Mask (d) - Get Static Subnet Mask (e) - Set Static Network Gateway (f) - Get Static Network Gateway (g) - Set HTTP Port (h) - Get HTTP Port (i) - Set Telnet Port Test Solutions - Programming Manual Page 3

4 2.7 (j) - Get Telnet Port (k) - Set Password Requirement (l) - Get Password Requirement (m) - Set Password (n) - Get Password (o) - Set DHCP Status (p) - Get DHCP Status (q) - Get MAC Address (r) - Get Current Ethernet Configuration (s) - Update Ethernet Settings Ethernet Control over IP Networks Ethernet Communication (a) - Sending SCPI Commands / Queries Using HTTP (b) - Sending SCPI Commands / Queries Using Telnet Device Discovery Using UDP USB Control in a Windows Environment The DLL (Dynamic Link Library) Concept (a) - ActiveX COM Object (b) - Microsoft.NET Class Library Referencing the DLL (Dynamic Linked Library) Summary of DLL Functions (a) - DLL Functions for USB Control (b) - DLL Functions for Ethernet Configuration DLL - General Functions (a) - Connect by Serial Number (b) - Connect by Address (c) - Disconnect (d) - Send SCPI Command DLL - Ethernet Configuration Functions (a) - Get Ethernet Configuration (b) - Get IP Address (c) - Get MAC Address (d) - Get Network Gateway (e) - Get Subnet Mask (f) - Get TCP/IP Port (g) - Get DHCP Status (h) - Get Password Status (i) - Get Password (j) - Save IP Address (k) - Save Network Gateway (l) - Save Subnet Mask (m) - Save TCP/IP Port (n) - Use DHCP (o) - Use Password (p) - Set Password USB Control Using Interrupt Codes USB Interrupt Code Concept Interrupts General Commands (a) - Send SCPI Command Test Solutions - Programming Manual Page 4

5 5.3 - Interrupts - Ethernet Configuration Commands (a) - Set Static IP Address (b) - Set Static Subnet Mask (c) - Set Static Network Gateway (d) - Set HTTP Port (e) - Set Telnet Port (f) - Use Password (g) - Set Password (h) - Use DHCP (i) - Get Static IP Address (j) - Get Static Subnet Mask (k) - Get Static Network Gateway (l) - Get HTTP Port (m) - Get Telnet Port (n) - Get Password Status (o) - Get Password (p) - Get DHCP Status (q) - Get Dynamic Ethernet Configuration (r) - Get MAC Address (s) - Reset Ethernet Configuration Test Solutions - Programming Manual Page 5

6 1 - Overview This programming manual is intended for customers wishing to create their own interface for Mini- Circuits' ZTS Series solid-state switch systems. For instructions on using the supplied GUI program, or connecting the hardware, please see the User Guide at: Mini-Circuits offers support over a variety of operating systems, programming environments and third party applications. Support for Windows operating systems is provided through the Microsoft.NET and ActiveX frameworks to allow the user to develop customized control applications. Support for Linux operating systems is accomplished using the standard libhid and libusb libraries. Mini-Circuits has experience with a wide variety of environments including (but not limited to): Visual Basic, Visual C#, Visual C++ Delphi Borland C++ CVI LabVIEW MATLAB Python Agilent VEE The software package includes a GUI program, ActiveX and.net DLL files, Linux support, project examples for third party software, and detailed user manuals. The latest package is available for download at: Files made available for download from the Mini-Circuits website are subject to Mini-Circuits terms of use which are available on the website. Test Solutions - Programming Manual Page 6

7 2 - SCPI Commands for Control of ZTS Series Switch Systems Mini-Circuits ZTS Series switch systems are controlled using a series of commands / queries based on the SCPI format (Standard Commands for Programmable Instruments, a common method for controlling instrumentation products). The SCPI commands / queries are case insensitive and sent as an ASCII text string (up to 63 characters). The responses from the switch system are also in the form of an ASCII text string SCPI Address Structure The system is comprised of a controller and a series of solid-state switch modules, each of which can be controlled via its unique internal 2-digit address using the format ADDRESS:COMMAND. System queries can be sent to the controller at address 00, although the address component can be omitted for these commands. The switch modules are addressed from 01 to nn, depending on the specific ZTS model. :[address]:[command] Where: [address] 2 digit address of the switch module to command or query: o 00 is the controller o 01 is switch module 1 o 02 is switch module 2 o nn is the final switch module 00 will be assumed if the address component is omitted SL is the address for all switch modules Note: Some switch modules contain multiple individual switches which can each be individually controlled, refer to the individual switch commands for details (see Switch Control) [command] The command or query to send to the switch module Control Options Communication with the system can be accomplished using one of the following approaches: 1. Using HTTP or Telnet communication over an Ethernet connection (see Ethernet Control over IP Networks), which is largely independent of the operating system 2. Using the provided ActiveX or.net API objects (DLL files) on a Windows operating system (see USB Control in a Windows Environment) 3. Using USB interrupt codes on Unix based operating systems (see USB Control Using Interrupt Codes) Test Solutions - Programming Manual Page 7

8 2.3 - System Queries These queries return information on the complete ZTS Series system. Since they apply to the system s internal controller, the address component (00) can be omitted from the queries. a Get Model Name :MN? b Get Serial Number Command/Query :SN? c Count Number of Switch Modules :NumberOfSlaves? d Get Firmware :FIRMWARE? 2.3 (a) - Get Model Name Returns the Mini-Circuits part number of the ZTS Series system. Command Syntax :MN? Return String [model] Variable [model] Model name of the ZTS Series system Examples String to Send :MN? String Returned ZTS-8SP8T-63 Get Serial Number Count Number of Switch Modules Get Firmware Test Solutions - Programming Manual Page 8

9 2.3 (b) - Get Serial Number Returns the serial number of the ZTS Series system. Command Syntax :SN? Return String [serial] Variable [serial] Serial number of the ZTS Series system Examples String to Send String Returned :SN? Get Model Name Count Number of Switch Modules Get Firmware Test Solutions - Programming Manual Page 9

10 2.3 (c) - Count Number of Switch Modules Returns the number of switch modules within the ZTS Series system. Command Syntax :NumberOfSlaves? Return String [count] Variable [count] The number of switch modules Examples String to Send String Returned : NumberOfSlaves? 8 Get Model Name Get Serial Number Get Firmware Test Solutions - Programming Manual Page 10

11 2.3 (d) - Get Firmware Returns the firmware version of the ZTS Series system. Command Syntax :FIRMWARE? Return String [firmware] Variable [firmware] Firmware version name Examples String to Send String Returned :FIRMWARE? A1-2 Get Model Name Get Serial Number Count Number of Switch Modules Test Solutions - Programming Manual Page 11

12 2.4 - Switch Control Command/Query a Set SPDT Switch :[address]:sp2t:[sw_name]:state:[port] b Query SPDT Switch State :[address]:sp2t:[sw_name]:state? c Set SP8T Switch :[address]:sp8t:state:[port] d Query SP8T Switch State :[address]:sp8t:state? e Set All Switches :SL:C-[sw_state] f Set Multiple Switches :SL:[[sw x-y]-[state x-y]] g Set All Switches in Ascending Pattern :SL:CA Test Solutions - Programming Manual Page 12

13 2.4 (a) - Set SPDT Switch Sets the state of an SPDT switch. Command Syntax :[address]:sp2t:[sw_name]:state:[sw_state] Variable [sw_name] [sw_state] Switch name, "A", "B", "C" or "D" (model dependent) The switch state to set, either 1 (COM <> port 1) or 2 (COM <> port 2) Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :01:SP2T:A:STATE:1 1 :01:SP2T:D:STATE:2 1 Query SPDT Switch State Set SP8T Switch Query SP8T Switch State Test Solutions - Programming Manual Page 13

14 2.4 (b) - Query SPDT Switch State Returns the state of an SPDT switch. Command Syntax :[address]:sp2t:[sw_name]:state? Variable [sw_name] Switch name, "A", "B", "C" or "D" (model dependent) Return String Examples [state] Variable Value [state] 1 Switch state is COM <> port 1 2 Switch state is COM <> port 2 String to Send String Returned :01:SP2T:A:STATE? :01:1 :01:SP2T:D:STATE? :01:2 Set SPDT Switch Set SP8T Switch Query SP8T Switch State Test Solutions - Programming Manual Page 14

15 2.4 (c) - Set SP8T Switch Sets the state of an SP8T switch. Command Syntax :[address]:sp8t:state:[sw_state] Variable [sw_state] The switch state to set, from 1 (COM <> port 1) to 8 (COM <> port 8) Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :01:SP8T:STATE:1 1 :01:SP8T:STATE:8 1 Set SPDT Switch Query SPDT Switch State Query SP8T Switch State Set All Switches Set Multiple Switches Test Solutions - Programming Manual Page 15

16 2.4 (d) - Query SP8T Switch State Returns the state of an SP8T switch. Command Syntax Return String Examples :[address]:sp8t:state? [state] Variable Value [state] 1 to 8 Switch state, from 1 (COM <> port 1) to 8 (COM <> port 8) String to Send String Returned :01:SP8T:STATE? :01:8 Set SPDT Switch Query SPDT Switch State Set SP8T Switch Set All Switches Set Multiple Switches Test Solutions - Programming Manual Page 16

17 2.4 (e) - Set All Switches Sets all switches to the same state. Command Syntax :SL:C-[sw_state] Variable [sw_state] The switch state to set, from 1 (COM <> port 1) to 8 (COM <> port 8) Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SL:C-1 1 :SL:C-8 1 Set SP8T Switch Query SP8T Switch State Set Multiple Switches Set All Switches in Ascending Pattern Test Solutions - Programming Manual Page 17

18 2.4 (f) - Set Multiple Switches Takes a string of switch number / state pairs to set multiple switches with a single command. Any combination of switches can be set so the command string does not need to be supplied in ascending switch address order. Command Syntax :SL:[sw 1]-[state 1]:[sw 2]-[state 2]:[sw 3]-[state 3] :[sw n]-[state n] Variable [sw 1] state 1 [sw n] state n The first switch number to set The state (1 to 8) to which the first switch is to be set The nth switch number to set The state (1 to 8) to which the nth switch is to be set Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SL:1-2:2-2:3-7 1 :SL:1-3:2-7:3-5:4-4:5-1:6-3:7-4:8-6 1 Set SP8T Switch Query SP8T Switch State Set All Switches Set All Switches in Ascending Pattern Test Solutions - Programming Manual Page 18

19 2.4 (g) - Set All Switches in Ascending Pattern Sets all switches in the system so that each has its Com port connected to the next port in an ascending pattern from 1 to n, ie: SW1: Com <> port 1 SW2 : Com <> port 2 SW2: Com <> port 3 SWn: Com <> port n Command Syntax :SL:CA Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SL:CA 1 Set SP8T Switch Query SP8T Switch State Set All Switches Set Multiple Switches Test Solutions - Programming Manual Page 19

20 2.5 - Manual Trigger Control These functions apply to ZTS Series systems specified with external trigger ports. Command/Query a Reset Trigger In :ClearTriggerInStatus b Query Trigger In :TriggerInStatus c Set Trigger Out :InitTriggerOut Test Solutions - Programming Manual Page 20

21 2.5 (a) - Reset Trigger In Only applicable to ZTS Series models specified with external trigger ports. Resets the internal Trigger In flag. Should be used after a trigger input has been processed so that the next trigger input signal can be detected. Command Syntax Return String Examples :ClearTriggerInStatus [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :ClearTriggerInStatus 1 Query Trigger In Set Trigger Out Test Solutions - Programming Manual Page 21

22 2.5 (b) - Query Trigger In Only applicable to ZTS Series models specified with external trigger ports. Returns the state of the internal Trigger In flag, to identify whether a trigger input signal has been received. Command Syntax Return String Examples :TriggerInStatus? [status] Variable Value [status] 0 Trigger In port at logic 0 (low) 1 Trigger In port at logic 1 (high) String to Send String Returned :TriggerInStatus? 0 :TriggerInStatus? 1 Reset Trigger In Set Trigger Out Test Solutions - Programming Manual Page 22

23 2.5 (c) - Set Trigger Out Only applicable to ZTS Series models specified with external trigger ports. Creates a trigger output signal (TTL high) of 100 µs duration, then resets to TLL low. Command Syntax Return String Examples :InitTriggerOut [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :InitTriggerOut 1 Reset Trigger In Query Trigger In Test Solutions - Programming Manual Page 23

24 2.6 - Switch Sequence Configuration These commands allow a sequence of switch states to be programmed. Command/Query a Set Number of Steps :SEQ:STEP:[steps] b Query Number of Steps :SEQ:STEP? c Set Indexed Step :SEQ:STEP:[index] d Query Indexed Step Number :SEQ:STEP? e Set Switch Command for Indexed Step :SEQ:COMMAND:[command] f Query Switch Command for Indexed Step :SEQ:COMMAND g Set Dwell Time for Indexed Step :SEQ:DWELL:[time] h Query Dwell Time for Indexed Step :SEQ:DWELL? i Set Continuous Mode :SEQ:CONT:[mode] j Query Continuous Mode :SEQ:CONT? k Set Number of Cycles :SEQ:CYCLES:[count] l Query Number of Cycles :SEQ:CYCLES? m Set Trigger-In Mode :SEQ:TRIGGERIN:[mode] n Query Trigger-In Mode :SEQ:TRIGGERIN? o Set Trigger-Out Mode :SEQ:TRIGGEROUT:[mode] p Query Trigger-Out Mode :SEQ:TRIGGEROUT? q Start / Stop Switch Sequence :SEQ:MASTERMODE:[mode] Test Solutions - Programming Manual Page 24

25 2.6 (a) - Set Number of Steps Sets the number of steps to be included in the switch sequence. Command Syntax :SEQ:STEPS:[steps] Variable [steps] The number of steps to program in the sequence Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SEQ:STEPS:10 1 Query Number of Steps Set Indexed Step Query Indexed Step Number Test Solutions - Programming Manual Page 25

26 2.6 (b) - Query Number of Steps Returns the number of steps set to be included in the switch sequence. Command Syntax :SEQ:STEPS? Return String [steps] Variable [steps] Number of steps to be included in the switch sequence Examples String to Send String Returned :SEQ:STEPS? 10 Set Number of Steps Set Indexed Step Query Indexed Step Number Test Solutions - Programming Manual Page 26

27 2.6 (c) - Set Indexed Step Indexes a specific step number (1 to n) so that its parameters (such as dwell time and switch state) can be set. Command Syntax :SEQ:STEP:[index] Variable [index] The step number to be configured Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SEQ:STEP:2 1 Set Number of Steps Query Number of Steps Query Indexed Step Number Test Solutions - Programming Manual Page 27

28 2.6 (d) - Query Indexed Step Number Returns the index number (1 to n) of the step currently being configured. Command Syntax :SEQ:STEPS? Return String [index] Variable [index] The step number (1 to n) to be configured Examples String to Send String Returned :SEQ:STEP? 2 Set Number of Steps Query Number of Steps Set Indexed Step Test Solutions - Programming Manual Page 28

29 2.6 (e) - Set Switch Command for Indexed Step The switch command to be sent for the indexed step in the switch sequence. Command Syntax :SEQ:COMMAND:[command] Variable [command] Any valid switch state command (see Switch Control) Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SEQ:STEP:COMMAND:01:SP2T:D:STATE:2 1 Set Indexed Step Query Indexed Step Number Query Switch Command for Indexed Step Set Dwell Time for Indexed Step Query Dwell Time for Indexed Step Test Solutions - Programming Manual Page 29

30 2.6 (f) - Query Switch Command for Indexed Step Returns the switch command to be sent for the indexed step in the switch sequence. Command Syntax :SEQ:COMMAND? Return String [command] Variable [command] The switch command to be executed at this step in the switch sequence Examples String to Send :SEQ:COMMAND? String Returned :01:SP2T:D:STATE:2 Set Indexed Step Query Indexed Step Number Set Switch Command for Indexed Step Set Dwell Time for Indexed Step Query Dwell Time for Indexed Step Test Solutions - Programming Manual Page 30

31 2.6 (g) - Set Dwell Time for Indexed Step Sets the length of time (microseconds) for which the system will pause at the latest switch state, before proceeding with the switch sequence. Note: If Trigger-In mode is enabled the system will wait for a trigger input signal before loading a switch state, then pause for the specified dwell before checking for the next trigger signal. Alternatively, dwell time can be set to 0 in this mode if each step is to be loaded based only on the trigger signal. Command Syntax :SEQ:DWELL:[time] Variable [time] The length of time in µs to pause at this step before proceeding with the switch sequence Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SEQ:DWELL:250 1 Set Indexed Step Query Indexed Step Number Set Switch Command for Indexed Step Query Switch Command for Indexed Step Query Dwell Time for Indexed Step Set Trigger-In Mode Test Solutions - Programming Manual Page 31

32 2.6 (h) - Query Dwell Time for Indexed Step Returns the length of time (microseconds) for which the system will pause at the latest switch state, before proceeding with the switch sequence. Note: If Trigger-In mode is enabled the system will wait for a trigger input signal before loading a switch state, then pause for the specified dwell before checking for the next trigger signal. Alternatively, dwell time can be set to 0 in this mode if each step is to be loaded based only on the trigger signal. Command Syntax Return String :SEQ:DWELL? [time] Variable [time] The length of time in µs for which the system will pause at this step before proceeding with the switch sequence Examples String to Send String Returned :SEQ:DWELL? 250 Set Indexed Step Query Indexed Step Number Set Switch Command for Indexed Step Query Switch Command for Indexed Step Set Dwell Time for Indexed Step Set Trigger-In Mode Test Solutions - Programming Manual Page 32

33 2.6 (i) - Set Continuous Mode Sets whether the system should cycle continuously through the programmed switch sequence or execute it once only. Command Syntax Return String Examples :SEQ:CONT:[mode] Variable Value [mode] 0 Continuous mode disabled (sequence will execute once only) 1 Continuous mode enabled (sequence will repeat continuously) [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SEQ:CONT:0 1 :SEQ:CONT:1 1 Query Continuous Mode Set Number of Cycles Query Number of Cycles Test Solutions - Programming Manual Page 33

34 2.6 (j) - Query Continuous Mode Indicates whether the system has been set to cycle continuously through the programmed switch sequence or execute it once only. Command Syntax Return String Examples :SEQ:CONT? [mode] Variable Value [mode] 0 Continuous mode disabled (sequence will execute once only) 1 Continuous mode enabled (sequence will repeat continuously) String to Send String Returned :SEQ:CONT? 1 Set Continuous Mode Set Number of Cycles Query Number of Cycles Test Solutions - Programming Manual Page 34

35 2.6 (k) - Set Number of Cycles Sets the number of times that the programmed switch sequence is to be executed. Note: If Continuous Mode is enabled then the setting for number of cycles will be ignored and the sequence will run continuously. Disable Continuous mode in order to set a number of cycles. Command Syntax :SEQ:CYCLES:[count] Variable [count] The number of cycles / repetitions of the switch sequence to execute Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SEQ:CYCLES:5 1 Set Continuous Mode Query Continuous Mode Query Number of Cycles Test Solutions - Programming Manual Page 35

36 2.6 (l) - Query Number of Cycles Queries the number of times that the programmed switch sequence is set to be executed. Command Syntax :SEQ:CYCLES? Return String [COUNT] Variable [count] The number of cycles / repetitions of the switch sequence to be executed Examples String to Send String Returned :SEQ:CYCLES? 5 Set Continuous Mode Query Continuous Mode Set Number of Cycles Test Solutions - Programming Manual Page 36

37 2.6 (m) - Set Trigger-In Mode Sets how the switch sequence responds to an external trigger input signal: Trigger-In enabled: o Each step in the sequence is executed when a trigger input is detected o The system will then pause for the specified dwell time before checking for the next trigger input signal (dwell time can be set to 0) Trigger-In disabled: o Each step in the sequence is executed based only on the specified dwell times o Trigger input signals are ignored Command Syntax Return String Examples :SEQ:TRIGGERIN:[mode] Variable Value [mode] 0 Trigger-In mode disabled 1 Trigger-In mode enabled [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SEQ:TRIGGERIN:0 1 :SEQ:TRIGGERIN:1 1 Query Trigger-In Mode Set Trigger-Out Mode Query Trigger-Out Mode Test Solutions - Programming Manual Page 37

38 2.6 (n) - Query Trigger-In Mode Queries how the switch sequence responds to an external trigger input signal: Trigger-In enabled: o Each step in the sequence is executed when a trigger input is detected o The system will then pause for the specified dwell time before checking for the next trigger input signal (dwell time can be set to 0) Trigger-In disabled: o Each step in the sequence is executed based only on the specified dwell times o Trigger input signals are ignored Command Syntax Return String Examples :SEQ:TRIGGERIN? [mode] Variable Value [mode] 0 Trigger-In mode disabled 1 Trigger-In mode enabled String to Send String Returned :SEQ:TRIGGERIN? 1 Set Trigger-In Mode Set Trigger-Out Mode Query Trigger-Out Mode Test Solutions - Programming Manual Page 38

39 2.6 (o) - Set Trigger-Out Mode Sets whether a trigger output signal is to be set after each step in the switch sequence has been set. Command Syntax Return String Examples :SEQ:TRIGGEROUT:[mode] Variable Value [mode] 0 Trigger-Out mode disabled (no trigger output signal is set) 1 Trigger-Out mode enabled (trigger output signal is set after each step in the switch sequence) [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SEQ:TRIGGEROUT:0 1 :SEQ:TRIGGEROUT:1 1 Set Trigger-In Mode Query Trigger-In Mode Query Trigger-Out Mode Test Solutions - Programming Manual Page 39

40 2.6 (p) - Query Trigger-Out Mode Queries whether a trigger output signal is to be set after each step in the switch sequence has been set. Command Syntax Return String Examples :SEQ:TRIGGEROUT? [mode] Variable Value [mode] 0 Trigger-Out mode disabled (no trigger output signal is to be set) 1 Trigger-Out mode enabled (trigger output signal is to be set after each step in the switch sequence) String to Send String Returned :SEQ:TRIGGEROUT? 1 Set Trigger-In Mode Query Trigger-In Mode Set Trigger-Out Mode Test Solutions - Programming Manual Page 40

41 2.6 (q) - Start / Stop Switch Sequence Starts or stops the switch sequence based on the previously defined parameters. Note: Any command / query sent to the system while a switch sequence is in process will stop the sequence. Command Syntax Return String Examples :SEQ:MASTERMODE:[mode] Variable Value [mode] OFF Disables / stops the switch sequence ON Enables / starts the switch sequence [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :SEQ:MASTERMODE:OFF 1 :SEQ:MASTERMODE:ON 1 Test Solutions - Programming Manual Page 41

42 2.7 - SCPI - Ethernet Configuration Commands These functions apply ZTS Series models with firmware A2 or later. Command/Query a Set Static IP Address :ETHERNET:CONFIG:IP:[ip] b Get Static IP Address :ETHERNET:CONFIG:IP? c Set Static Subnet Mask :ETHERNET:CONFIG:SM:[mask] d Get Static Subnet Mask :ETHERNET:CONFIG:SM? e Set Static Network Gateway :ETHERNET:CONFIG:NG:[gateway] f Get Static Network Gateway :ETHERNET:CONFIG:NG? g Set HTTP Port :ETHERNET:CONFIG:HTPORT:[port] h Get HTTP Port :ETHERNET:CONFIG:HTPORT? i Set Telnet Port :ETHERNET:CONFIG:TELNETPORT:[port] j Get Telnet Port :ETHERNET:CONFIG:TELNETPORT? k Set Password Requirement :ETHERNET:CONFIG:PWDENABLED:[enabled] l Get Password Requirement :ETHERNET:CONFIG:PWDENABLED? m Set Password :ETHERNET:CONFIG:PWD:[pwd] n Get Password :ETHERNET:CONFIG:PWD? o Set DHCP Status :ETHERNET:CONFIG:DHCPENABLED:[enabled] p Get DHCP Status :ETHERNET:CONFIG:DHCPENABLED? q Get MAC Address :ETHERNET:CONFIG:MAC? r Get Current Ethernet Configuration :ETHERNET:CONFIG:LISTEN? s Update Ethernet Settings :ETHERNET:CONFIG:INIT Test Solutions - Programming Manual Page 42

43 2.7 (a) - Set Static IP Address Requirements Sets the IP address to be used by the system for Ethernet communication when using static IP settings. DHCP must be disabled for this setting to apply, otherwise a dynamic IP address will be in use. Changes to the Ethernet configuration only take effect after the Update Ethernet Settings command has been issued. ZTS Series models with firmware A2 or later. Command Syntax :ETHERNET:CONFIG:IP:[ip] Variable [ip] The static IP address to be used by the system; must be valid and available on the network Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :ETHERNET:CONFIG:IP: HTTP Implementation: Get Static IP Address Set Static Subnet Mask Set Static Network Gateway Update Ethernet Settings Test Solutions - Programming Manual Page 43

44 2.7 (b) - Get Static IP Address Requirements Returns the IP address to be used by the system for Ethernet communication when static IP settings are in use. DHCP must be disabled for this setting to apply, otherwise a dynamic IP address will be in use. ZTS Series models with firmware A2 or later. Command Syntax Return String :ETHERNET:CONFIG:IP? [ip] Variable [ip] The static IP address to be used by the system Examples String to Send String Returned :ETHERNET:CONFIG:IP? HTTP Implementation: Set Static IP Address Get Static Subnet Mask Get Static Network Gateway Get Current Ethernet Configuration Test Solutions - Programming Manual Page 44

45 2.7 (c) - Set Static Subnet Mask Requirements Sets the subnet mask to be used by the system for Ethernet communication when using static IP settings. DHCP must be disabled for this setting to apply, otherwise a dynamic IP address will be in use. Changes to the Ethernet configuration only take effect after the Update Ethernet Settings command has been issued. ZTS Series models with firmware A2 or later. Command Syntax :ETHERNET:CONFIG:SM:[mask] Variable [mask] The subnet mask for communication on the network Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :ETHERNET:CONFIG:SM: HTTP Implementation: Set Static IP Address Get Static Subnet Mask Set Static Network Gateway Update Ethernet Settings Test Solutions - Programming Manual Page 45

46 2.7 (d) - Get Static Subnet Mask Requirements Returns the subnet mask to be used by the system for Ethernet communication when static IP settings are in use. DHCP must be disabled for this setting to apply, otherwise a dynamic IP address will be in use. ZTS Series models with firmware A2 or later. Command Syntax Return String :ETHERNET:CONFIG:SM? [mask] Variable [mask] The subnet mask for communication on the network Examples String to Send String Returned :ETHERNET:CONFIG:SM? HTTP Implementation: Get Static IP Address Set Static Subnet Mask Get Static Network Gateway Get Current Ethernet Configuration Test Solutions - Programming Manual Page 46

47 2.7 (e) - Set Static Network Gateway Requirements Sets the IP address of the network gateway to be used by the system for Ethernet communication when using static IP settings. DHCP must be disabled for this setting to apply, otherwise a dynamic IP address will be in use. Changes to the Ethernet configuration only take effect after the Update Ethernet Settings command has been issued. ZTS Series models with firmware A2 or later. Command Syntax :ETHERNET:CONFIG:NG:[gateway] Variable [gateway] IP address of the network gateway Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :ETHERNET:CONFIG:NG: HTTP Implementation: Set Static IP Address Set Static Subnet Mask Get Static Network Gateway Update Ethernet Settings Test Solutions - Programming Manual Page 47

48 2.7 (f) - Get Static Network Gateway Requirements Returns the IP address of the network gateway to be used by the system for Ethernet communication when static IP settings are in use. DHCP must be disabled for this setting to apply, otherwise a dynamic IP address will be in use. ZTS Series models with firmware A2 or later. Command Syntax Return String :ETHERNET:CONFIG:NG? [gateway] Variable [gateway] IP address of the network gateway Examples String to Send String Returned :ETHERNET:CONFIG:NG? HTTP Implementation: Get Static IP Address Get Static Subnet Mask Set Static Network Gateway Get Current Ethernet Configuration Test Solutions - Programming Manual Page 48

49 2.7 (g) - Set HTTP Port Requirements Sets the IP port to be used for HTTP communication. Changes to the Ethernet configuration only take effect after the Update Ethernet Settings command has been issued. ZTS Series models with firmware A2 or later. Command Syntax :ETHERNET:CONFIG:HTPORT:[port] Variable [port] IP port to be used for HTTP communication. The port will need to be included in all HTTP commands if any other than the default port 80 is selected. Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :ETHERNET:CONFIG:HTPORT: HTTP Implementation: Get HTTP Port Set Telnet Port Update Ethernet Settings Test Solutions - Programming Manual Page 49

50 2.7 (h) - Get HTTP Port Gets the IP port to be used for HTTP communication. Requirements ZTS Series models with firmware A2 or later. Command Syntax :ETHERNET:CONFIG:HTPORT? Return String [port] Variable [port] IP port to be used for HTTP communication Examples String to Send String Returned :ETHERNET:CONFIG:HTPORT? 8080 HTTP Implementation: Set HTTP Port Get Telnet Port Test Solutions - Programming Manual Page 50

51 2.7 (i) - Set Telnet Port Requirements Sets the IP port to be used for Telnet communication. Changes to the Ethernet configuration only take effect after the Update Ethernet Settings command has been issued. ZTS Series models with firmware A2 or later. Command Syntax :ETHERNET:CONFIG:TELNETPORT:[port] Variable [port] IP port to be used for Telnet communication. The port will need to be included when initiating a Telnet session if other than the default port 23 is selected. Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :ETHERNET:CONFIG:TELNETPORT:21 1 HTTP Implementation: Set HTTP Port Get Telnet Port Update Ethernet Settings Test Solutions - Programming Manual Page 51

52 2.7 (j) - Get Telnet Port Gets the IP port to be used for Telnet communication. Requirements ZTS Series models with firmware A2 or later. Command Syntax :ETHERNET:CONFIG:TELNETPORT? Return String [port] Variable [port] IP port to be used for Telnet communication Examples String to Send String Returned :ETHERNET:CONFIG:TELNETPORT? 1 HTTP Implementation: Get HTTP Port Set Telnet Port Test Solutions - Programming Manual Page 52

53 2.7 (k) - Set Password Requirement Requirements Sets whether or not a password is required for Ethernet communication. Changes to the Ethernet configuration only take effect after the Update Ethernet Settings command has been issued. ZTS Series models with firmware A2 or later. Command Syntax Return String Examples :ETHERNET:CONFIG:PWDENABLED:[enabled] Variable Value [enabled] 0 Password not required for Ethernet communication 1 Password required for Ethernet communication [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :ETHERNET:CONFIG:PWDENABLED:1 1 HTTP Implementation: Get Password Requirement Set Password Get Password Update Ethernet Settings Test Solutions - Programming Manual Page 53

54 2.7 (l) - Get Password Requirement Requirements Indicates whether or not a password is required for Ethernet communication. ZTS Series models with firmware A2 or later. Command Syntax Return String :ETHERNET:CONFIG:PWDENABLED? [enabled] Variable Value [enabled] 0 Password not required for Ethernet communication 1 Password required for Ethernet communication Examples String to Send String Returned :ETHERNET:CONFIG:PWDENABLED? 1 HTTP Implementation: Set Password Requirement Set Password Get Password Test Solutions - Programming Manual Page 54

55 2.7 (m) - Set Password Requirements Sets the password for Ethernet communication. The password will only be required for communication with the device when password security is enabled. Changes to the Ethernet configuration only take effect after the Update Ethernet Settings command has been issued. ZTS Series models with firmware A2 or later. Command Syntax :ETHERNET:CONFIG:PWD:[pwd] Variable [pwd] Password to set for Ethernet communication (not case sensitive) Return String Examples [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :ETHERNET:CONFIG:PWD:PASS HTTP Implementation: Set Password Requirement Get Password Requirement Get Password Update Ethernet Settings Test Solutions - Programming Manual Page 55

56 2.7 (n) - Get Password Requirements Returns the password for Ethernet communication. The password will only be required for communication with the device when password security is enabled ZTS Series models with firmware A2 or later. Command Syntax Return String :ETHERNET:CONFIG:PWD? [pwd] Variable [pwd] Password for Ethernet communication (not case sensitive) Examples String to Send :ETHERNET:CONFIG:PWD? HTTP Implementation: String Returned PASS Set Password Requirement Get Password Requirement Set Password Test Solutions - Programming Manual Page 56

57 2.7 (o) - Set DHCP Status Requirements Enables or disables DHCP (Dynamic Host Control Protocol). When enabled the system will request a valid IP address from the network's DHCP server. When disabled, the system s static IP settings will be used. Changes to the Ethernet configuration only take effect after the Update Ethernet Settings command has been issued. ZTS Series models with firmware A2 or later. Command Syntax Return String Examples :ETHERNET:CONFIG:DHCPENABLED:[enabled] Variable Value [enabled] 0 DHCP disabled (static IP settings will be used) 1 DHCP enabled (IP address will be requested from DHCP server on the network) [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :ETHERNET:CONFIG:DHCPENABLED:1 1 HTTP Implementation: Set Static IP Address Get DHCP Status Update Ethernet Settings Test Solutions - Programming Manual Page 57

58 2.7 (p) - Get DHCP Status Requirements Indicates whether or not DHCP (Dynamic Host Control Protocol) is enabled. When enabled the system will request a valid IP address from the network's DHCP server. When disabled, the system's static IP settings will be used. ZTS Series models with firmware A2 or later. Command Syntax Return String :ETHERNET:CONFIG:DHCPENABLED? [enabled] Variable Value [enabled] 0 DHCP disabled (static IP settings will be used) 1 DHCP enabled (IP address will be requested from DHCP server on the network) Examples String to Send String Returned :ETHERNET:CONFIG:DHCPENABLED? 1 HTTP Implementation: Set Static IP Address Set DHCP Status Get Current Ethernet Configuration Test Solutions - Programming Manual Page 58

59 2.7 (q) - Get MAC Address Requirements Returns the MAC (Media Access Control) address of the system (a physical hardware address). ZTS Series models with firmware A2 or later. Command Syntax Return String :ETHERNET:CONFIG:MAC? [mac] Variable [mac] MAC address of the system Examples String to Send :ETHERNET:CONFIG:MAC? HTTP Implementation: String Returned D0-73-7F-82-D Get Static IP Address Get Static Subnet Mask Get Static Network Gateway Get Current Ethernet Configuration Test Solutions - Programming Manual Page 59

60 2.7 (r) - Get Current Ethernet Configuration Requirements Returns the Ethernet configuration (IP address, subnet mask and network gateway) that is currently active for the device. If DHCP is enabled this will be the settings issued dynamically by the network's DHCP server. If DHCP is disabled this will be the user configured static IP settings. ZTS Series models with firmware A2 or later. Command Syntax Return String :ETHERNET:CONFIG:LISTEN? [ip];[mask];[gateway] Variable [ip] [mask] [gateway] Active IP address of the device Subnet mask for the network IP address of the network gateway Examples String to Send String Returned :ETHERNET:CONFIG:LISTEN? ; ; HTTP Implementation: Get Static IP Address Get Static Subnet Mask Get Static Network Gateway Update Ethernet Settings Test Solutions - Programming Manual Page 60

61 2.7 (s) - Update Ethernet Settings Requirements Resets the Ethernet controller so that any recently applied changes to the Ethernet configuration can be loaded. Any subsequent commands / queries to the system will need to be issued using the new Ethernet configuration. Note: If a connection cannot be established after the INIT command has been issued it may indicate an invalid configuration was created (for example a static IP address which clashes with another device on the network). The Ethernet settings can always be overwritten by connecting to the system using the USB connection. ZTS Series models with firmware A2 or later. Command Syntax Return String Examples :ETHERNET:CONFIG:INIT [status] Variable Value [status] 0 Command failed 1 Command completed successfully String to Send String Returned :ETHERNET:CONFIG:INIT 1 HTTP Implementation: Get Current Ethernet Configuration Test Solutions - Programming Manual Page 61

62 3 - Ethernet Control over IP Networks Mini-Circuits ZTS Series solid-state switch systems have an RJ45 connector option for remote control over Ethernet TCP/IP networks. HTTP (Get/Post commands) and Telnet communication are supported. UDP transmission is also supported for discovering available systems on the network. The system can be configured manually with a static IP address or automatically by the network using DHCP (Dynamic Host Control Protocol): Dynamic IP (factory default setting) o Subnet Mask, Network Gateway and local IP Address are assigned by the network server on each connection o The only user controllable parameters are: TCP/IP Port (the port used for HTTP communication with the network; default is port 80) Password (up to 20 characters; default is no password) Static IP o All parameters must be specified by the user: IP Address (must be a legal and unique address on the local network) Subnet Mask (subnet mask of the local network) Network gateway (the IP address of the network gateway/router) TCP/IP port (the port used for HTTP communication with the network; default is port 80) Password (up to 20 characters; default is no password) Notes: 1. The TCP/IP port must be included in every HTTP command to the system unless the default port 80 is used 2. Port 23 is reserved for Telnet communication Test Solutions - Programming Manual Page 62

63 3.1 - Ethernet Communication Communication over Ethernet can be accomplished using HTTP Get/Post commands or Telnet communication to send the SCPI commands outlined in SCPI Commands for Control of ZTS Series Switch Systems. These communication protocols are both commonly supported and simple to implement in most programming languages. Any Internet browser can be used as a console/tester for HTTP control by typing the commands/queries directly into the address bar. 3.1 (a) - Sending SCPI Commands / Queries Using HTTP The basic format of the HTTP command to send to the system is: Example 1: Example 2: Where is required ADDRESS = IP address (required) PORT = TCP/IP port (can be omitted if port 80 is used) PWD = Password (can be omitted if password security is not enabled) COMMAND = Command to send to the switch Explanation: The system has IP address and uses port 800 Password security is enabled and set to Explanation: The system has IP address and uses the default port 80 Password security is disabled The system will return the result of the command/query as a string of ASCII characters. Test Solutions - Programming Manual Page 63

64 3.1 (b) - Sending SCPI Commands / Queries Using Telnet Communication is started by creating a Telnet connection to the system s IP address. On successful connection the line feed character will be returned. If the system has a password enabled then this must be sent as the first command after connection. The full list of all commands and queries is detailed in the previous sections. A basic example of the Telnet communication structure using the Windows Telnet Client is summarized below: 1) Set up Telnet connection to a system with IP address : 2) The line feed character is returned indicating the connection was successful: 3) The password (if enabled) must be sent as the first command in the format PWD=x;. A return value of 1 - Success indicates success: 4) Any number of commands and queries can be sent as needed: Test Solutions - Programming Manual Page 64

65 3.2 - Device Discovery Using UDP UDP Ports In addition to HTTP and Telnet, Mini-Circuits' ZTS Series systems also provide limited support of the UDP protocol for the purpose of device discovery. This allows a user to request the IP address and configuration of all Mini-Circuits ZTS Series systems connected on the network; full control of those units is then accomplished using HTTP or Telnet, as detailed previously. Note: UDP is a simple transmission protocol that provides no method for error correction or guarantee of receipt. Mini-Circuits ZTS Series systems are configured to listen on UDP port 4950 and answer on UDP port Communication on these ports must be allowed through the computer s firewall in order to use UDP for device discovery. If the test system s IP address is already known it is not necessary to use UDP. Transmission Receipt The command MCL_MULTI_SWITCH_CONTROLLER? should be broadcast to the local network using UDP protocol on port All systems that receive the request will respond with the following information (each field separated by CrLf) on port 4951: Model Name Serial Number IP Address/Port Subnet Mask Network Gateway MAC Address Test Solutions - Programming Manual Page 65

66 Example Sent Data: Received Data: MCL_MULTI_SWITCH_CONTROLLER? Model Name: ZTS-8SP8T-63 Serial Number: IP Address= Port: 80 Subnet Mask= Network Gateway= Mac Address=D0-73-7F-82-D8-01 Model Name: ZTS-6SP8T-63 Serial Number: IP Address= Port: 80 Subnet Mask= Network Gateway= Mac Address=D0-73-7F-82-D8-02 Model Name: ZTS-8SP8T-63 Serial Number: IP Address= Port: 80 Subnet Mask= Network Gateway= Mac Address=D0-73-7F-82-D8-03 Test Solutions - Programming Manual Page 66

67 4 - USB Control in a Windows Environment The DLL (Dynamic Link Library) Concept The Dynamic Link Library concept is Microsoft's implementation of the shared library concept in the Windows environment. DLLs provide a mechanism for shared code and data, intended to allow a developer to distribute applications without requiring code to be re-linked or recompiled. Mini-Circuits' software package provides DLL objects designed to allow your own application to interface with the functions of the ZTS Series switch system. User s Software Application (3rd party software such as LabVIEW, Delphi, Visual C++, Visual C#, Visual Basic, and Microsoft.Net) DLL (Dynamic Link Libraries) Mini-Circuits USB Portable Test Equipment Fig 4.1-a: DLL Interface Concept The software package provides two DLL files, the choice of which file to use is dictated by the user s operating system: 1. ActiveX com object Designed to be used in any programming environment that supports third party ActiveX COM (Component Object Model) compliant applications. The ActiveX file should be registered using RegSvr32 (see following sections for details). 2. Microsoft.NET Class Library A logical unit of functionality that runs under the control of the Microsoft.NET system. Test Solutions - Programming Manual Page 67

68 4.1 (a) - ActiveX COM Object ActiveX COM object DLL files are designed to be used with both 32-bit and 64-bit Windows operating systems. A 32-bit programming environment that is compatible with ActiveX is required. To develop 64-bit applications, the Microsoft.NET Class library should be used instead. Supported Programming Environments Installation Mini-Circuits ZTS Series have been tested in the following programming environments. This is not an exhaustive list and the DLL file is designed to operate in most environments that support ActiveX functionality. Please contact Mini-Circuits for support. Visual Studio 6 (Visual C++ and Visual Basic) LabVIEW 8.0 or newer MATLAB 7 or newer Delphi Borland C++ Agilent VEE Python 1. Copy the DLL file to the correct directory: For 32-bit Windows operating systems this is C:\WINDOWS\System32 For 64-bit Windows operating systems this is C:\WINDOWS\SysWOW64 2. Open the Command Prompt: a. For Windows XP (see Fig 4.1-b): i. Select All Programs and then Accessories from the Start Menu ii. Click on Command Prompt to open b. For later versions of the Windows operating system you will need to have Administrator privileges in order to run the Command Prompt in Elevated mode (see Fig 4.1-c): i. Open the Start Menu/Start Screen and type Command Prompt ii. Right-click on the shortcut for the Command Prompt iii. Select Run as Administrator iv. You may be prompted to enter the log in details for an Administrator account if the current user does not have Administrator privileges on the local PC 3. Use regsvr32 to register the DLL: For 32-bit Windows operating systems type (see Fig 4.1-d): \WINDOWS\System32\Regsvr32 \WINDOWS\System32\mcl_MultiSwitchController.dll For 64-bit Windows operating systems type (see Fig 4.1-e): \WINDOWS\SysWOW64\Regsvr32 \WINDOWS\SysWOW64\mcl_MultiSwitchController.dll 4. Hit enter to confirm and a message box will appear to advise of successful registration. Test Solutions - Programming Manual Page 68

69 Fig 4.1-b: Opening the Command Prompt in Windows XP Fig 4.1-c: Opening the Command Prompt in Windows 7 (left), Windows 8 (middle) and Windows 10 (right) Fig 4.1-d: Registering the DLL in a 32-bit environment Fig 4.1-e: Registering the DLL in a 64-bit environment Test Solutions - Programming Manual Page 69