Product Manuals

User Tools

Site Tools

You are here: manuals » slice » dhv » api
slice:dhv:api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
slice:dhv:api [2021/12/15 20:57] – external edit 127.0.0.1slice:dhv:api [2023/12/06 20:39] (current) – Christiana Sasser
Line 34: Line 34:
   - [Float] refers to a floating point argument that has a decimal point in its value.   - [Float] refers to a floating point argument that has a decimal point in its value.
  
- <WRAP round important 100%>Changes effected by issuing a serial command from this API are not permanently stored in non-volatile memory until you issue a SAVE command. Configuration changes without the SAVE command will be lost with power cycling. The Save command stores the entire configuration and so several configuration changes can be implemented and then a single SAVE command could be issued.+ <WRAP round important>Changes effected by issuing a serial command from this API are not permanently stored in non-volatile memory until you issue a SAVE command. Configuration changes without the SAVE command will be lost with power cycling. The Save command stores the entire configuration and so several configuration changes can be implemented and then a single SAVE command could be issued.
  
 </WRAP> </WRAP>
Line 47: Line 47:
 ---- ----
 ==== Obtain System Controller firmware version: #VERSION  ==== ==== Obtain System Controller firmware version: #VERSION  ====
-<function=ICEfunc|0=#VERSION&1=:None;&2=1.62&-1>+<function=ICEfunc?0=#VERSION？&1=:None;&2=1.62&-1>
 Returns firmware version of System Controller. Returns firmware version of System Controller.
 +/*Note: For the Return Question mark, we had to use a slightly different question mark image. This one: ？. Rather than this one: ?. */
 ---- ----
 ==== Reset System to Factory default: _FACTORY ==== ==== Reset System to Factory default: _FACTORY ====
-<function=ICEfunc|0=_FACTORY&1=I:SLOT_NUMBER:1;&2=&-1>+<function=ICEfunc?0=_FACTORY&1=I:SLOT_NUMBER:1;&2=&-1>
 Restores "Personality Board" to factory default settings. No return value.  \\ Restores "Personality Board" to factory default settings. No return value.  \\
 <WRAP center round box 60%> <WRAP center round box 60%>
Line 58: Line 59:
 ---- ----
 ==== Save current configuration in non-volatile memory: SAVE ==== ==== Save current configuration in non-volatile memory: SAVE ====
-<function=ICEfunc|0=SAVE&1=:None;&2=SUCCESS&-1>+<function=ICEfunc?0=SAVE&1=:None;&2=SUCCESS&-1>
 Saves "Personality Board" settings into EEPROM.  Unsaved changes will be lost if board is powered off without issuing a SAVE command. The SAVE command saves the entire configuration into non-volatile memory. A single SAVE command can be issued after any number of configuration changes. When changes are made to the SLICE configuration through the touch screen, the new values are automatically saved and it is not necessary to issue a SAVE command.\\ \\ Saves "Personality Board" settings into EEPROM.  Unsaved changes will be lost if board is powered off without issuing a SAVE command. The SAVE command saves the entire configuration into non-volatile memory. A single SAVE command can be issued after any number of configuration changes. When changes are made to the SLICE configuration through the touch screen, the new values are automatically saved and it is not necessary to issue a SAVE command.\\ \\
 __Slot Number__\\ __Slot Number__\\
Line 72: Line 73:
  
 <WRAP center round important 100%>Replace [asterisk] with a *</WRAP> <WRAP center round important 100%>Replace [asterisk] with a *</WRAP>
