Differences

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

--- slice:dhv:api [2020/05/20 19:34] – [Set Response to Trigger In: TRIGIN] Michael Radunsky
+++ slice:dhv:api [2021/12/15 20:57] – external edit 127.0.0.1
@@ Line 23: / Line 23: @@
 ^ Stop Bits     |  1     |
 ^ Flow Control  |  None  |
 To perform an operation, an ASCII-based text message is first constructed from a command and its arguments, and then the message is transmitted to the SLICE instrument through the COM port. The following rules apply:
@@ Line 35: / Line 34: @@
   - [Float] refers to a floating point argument that has a decimal point in its value.
- <WRAP 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 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>
@@ Line 72: / Line 71: @@
 ==== SCPI device information: *IDN? ====
-<WRAP center round important 100%>Replace [asterix] with a *</WRAP>
+<WRAP center round important 100%>Replace [asterisk] with a *</WRAP>
-<function=ICEfunc|0=[asterix]IDN?&1=:None;&2=Vescent Photonics, [serial#], S-V1.74, DHV-V1.18&-1>
+<function=ICEfunc|0=[asterisk]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.
 ----
@@ Line 165: / Line 164: @@
 ==== Query Output Voltage: OUTVOLT? ====
-<function=ICEfunc|0=OUTVOLT?&1=I:CHANNEL:2&2=123.45689&-1>
+<function=ICEfunc|0=OUTVOLT?&1=I:CHANNEL:2&2=123.456789&-1>
 Returns V<sub>out</sub> for CHANNEL.
@@ Line 363: / Line 362: @@
   * In the example, CHANNEL 1 will henceforth respond to Trigger In.
-  * To query Error Code, use [[slice:dhv:api#Query_Response_to_Trigger_In:_TRIGIN?|TRIGIN?]] command.
+  * To query response to trigger input, use [[slice:dhv:api#Query_Response_to_Trigger_In:_TRIGIN?|TRIGIN?]] command.
+----
+==== Query Trigger Out Meaning: TRIGOUT? ====
+<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?>.
+<WRAP center round box 60%><tabcaption trigout?|Possible return values & meaning for TTL high at the Trigger Out>
+^  Response  ^  Meaning  ^
+| 0 |  No change in state of the Trigger Out based state of CHANNEL  |
+| 1 |  The signal at Trigger Out will go high in sync with the ramp on CHANNEL  |
+</tabcaption></WRAP>
+  * In the example, the signal at Trigger Out will go high in sync with the ramp on CH 1.
+  * To set the meaning of the Trigger Out signal, use [[slice:dhv:api#Set_Trigger_Out:_TRIGOUT|TRIGOUT]]
+----
+==== Set Trigger Out: TRIGOUT ====
+<function=ICEfunc|0=TRIGOUT&1=I:CHANNEL:1;I:Selection:1&2=1&-1>
+Returns TRIGOUT? for CHANNEL.
+<WRAP center round box 60%><tabcaption trigout|>
+^  Selection  ^  Meaning of Trigger Out with respect to CHANNEL  ^
+| 0 |  Trigger out is unresponsive to state of CHANNEL  |
+| 1 |  A TTL high signal at Trigger Out will be in sync with ramp of CHANNEL  |
+</tabcaption></WRAP>
+  * In the example, Trigger Out will go high in sync with ramp on CH 1
+  * To query Trigger Out meaning, use [[slice:dhv:api#Query_Trigger_Out_Meaning:_TRIGOUT?|TRIGOUT?]] command
+  * Setting the Trigger Out to be in sync with CH 1 removes Trigger Out's synchronicity with CH 2 & vice versa
+----
+==== Query Source of Modulation Signal for CH 1: MODEA? ====
+<function=ICEfunc|0=MODEA?&1&2=257&-1>
+Returns from where CH 1 receives modulation control as seen in <tabref modea?>.
+<WRAP center round box 60%><tabcaption modea?|Possible return values & meaning MODEA? command>
+^  Response  ^  Meaning  ^
+| 0 |  CH 1 accepts its modulation signal from rear-panel SMA connector  |
+| 257 |  CH 1 accepts its modulation signal from front-panel Input A BNC connector  |
+</tabcaption></WRAP>
+  * In the example, CH 1 accepts its modulation signal from the front-panel Input A.
+  * To set from where CH 1 accepts a modulation signal, use [[slice:dhv:api#Set_Source_of_Modulation_Signal_for_CH_1:_MODEA|MODEA]]
+  * Only one modulation source may be active at a time
+----
+==== Set Source of Modulation Signal for CH 1: MODEA ====
+<function=ICEfunc|0=MODEA&1=I:MODE:1:1&2=257&-1>
+Returns MODEA?
+<WRAP center round box 60%><tabcaption modea|>
+^  Mode  ^  Location of modulation input for CH 1  ^
+| 0 |  CH 1 accepts modulation signal from rear-panel SMA connector  |
+| 1 |  CH 1 accepts modulation signal from front-panel Input A BNC connector  |
+</tabcaption></WRAP>
+  * In the example, CH 1 will accept a modulation signal from the front-panel Input A BNC
+  * To query the modulation source for CH 1, use [[slice:dhv:api#Query_Source_of_Modulation_Signal_for_CH_1:_MODEA?|MODEA?]] command
+----
+==== Query Source of Modulation Signal for CH 2: MODEB? ====
+<function=ICEfunc|0=MODEB?&1&2=513&-1>
+Returns from where CH 2 receives modulation control as seen in <tabref modeb?>.
+<WRAP center round box 60%><tabcaption modeb?|Possible return values & meaning MODEB? command>
+^  Response  ^  Meaning  ^
+| 0 |  CH 2 accepts its modulation signal from rear-panel SMA connector  |
+| 513 |  CH 2 accepts its modulation signal from front-panel Input B BNC connector  |
+</tabcaption></WRAP>
+  * In the example, CH 2 accepts its modulation signal from the front-panel Input B.
+  * To set from where CH B accepts a modulation signal, use [[slice:dhv:api#Set_Source_of_Modulation_Signal_for_CH_2:_MODEB|MODEB]]
+  * Only one modulation source may be active at a time
+----
+==== Set Source of Modulation Signal for CH 2: MODEB ====
+<function=ICEfunc|0=MODEB&1=I:MODE:1:1&2=513&-1>
+Returns MODEB?
+<WRAP center round box 60%><tabcaption modeb|>
+^  Mode  ^  Location of modulation input for CH 2  ^
+| 0 |  CH 2 accepts modulation signal from rear-panel SMA connector  |
+| 1 |  CH 2 accepts modulation signal from front-panel Input B BNC connector  |
+</tabcaption></WRAP>
+  * In the example, CH 2 will henceforth accept a modulation signal from the front-panel Input B BNC
+  * To query the modulation source for CH 2, use [[slice:dhv:api#Query_Source_of_Modulation_Signal_for_CH_2:_MODEB?|MODEB?]] command
+----
+==== Query Signal Delivered to Front-Panel Output 1: MODE1? ====
+<function=ICEfunc|0=MODE1?&1&2=257&-1>
+Returns identity of signal delivered to front-panel Output 1 according to <tabref mode1?>.
+<WRAP center round box 60%><tabcaption mode1?|Possible return values & meaning MODE1? command>
+^  Response  ^  Meaning  ^
+| 0 |  Front-panel Output 1 has no signal  |
+| 257 |  Front-panel Output 1 monitors CH 1 HV output  |
+</tabcaption></WRAP>
+  * In the example, front-panel output 1 is monitoring CH 1 output
+  * V<sub>1</sub> = V<sub>CH 1</sub> ÷ 20
+  * To set what signal is delivered to front-panel Output 1, use [[slice:dhv:api#Set Signal Delivered to Front-Panel Output 1: MODE1|MODE1]]
+----
+==== Set Signal Delivered to Front-Panel Output 1: MODE1 ====
+<function=ICEfunc|0=MODE1&1=I:Mode:1:1&2=257&-1>
+Returns MODE1?
+<WRAP center round box 60%><tabcaption mode1|>
+^  Mode  ^  Result  ^
+| 0 |  Sets signal at front-panel Output 1 to no signal  |
+| 1 |  Sets signal at front-panel Output 1 to monitor CH 1 Output  |
+</tabcaption></WRAP>
+  * In the example, front-panel Output 1 will henceforth monitor the CH 1 output
+  * V<sub>out</sub> = V<sub>CH 1</sub> ÷ 20
+  * To query the signal delivered to the front-panel Output 1, use [[slice:dhv:api#Query Signal Delivered to Front-Panel Output 1: MODE1?|MODE1?]] command
+----
+==== Query Signal Delivered to Front-Panel Output 2: MODE2? ====
+<function=ICEfunc|0=MODE2?&1&2=513&-1>
+Returns identity of signal delivered to front-panel Output 2 according to <tabref mode2?>.
+<WRAP center round box 60%><tabcaption mode2?|Possible return values & meaning MODE2? command>
+^  Response  ^  Meaning  ^
+| 0 |  Front-panel Output 2 has no signal  |
+| 513 |  Front-panel Output 2 monitors CH 2 HV output  |
+</tabcaption></WRAP>
+  * In the example, front-panel Output 2 is monitoring CH 2 output
+  * V<sub>2</sub> = V<sub>CH 2</sub> ÷ 20
+  * To set what signal is delivered to front-panel Output 2, use [[slice:dhv:api#Set Signal Delivered to Front-Panel Output 2: MODE2|MODE2]]
+----
+==== Set Signal Delivered to Front-Panel Output 2: MODE2 ====
+<function=ICEfunc|0=MODE2&1=I:Mode:1:1&2=513&-1>
+Returns MODE2?
+<WRAP center round box 60%><tabcaption mode2|>
+^  Mode  ^  Result  ^
+| 0 |  Sets signal at front-panel Output 2 to no signal  |
+| 1 |  Sets signal at front-panel Output 2 to monitor CH 2 Output  |
+</tabcaption></WRAP>
+  * In the example, front-panel Output 2 will henceforth monitor the CH 2 output
+  * V<sub>out</sub> = V<sub>CH 2</sub> ÷ 20
+  * To query the signal delivered to the front-panel Output 2, use [[slice:dhv:api#Query Signal Delivered to Front-Panel Output 2: MODE2?|MODE2?]] command
 ----