slice:dcc:api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| slice:dcc:api [2019/12/11 02:59] – [SLICE-DCC-specific Commands] Michael Radunsky | slice:dcc:api [2023/12/06 20:35] (current) – Christiana Sasser | ||
|---|---|---|---|
| Line 45: | Line 45: | ||
| The following commands are operational on all SLICE products. | The following commands are operational on all SLICE products. | ||
| ---- | ---- | ||
| - | < | + | ====Firmware Version==== |
| + | < | ||
| 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 to Factory Default Settings==== |
| + | < | ||
| Restores " | Restores " | ||
| <WRAP center round box 60%> | <WRAP center round box 60%> | ||
| Line 54: | Line 57: | ||
| </ | </ | ||
| ---- | ---- | ||
| - | < | + | < |
| - | Saves " | + | Saves " |
| __Slot Number__\\ | __Slot Number__\\ | ||
| * 1 = first slot | * 1 = first slot | ||
| Line 72: | Line 75: | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the current operating mode for channel CHANNEL. In the example, the status of channel 1 is reported to be Constant Current mode, current off.\\ \\ | Returns the current operating mode for channel CHANNEL. In the example, the status of channel 1 is reported to be Constant Current mode, current off.\\ \\ | ||
| __Channel input range__\\ | __Channel input range__\\ | ||
| Line 82: | Line 85: | ||
| 3 = Constant Power mode, ON\\ | 3 = Constant Power mode, ON\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Sets the operating mode to MODE for channel CHANNEL. Returns CONTROL? CHANNEL. In the example, channel 1 is set to Constant Power mode, current on.\\ \\ | Sets the operating mode to MODE for channel CHANNEL. Returns CONTROL? CHANNEL. In the example, channel 1 is set to Constant Power mode, current on.\\ \\ | ||
| __CHANNEL input range__\\ | __CHANNEL input range__\\ | ||
| Line 92: | Line 95: | ||
| 3 = Constant Power mode, ON\\ | 3 = Constant Power mode, ON\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the operating current set point in Amps for channel CHANNEL. In the example, channel 1 current is set to 0.422800 A.\\ \\ | Returns the operating current set point in Amps for channel CHANNEL. In the example, channel 1 current is set to 0.422800 A.\\ \\ | ||
| __CHANNEL input range__\\ | __CHANNEL input range__\\ | ||
| Line 99: | Line 102: | ||
| Current set point of channel CHANNEL in AMPS\\ | Current set point of channel CHANNEL in AMPS\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Sets the set point operating current to CURRENT in Amps for channel CHANNEL. Returns CURRENT? CHANNEL. In the example, the current for channel 1 is set to 0.288 A.((System may not deliver CURRENT Amps due to the high impedance of the specific load or other irregular system configurations.))\\ \\ | Sets the set point operating current to CURRENT in Amps for channel CHANNEL. Returns CURRENT? CHANNEL. In the example, the current for channel 1 is set to 0.288 A.((System may not deliver CURRENT Amps due to the high impedance of the specific load or other irregular system configurations.))\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 110: | Line 113: | ||
| </ | </ | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns user-set maximum current in Amps for channel CHANNEL. In the example, the maximum current supplied by channel 2 has been set to 1.435300 A.\\ \\ | Returns user-set maximum current in Amps for channel CHANNEL. In the example, the maximum current supplied by channel 2 has been set to 1.435300 A.\\ \\ | ||
| __Input range__\\ | __Input range__\\ | ||
| Line 117: | Line 120: | ||
| Maximum allowed current of channel CHANNEL in AMPS\\ | Maximum allowed current of channel CHANNEL in AMPS\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Sets the maximum allowed current to CURRENT in Amps for channel CHANNEL. Returns MAXCURR? CHANNEL. In the example, the maximum allowed current for channel 2 is set to 1.3 A.\\ \\ | Sets the maximum allowed current to CURRENT in Amps for channel CHANNEL. Returns MAXCURR? CHANNEL. In the example, the maximum allowed current for channel 2 is set to 1.3 A.\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 125: | Line 128: | ||
| Requested current maximum in Amps or closest value as bounded by unit capacity.\\ | Requested current maximum in Amps or closest value as bounded by unit capacity.\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns measured current in milliamps for channel CHANNEL. In the example, the measured current of channel 1 is 100//e// mA.((CURRENT? | Returns measured current in milliamps for channel CHANNEL. In the example, the measured current of channel 1 is 100//e// mA.((CURRENT? | ||
| __Input range__\\ | __Input range__\\ | ||
| Line 132: | Line 135: | ||
| Measured current being delivered by channel CHANNEL in milliamps\\ | Measured current being delivered by channel CHANNEL in milliamps\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the Constant Power Mode power set point for channel CHANNEL. In the example, the power set point of channel 1 is 314.0 mW.\\ \\ | Returns the Constant Power Mode power set point for channel CHANNEL. In the example, the power set point of channel 1 is 314.0 mW.\\ \\ | ||
| __Input range__\\ | __Input range__\\ | ||
| CHANNEL: {1,2}\\ | CHANNEL: {1,2}\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Sets the set point power level in milliwatts to which the Constant Power Mode will attempt to servo for channel CHANNEL. Returns PWRSET? CHANNEL. In the example, the set point power for channel 2 is set to 314.0 mW.\\ \\ | Sets the set point power level in milliwatts to which the Constant Power Mode will attempt to servo for channel CHANNEL. Returns PWRSET? CHANNEL. In the example, the set point power for channel 2 is set to 314.0 mW.\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 145: | Line 148: | ||
| Requested power set point or closest value as bounded by unit capacity.\\ | Requested power set point or closest value as bounded by unit capacity.\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the measured power for channel CHANNEL in milliwatts. In the example, the power measured at channel 1 is 314.0 mW.\\ \\ | Returns the measured power for channel CHANNEL in milliwatts. In the example, the power measured at channel 1 is 314.0 mW.\\ \\ | ||
| __Input range__\\ | __Input range__\\ | ||
| CHANNEL: {1,2}\\ | CHANNEL: {1,2}\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the measured compliance voltage across channel CHANNEL in volts. In the example, the voltage drop across channel 1 is 3.345 V.\\ \\ | Returns the measured compliance voltage across channel CHANNEL in volts. In the example, the voltage drop across channel 1 is 3.345 V.\\ \\ | ||
| __Input range__\\ | __Input range__\\ | ||
| CHANNEL: {1,2}\\ | CHANNEL: {1,2}\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the Integral Gain of the Constant Power feedback loop for channel CHANNEL in dB. In the example, the Gain for Constant Power mode feedback for channel 1 is +30.000 000 dB. The default value of the Gain is +30.000 000 dB.\\ \\ | Returns the Integral Gain of the Constant Power feedback loop for channel CHANNEL in dB. In the example, the Gain for Constant Power mode feedback for channel 1 is +30.000 000 dB. The default value of the Gain is +30.000 000 dB.\\ \\ | ||
| __Input range__\\ | __Input range__\\ | ||
| CHANNEL: {1,2}\\ | CHANNEL: {1,2}\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Sets the Integral Gain of the Constant Power feedback loop for channel CHANNEL. Returns GAIN? CHANNEL. In the example, the Gain of the Constant Power feedback loop is set to -31.41596 dB.\\ \\ | Sets the Integral Gain of the Constant Power feedback loop for channel CHANNEL. Returns GAIN? CHANNEL. In the example, the Gain of the Constant Power feedback loop is set to -31.41596 dB.\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 166: | Line 169: | ||
| GAIN: (-100 to +100)\\ | GAIN: (-100 to +100)\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the Constant Power mode external (customer-supplied) detector responsivity in Amps per Watt for channel CHANNEL. In the example, the responsivity of the detector for channel 1 is 0.0035 A/W.\\ \\ | Returns the Constant Power mode external (customer-supplied) detector responsivity in Amps per Watt for channel CHANNEL. In the example, the responsivity of the detector for channel 1 is 0.0035 A/W.\\ \\ | ||
| __Input range__\\ | __Input range__\\ | ||
| CHANNEL: {1,2}\\ | CHANNEL: {1,2}\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Sets the Constant Power mode external (customer-supplied) detector responsivity in Amps per Watt for channel CHANNEL. Returns RESPVTY? CHANNEL. In the example, the responsivity of the detector for channel 1 is set to 0.0035 A/W.\\ \\ | Sets the Constant Power mode external (customer-supplied) detector responsivity in Amps per Watt for channel CHANNEL. Returns RESPVTY? CHANNEL. In the example, the responsivity of the detector for channel 1 is set to 0.0035 A/W.\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 177: | Line 180: | ||
| RESPONSIVITY: | RESPONSIVITY: | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the Constant Power mode Optical Power polarity setting of the input transimpedance amplifier for channel CHANNEL. In the example, the optical power polarity for the channel 1 transimpedance amplifier is positive (default).\\ \\ | Returns the Constant Power mode Optical Power polarity setting of the input transimpedance amplifier for channel CHANNEL. In the example, the optical power polarity for the channel 1 transimpedance amplifier is positive (default).\\ \\ | ||
| __Input range__\\ | __Input range__\\ | ||
| Line 185: | Line 188: | ||
| OFF = Positive Polarity (default) | OFF = Positive Polarity (default) | ||
| ---- | ---- | ||
| - | < | + | < |
| Sets the Polarity of the input transimpedance amplifier for Constant Power Mode for channel CHANNEL. Returns POL? CHANNEL. In the example, the polarity of the transimpedance amplifier for channel 2 is set to Negative (ON).\\ \\ | Sets the Polarity of the input transimpedance amplifier for Constant Power Mode for channel CHANNEL. Returns POL? CHANNEL. In the example, the polarity of the transimpedance amplifier for channel 2 is set to Negative (ON).\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 194: | Line 197: | ||
| 1 = Negative = ON | 1 = Negative = ON | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the status of the interlock. In the example, the interlock is closed and the system is operational.\\ \\ | Returns the status of the interlock. In the example, the interlock is closed and the system is operational.\\ \\ | ||
| __Possible Responses__\\ | __Possible Responses__\\ | ||
| Line 200: | Line 203: | ||
| OFF = Interlock circuit is open and the unit is disabled\\ | OFF = Interlock circuit is open and the unit is disabled\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the analog modulation source for channel CHANNEL. In the example, the modulation source for channel 1 is the front-panel input (labeled A).\\ \\ | Returns the analog modulation source for channel CHANNEL. In the example, the modulation source for channel 1 is the front-panel input (labeled A).\\ \\ | ||
| __Return Values__\\ | __Return Values__\\ | ||
| Line 210: | Line 213: | ||
| ---- | ---- | ||
| - | < | + | <WRAP center round box 40%> |
| + | | {{ : | ||
| + | </ | ||
| + | ---- | ||
| + | < | ||
| Sets the modulation input source for channel CHANNEL. Returns AMODSEL? CHANNEL. In the example, the modulation input source for channel 2 is set to the front-panel BNC (input B).\\ \\ | Sets the modulation input source for channel CHANNEL. Returns AMODSEL? CHANNEL. In the example, the modulation input source for channel 2 is set to the front-panel BNC (input B).\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 222: | Line 229: | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the location to which the measured power of the monitor photodiode is delivered for channel CHANNEL <color red> | Returns the location to which the measured power of the monitor photodiode is delivered for channel CHANNEL <color red> | ||
| __Return Values__\\ | __Return Values__\\ | ||
| Line 233: | Line 240: | ||
| ---- | ---- | ||
| - | < | + | < |
| Sets the location to which the measured power of the monitor photodiode is delivered for channel CHANNEL <color red> | Sets the location to which the measured power of the monitor photodiode is delivered for channel CHANNEL <color red> | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 246: | Line 253: | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the effect of the input trigger on channel CHANNEL. In the example, the input trigger controls the operation of channel 1.\\ \\ | Returns the effect of the input trigger on channel CHANNEL. In the example, the input trigger controls the operation of channel 1.\\ \\ | ||
| __Return Values__\\ | __Return Values__\\ | ||
| Line 258: | Line 265: | ||
| ---- | ---- | ||
| - | < | + | < |
| Sets the effect of the input trigger on channel CHANNEL. Returns TRIGIN? CHANNEL. In the example, the input trigger is given control over channel 1.\\ \\ | Sets the effect of the input trigger on channel CHANNEL. Returns TRIGIN? CHANNEL. In the example, the input trigger is given control over channel 1.\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 270: | Line 277: | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the response of the output trigger to the status of the interlock. In the example, the output trigger will echo the interlock circuit status.\\ \\ | Returns the response of the output trigger to the status of the interlock. In the example, the output trigger will echo the interlock circuit status.\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 281: | Line 288: | ||
| ---- | ---- | ||
| - | < | + | < |
| Sets the response of the output trigger to the interlock status. Returns TRIGOUT? CHANNEL. In the example, the output trigger is directed to echo the status the interlock circuit.\\ \\ | Sets the response of the output trigger to the interlock status. Returns TRIGOUT? CHANNEL. In the example, the output trigger is directed to echo the status the interlock circuit.\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 292: | Line 299: | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the temperature of the SLICE-DCC " | Returns the temperature of the SLICE-DCC " | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| CHANNEL: {1,2}\\ | CHANNEL: {1,2}\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the maximum power (in Watts) available as configured. In the example, the power available is 41.5 W.\\ \\ | Returns the maximum power (in Watts) available as configured. In the example, the power available is 41.5 W.\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
| Line 306: | Line 313: | ||
| ===== Error Handling ===== | ===== Error Handling ===== | ||
| ---- | ---- | ||
| - | < | + | < |
| Returns the error code for channel CHANNEL. In the example, the error code for channel 2 is 49152 (No errors).\\ \\ | Returns the error code for channel CHANNEL. In the example, the error code for channel 2 is 49152 (No errors).\\ \\ | ||
| __Possible Responses__\\ | __Possible Responses__\\ | ||
| Line 315: | Line 322: | ||
| 49408 = Device total power limit exceeded\\ | 49408 = Device total power limit exceeded\\ | ||
| ---- | ---- | ||
| - | < | + | < |
| Clears an error code for channel CHANNEL. Returns post-command ERROR? CHANNEL. In the example, error code 49280 (interlock circuit open) is cleared.\\ \\ | Clears an error code for channel CHANNEL. Returns post-command ERROR? CHANNEL. In the example, error code 49280 (interlock circuit open) is cleared.\\ \\ | ||
| __Input parameter ranges__\\ | __Input parameter ranges__\\ | ||
slice/dcc/api.1576033188.txt.gz · Last modified: 2021/08/26 14:26 (external edit)