-<function=ICEfunc|0=[asterisk]IDN?&1=:None;&2=Vescent Photonics, [serial#], S-V1.74, DHV-V1.18&-1>+<function=ICEfunc?0=*IDN？?&1=:None;&2=Vescent Photonics, [serial#], S-V1.74, DHV-V1.18&-1>
 Returns SCPI device information. Running System Controller firmware version 1.74 and DHV firmware version 1.18. Returns SCPI device information. Running System Controller firmware version 1.74 and DHV firmware version 1.18.
 ---- ----
Line 85: Line 86:
 ==== Query Output Voltage Maximum: VLIM? ==== ==== Query Output Voltage Maximum: VLIM? ====
  
-<function=ICEfunc|0=VLIM?&1=I:CHANNEL:2&2=123.45&-1>+<function=ICEfunc?0=VLIM？?&1=I:CHANNEL:2&2=123.45&-1>
 Returns maximum output in Volts for CHANNEL. Returns maximum output in Volts for CHANNEL.
  
Line 95: Line 96:
 ==== Set Output Voltage Maximum: VLIM ==== ==== Set Output Voltage Maximum: VLIM ====
  
-<function=ICEfunc|0=VLIM&1=I:CHANNEL:2;F:Vmax:123.45&2=123.45&-1>+<function=ICEfunc?0=VLIM&1=I:CHANNEL:2;F:Vmax:123.45&2=123.45&-1>
 Sets the maximum output in Volts for CHANNEL. Sets the maximum output in Volts for CHANNEL.
  
Line 106: Line 107:
 ==== Query Operation Mode: CONTROL? ==== ==== Query Operation Mode: CONTROL? ====
  
-<function=ICEfunc|0=CONTROL?&1=I:CHANNEL:1;&2=0&-1>+<function=ICEfunc?0=CONTROL？?&1=I:CHANNEL:1;&2=0&-1>
 Returns the enumerated modulation mode and status for CHANNEL. Returns the enumerated modulation mode and status for CHANNEL.
 Where: \\ Where: \\
Line 122: Line 123:
 ==== Set Operation Mode: CONTROL ==== ==== Set Operation Mode: CONTROL ====
  
-<function=ICEfunc|0=CONTROL&1=I:CHANNEL:2;I:MODE:2&2=2&-1>+<function=ICEfunc?0=CONTROL&1=I:CHANNEL:2;I:MODE:2&2=2&-1>
 Sets the enumerated modulation mode and status for CHANNEL. Sets the enumerated modulation mode and status for CHANNEL.
 Where: \\ Where: \\
Line 141: Line 142:
 ==== Query DC Bias: DCBIASV? ==== ==== Query DC Bias: DCBIASV? ====
  
-<function=ICEfunc|0=DCBIASV?&1=I:CHANNEL:2&2=123.456&-1>+<function=ICEfunc?0=DCBIASV？?&1=I:CHANNEL:2&2=123.456&-1>
 Returns V<sub>bias</sub> in Volts for CHANNEL. Returns V<sub>bias</sub> in Volts for CHANNEL.
  
Line 152: Line 153:
 ==== Set DC Bias: DCBIASV ==== ==== Set DC Bias: DCBIASV ====
  
-<function=ICEfunc|0=DCBIASV&1=I:CHANNEL:2;F:VOLTAGE:123.45&2=123.45&-1>+<function=ICEfunc?0=DCBIASV&1=I:CHANNEL:2;F:VOLTAGE:123.45&2=123.45&-1>
 Returns [[slice:dhv:api#query_DC_Bias:_DCBIASV?|DCBIASV?]] \\ Returns [[slice:dhv:api#query_DC_Bias:_DCBIASV?|DCBIASV?]] \\
  
Line 164: Line 165:
 ==== Query Output Voltage: OUTVOLT? ==== ==== Query Output Voltage: OUTVOLT? ====
  
-<function=ICEfunc|0=OUTVOLT?&1=I:CHANNEL:2&2=123.456789&-1>+<function=ICEfunc?0=OUTVOLT？?&1=I:CHANNEL:2&2=123.456789&-1>
 Returns V<sub>out</sub> for CHANNEL. Returns V<sub>out</sub> for CHANNEL.
  
Line 174: Line 175:
 ==== Query Range of Voltage Sweep: RANGEV? ==== ==== Query Range of Voltage Sweep: RANGEV? ====
  
-<function=ICEfunc|0=RANGEV?&1=I:CHANNEL:2&2=12.34&-1>+<function=ICEfunc?0=RANGEV？?&1=I:CHANNEL:2&2=12.34&-1>
 Returns Range of the Sweep in Volts for CHANNEL. Returns Range of the Sweep in Volts for CHANNEL.
  
Line 186: Line 187:
 ==== Set Range of Voltage Sweep: RANGEV ==== ==== Set Range of Voltage Sweep: RANGEV ====
  
-<function=ICEfunc|0=RANGEV&1=I:CHANNEL:1;F:Range:12.34&2=12.34&-1>+<function=ICEfunc?0=RANGEV&1=I:CHANNEL:1;F:Range:12.34&2=12.34&-1>
 Sets Range of the Sweep in Volts for CHANNEL. Sets Range of the Sweep in Volts for CHANNEL.
  
Line 198: Line 199:
 ==== Query Repetition Rate of Voltage Sweep: SWEEPRT? ==== ==== Query Repetition Rate of Voltage Sweep: SWEEPRT? ====
  
-<function=ICEfunc|0=SWEEPRT?&1=I:CHANNEL:2&2=12.34&-1>+<function=ICEfunc?0=SWEEPRT？?&1=I:CHANNEL:2&2=12.34&-1>
 Returns Repetition Rate of the Sweep in Hertz for CHANNEL. Returns Repetition Rate of the Sweep in Hertz for CHANNEL.
  
Line 208: Line 209:
 ==== Set Repetition Rate of Voltage Sweep: SWEEPRT ==== ==== Set Repetition Rate of Voltage Sweep: SWEEPRT ====
  
-<function=ICEfunc|0=SWEEPRT&1=I:CHANNEL:1;F:Rep_Rate:12.34&2=12.34&-1>+<function=ICEfunc?0=SWEEPRT&1=I:CHANNEL:1;F:Rep_Rate:12.34&2=12.34&-1>
 Sets CHANNEL Sweep Repetition Rate to Rep_Rate (in Hertz). Sets CHANNEL Sweep Repetition Rate to Rep_Rate (in Hertz).
  
Line 219: Line 220:
 ==== Query Sweep Mode: SWEEPMD? ==== ==== Query Sweep Mode: SWEEPMD? ====
  
-<function=ICEfunc|0=SWEEPMD?&1=I:CHANNEL:1&2=2&-1>+<function=ICEfunc?0=SWEEPMD？?&1=I:CHANNEL:1&2=2&-1>
 Returns the enumerated Current Sweep Mode for CHANNEL. Returns the enumerated Current Sweep Mode for CHANNEL.
  
Line 235: Line 236:
 ==== Set Sweep Mode: SWEEPMD ==== ==== Set Sweep Mode: SWEEPMD ====
  
-<function=ICEfunc|0=SWEEPMD&1=I:CHANNEL:1;I:Mode:0&2=0&-1>+<function=ICEfunc?0=SWEEPMD&1=I:CHANNEL:1;I:Mode:0&2=0&-1>
 Returns SWEEPMD? for CHANNEL. Returns SWEEPMD? for CHANNEL.
  
Line 251: Line 252:
 ==== Query Repetition Rate of Voltage Sweep: SWEEPRT? ==== ==== Query Repetition Rate of Voltage Sweep: SWEEPRT? ====
  
-<function=ICEfunc|0=SWEEPRT?&1=I:CHANNEL:2&2=12.34&-1>+<function=ICEfunc?0=SWEEPRT？?&1=I:CHANNEL:2&2=12.34&-1>
 Returns Repetition Rate of the Sweep in Hertz for CHANNEL. Returns Repetition Rate of the Sweep in Hertz for CHANNEL.
  
Line 261: Line 262:
 ==== Set Repetition Rate of Voltage Sweep: SWEEPRT ==== ==== Set Repetition Rate of Voltage Sweep: SWEEPRT ====
  
-<function=ICEfunc|0=SWEEPRT&1=I:CHANNEL:1;F:Rep_Rate:12.34&2=12.34&-1>+<function=ICEfunc?0=SWEEPRT&1=I:CHANNEL:1;F:Rep_Rate:12.34&2=12.34&-1>
 Sets CHANNEL Sweep Repetition Rate to Rep_Rate (in Hertz). Sets CHANNEL Sweep Repetition Rate to Rep_Rate (in Hertz).
  
Line 272: Line 273:
 ==== Query Sweep Mode: SWEEPMD? ==== ==== Query Sweep Mode: SWEEPMD? ====
  
-<function=ICEfunc|0=SWEEPMD?&1=I:CHANNEL:1&2=2&-1>+<function=ICEfunc?0=SWEEPMD？?&1=I:CHANNEL:1&2=2&-1>
 Returns the enumerated Current Sweep Mode for CHANNEL. Returns the enumerated Current Sweep Mode for CHANNEL.
  
Line 288: Line 289:
 ==== Set Sweep Mode: SWEEPMD ==== ==== Set Sweep Mode: SWEEPMD ====
  
-<function=ICEfunc|0=SWEEPMD&1=I:CHANNEL:1;I:Mode:0&2=0&-1>+<function=ICEfunc?0=SWEEPMD&1=I:CHANNEL:1;I:Mode:0&2=0&-1>
 Returns SWEEPMD? for CHANNEL. Returns SWEEPMD? for CHANNEL.
  
Line 304: Line 305:
 ==== Query Error Code: ERROR? ==== ==== Query Error Code: ERROR? ====
  
-<function=ICEfunc|0=ERROR?&1=I:CHANNEL:1&2=49152&-1>+<function=ICEfunc?0=ERROR？?&1=I:CHANNEL:1&2=49152&-1>
 Returns the Error Code for CHANNEL. Returns the Error Code for CHANNEL.
  
Line 320: Line 321:
 ==== Clear Error Code: Error ==== ==== Clear Error Code: Error ====
  
-<function=ICEfunc|0=ERROR&1=I:CHANNEL:1;I:Code:49152&2=49152&-1>+<function=ICEfunc?0=ERROR&1=I:CHANNEL:1;I:Code:49152&2=49152&-1>
 Returns ERROR? for CHANNEL. Returns ERROR? for CHANNEL.
  
Line 336: Line 337:
 ==== Query Response to Trigger In: TRIGIN? ==== ==== Query Response to Trigger In: TRIGIN? ====
  
-<function=ICEfunc|0=TRIGIN?&1=I:CHANNEL:1&2=1&-1>+<function=ICEfunc?0=TRIGIN？?&1=I:CHANNEL:1&2=1&-1>
 Returns the effect of Trigger In signal on CHANNEL as seen in <tabref trigin?>. Returns the effect of Trigger In signal on CHANNEL as seen in <tabref trigin?>.
  
Line 352: Line 353:
 ==== Set Response to Trigger In: TRIGIN ==== ==== Set Response to Trigger In: TRIGIN ====
  
-<function=ICEfunc|0=TRIGIN&1=I:CHANNEL:1;I:Selection:1&2=1&-1>+<function=ICEfunc?0=TRIGIN&1=I:CHANNEL:1;I:Selection:1&2=1&-1>
 Returns TRIGIN? for CHANNEL. Returns TRIGIN? for CHANNEL.
  
Line 368: Line 369:
 ==== Query Trigger Out Meaning: TRIGOUT? ==== ==== Query Trigger Out Meaning: TRIGOUT? ====
  
-<function=ICEfunc|0=TRIGOUT?&1=I:CHANNEL:1&2=1&-1>+<function=ICEfunc?0=TRIGOUT？?&1=I:CHANNEL:1&2=1&-1>
 Returns the meaning of the Trigger Out signal with respect to CHANNEL as seen in <tabref trigout?>. Returns the meaning of the Trigger Out signal with respect to CHANNEL as seen in <tabref trigout?>.
  
Line 384: Line 385:
 ==== Set Trigger Out: TRIGOUT ==== ==== Set Trigger Out: TRIGOUT ====
  
-<function=ICEfunc|0=TRIGOUT&1=I:CHANNEL:1;I:Selection:1&2=1&-1>+<function=ICEfunc?0=TRIGOUT&1=I:CHANNEL:1;I:Selection:1&2=1&-1>
 Returns TRIGOUT? for CHANNEL. Returns TRIGOUT? for CHANNEL.
  
Line 401: Line 402:
 ==== Query Source of Modulation Signal for CH 1: MODEA? ==== ==== Query Source of Modulation Signal for CH 1: MODEA? ====
  
-<function=ICEfunc|0=MODEA?&1&2=257&-1>+<function=ICEfunc?0=MODEA？?&1&2=257&-1>
 Returns from where CH 1 receives modulation control as seen in <tabref modea?>. Returns from where CH 1 receives modulation control as seen in <tabref modea?>.
  
Line 418: Line 419:
 ==== Set Source of Modulation Signal for CH 1: MODEA ==== ==== Set Source of Modulation Signal for CH 1: MODEA ====
  
-<function=ICEfunc|0=MODEA&1=I:MODE:1:1&2=257&-1>+<function=ICEfunc?0=MODEA&1=I:MODE:1:1&2=257&-1>
 Returns MODEA? Returns MODEA?
  
Line 434: Line 435:
 ==== Query Source of Modulation Signal for CH 2: MODEB? ==== ==== Query Source of Modulation Signal for CH 2: MODEB? ====
  
-<function=ICEfunc|0=MODEB?&1&2=513&-1>+<function=ICEfunc?0=MODEB？?&1&2=513&-1>
 Returns from where CH 2 receives modulation control as seen in <tabref modeb?>. Returns from where CH 2 receives modulation control as seen in <tabref modeb?>.
  
Line 451: Line 452:
 ==== Set Source of Modulation Signal for CH 2: MODEB ==== ==== Set Source of Modulation Signal for CH 2: MODEB ====
  
-<function=ICEfunc|0=MODEB&1=I:MODE:1:1&2=513&-1>+<function=ICEfunc?0=MODEB&1=I:MODE:1:1&2=513&-1>
 Returns MODEB? Returns MODEB?
  
Line 467: Line 468:
 ==== Query Signal Delivered to Front-Panel Output 1: MODE1? ==== ==== Query Signal Delivered to Front-Panel Output 1: MODE1? ====
  
-<function=ICEfunc|0=MODE1?&1&2=257&-1>+<function=ICEfunc?0=MODE1？?&1&2=257&-1>
 Returns identity of signal delivered to front-panel Output 1 according to <tabref mode1?>. Returns identity of signal delivered to front-panel Output 1 according to <tabref mode1?>.
  
Line 484: Line 485:
 ==== Set Signal Delivered to Front-Panel Output 1: MODE1 ==== ==== Set Signal Delivered to Front-Panel Output 1: MODE1 ====
  
-<function=ICEfunc|0=MODE1&1=I:Mode:1:1&2=257&-1>+<function=ICEfunc?0=MODE1&1=I:Mode:1:1&2=257&-1>
 Returns MODE1? Returns MODE1?
  
Line 501: Line 502:
 ==== Query Signal Delivered to Front-Panel Output 2: MODE2? ==== ==== Query Signal Delivered to Front-Panel Output 2: MODE2? ====
  
-<function=ICEfunc|0=MODE2?&1&2=513&-1>+<function=ICEfunc?0=MODE2？?&1&2=513&-1>
 Returns identity of signal delivered to front-panel Output 2 according to <tabref mode2?>. Returns identity of signal delivered to front-panel Output 2 according to <tabref mode2?>.
  
Line 518: Line 519:
 ==== Set Signal Delivered to Front-Panel Output 2: MODE2 ==== ==== Set Signal Delivered to Front-Panel Output 2: MODE2 ====
  
-<function=ICEfunc|0=MODE2&1=I:Mode:1:1&2=513&-1>+<function=ICEfunc?0=MODE2&1=I:Mode:1:1&2=513&-1>
 Returns MODE2? Returns MODE2?
  
slice/dhv/api.txt · Last modified: 2023/12/06 20:39 by Christiana Sasser