aithre/CarbideRestApi.html at linux · DiamondLightSource/aithre · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
<!DOCTYPE HTML><html><head><title>CARBIDE REST API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/raml2html/raml2html 7.6.0"><link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"><script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script><script type="text/javascript">
      $(document).ready(function() {
  $('.page-header pre code, .top-resource-description pre code, .modal-body pre code').each(function(i, block) {
    hljs.highlightBlock(block);
  });

  $('[data-toggle]').click(function() {
    var selector = $(this).data('target') + ' pre code';
    $(selector).each(function(i, block) {
      hljs.highlightBlock(block);
    });
  });

  // open modal on hashes like #_action_get
  $(window).bind('hashchange', function(e) {
    var anchor_id = document.location.hash.substr(1); //strip #
    var element = $('#' + anchor_id);

    // do we have such element + is it a modal?  --> show it
    if (element.length && element.hasClass('modal')) {
      element.modal('show');
    }
  });

  // execute hashchange on first page load
  $(window).trigger('hashchange');

  // remove url fragment on modal hide
  $('.modal').on('hidden.bs.modal', function() {
    try {
      if (history && history.replaceState) {
          history.replaceState({}, '', '#');
      }
    } catch(e) {}
  });
});
    </script><style>
      .hljs {
  background: transparent;
}
.parent {
  color: #999;
}
.list-group-item > .badge {
  float: none;
  margin-right: 6px;
}
.panel-title > .methods {
  float: right;
}
.badge {
  border-radius: 0;
  text-transform: uppercase;
  width: 70px;
  font-weight: normal;
  color: #f3f3f6;
  line-height: normal;
}
.badge_get {
  background-color: #63a8e2;
}
.badge_post {
  background-color: #6cbd7d;
}
.badge_put {
  background-color: #22bac4;
}
.badge_delete {
  background-color: #d26460;
}
.badge_patch {
  background-color: #ccc444;
}
.list-group,
.panel-group {
  margin-bottom: 0;
}
.panel-group .panel+.panel-white {
  margin-top: 0;
}
.panel-group .panel-white {
  border-bottom: 1px solid #F5F5F5;
  border-radius: 0;
}
.panel-white:last-child {
  border-bottom-color: white;
  -webkit-box-shadow: none;
  box-shadow: none;
}
.panel-white .panel-heading {
  background: white;
}
.tab-pane ul {
  padding-left: 2em;
}
.tab-pane h1 {
  font-size: 1.3em;
}
.tab-pane h2 {
  font-size: 1.2em;
  padding-bottom: 4px;
  border-bottom: 1px solid #ddd;
}
.tab-pane h3 {
  font-size: 1.1em;
}
.tab-content {
  border-left: 1px solid #ddd;
  border-right: 1px solid #ddd;
  border-bottom: 1px solid #ddd;
  padding: 10px;
}
#sidebar {
  margin-top: 30px;
  padding-right: 5px;
  overflow: auto;
  height: 90%;
}
.top-resource-description {
  border-bottom: 1px solid #ddd;
  background: #fcfcfc;
  padding: 15px 15px 0 15px;
  margin: -15px -15px 10px -15px;
}
.resource-description {
  border-bottom: 1px solid #fcfcfc;
  background: #fcfcfc;
  padding: 15px 15px 0 15px;
  margin: -15px -15px 10px -15px;
}
.resource-description p:last-child {
  margin: 0;
}
.list-group .badge {
  float: left;
}
.method_description {
  margin-left: 85px;
}
.method_description p:last-child {
  margin: 0;
}
.list-group-item {
  cursor: pointer;
}
.list-group-item:hover {
  background-color: #f5f5f5;
}
pre code {
  overflow: auto;
  word-wrap: normal;
  white-space: pre;
}
.items {
  background: #f5f5f5;
  color: #333;
  border: 1px solid #ccc;
  border-radius: 4px;
  padding: 9.5px;
  margin: 0 0 10px;
  font-size: 13px;
  line-height: 1.42857143;
}
.examples {
  margin-left: 0.5em;
}
.resource-modal li > ul {
  margin-bottom: 1em;
}
.required {
  color: #f00;
}
    </style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>CARBIDE REST API documentation <small>version v1</small></h1><p>http://CARBIDE_IP_ADDRESS:20018/{version}</p><ul><li><strong>version</strong>: <em><span class="required">required</span>(v1)</em></li></ul><h3 id="introduction"><a href="#introduction">Introduction</a></h3><p>The CARBIDE laser hosts a REST server, which greatly simplifies external control. This REST server is very capable, but not almighty, will only accept commands that mostly correspond to the CARBIDE User App logic <strong>(limited to mostly basic functions)</strong>.</p><p>Since this API is a HTTP-based service, consuming it is easy from pretty much any platform, either it is LabView, .NET languages or Python.</p><h3 id="usage"><a href="#usage">Usage</a></h3><p>The API is split into several endpoints:</p><ul><li><strong>/Basic</strong>. This endpoint contains all of the most frequently used functions. It basically replicated the main CARBIDE User App screen. Whatever one can press or see in the "Basic" tab of the User App, can also be found under this endpoint. In fact, User App itself utilizes this endpoint heavily.</li><li><strong>/StretcherCompressor</strong>. All the compression stage-related functionality resides here.</li><li><strong>/ExternalControl</strong>. Covers all the functionality related to the external connectors on the laser backplate (shot triggering, synchronization, custom TTL outputs, etc.).</li><li><strong>/Advanced</strong>. Functionality contained here is not meant for everyday use. Moreover, some of the advanced functions, are only used by the User/Service Apps themselves and have no meaning for the user.</li><li><strong>/Burst</strong>. Defines functionality related to CB3-Burst lasers. This endpoint is valid only for systems equipped with the Burst functionality. Ignore this endpoint if your laser is not equipped with the Burst functionality.</li></ul><p>REST is all about resources, and each resource endpoint is made out of three parts: {server address}/{API version}/{local endpoint}.</p><ul><li>{server address}. By default, CARBIDE lasers are shipped with a static IP 192.168.240.10. REST is always accessible via port 20018, so {server address} resource translates into "192.168.240.10:20018".</li><li>{API version}. Has a standard display form of "v1", "v2", v3", etc. It denotes the generation of the API; all endpoints added in one generation can only be removed in next one. For example, if "/ActualOutputEnergy" endpoint has been added to "v1", it will remain there forever. If, for whatever reasons,a decision will be made to rename it to "/EnergyOutputActual" (a highly unlikely change), it will only be changed in the next generation "v2". Even then, both generations "v1" and "v2" will operate side-by-side.</li><li>{local endpoint}. Simple readable text, which usually points out the function of the endpoint, like "ActualOutputPower" or "ExecutePreset".</li></ul><p>Here are some examples:</p><ul><li>192.168.240.10:20018/v1/Basic/IsOutputEnabled</li><li>192.168.240.10:20018/v1/Basic/Warnings</li><li>192.168.240.10:20018/v1/Basic/CloseOutput</li></ul><p>Any GET request can be issued using any browser, which is enough to monitor states. However, to practice PUT and POST requests, it is recommended to use a Chrome plugin (or a standalone installation) called <a href="www.getpostman.com">Postman</a>. It is also possible to use other softwares, such as <a href="https://www.telerik.com/download/fiddler">Fiddler</a> as well, but it is not usually used by the development team.</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="basic" class="panel-title">/Basic</h3></div><div class="panel-body"><div class="top-resource-description"><p>Defines basic functionality. Maps the UI title screen (Basic tab) almost completely 1:1.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic"><span class="parent"></span>/Basic</a> <span class="methods"><a href="#basic_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets all the basic properties that have GET methods. All of them can be queried individually, but sometimes it is more convenient to get them all in one batch.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/Basic</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets all the basic properties that have GET methods. All of them can be queried individually, but sometimes it is more convenient to get them all in one batch.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. GETable properties are in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "Warnings": [],
    "ActualPpDivider": 1,
    "TargetPulseDuration": -222,
    "ActualOutputEnergy": 12.5275135,
    "ActualHarmonic": 2,
    "IsOutputEnabled": false,
    "ActualStateName": "StateOperational",
    "TargetPpDivider": 1,
    "TargetAttenuatorPercentage": 100,
    "ActualShutterState": "Closed",
    "ActualOutputFrequency": 120.130226,
    "Errors": [],
    "SelectedPresetIndex": 0,
    "LastExecutedPresetIndex": 0,
    "ActualOutputPower": 1.504933,
    "GeneralStatus": "",
    "ActualPulseDuration": -222,
    "ActualAttenuatorPercentage": 100,
    "ActualBurstPulseCount": 0,
    "IsPowerlockEnabled": true,
    "TargetBurstPulseCount": 0,
    "SerialNumber": "C12345",
    "LaserIdentificationNumber": "D12345"
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_generalstatus"><span class="parent">/Basic</span>/GeneralStatus</a> <span class="methods"><a href="#basic_generalstatus_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_generalstatus" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_generalstatus_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets general status message of the laser. Note that this is a simple text string, and its implementation can actually change without a prior notice (for example, it may be localized).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_generalstatus_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/GeneralStatus</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets general status message of the laser. Note that this is a simple text string, and its implementation can actually change without a prior notice (for example, it may be localized).</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_generalstatus_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_generalstatus_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Status message is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"Waiting for powerlock.."
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_isoutputenabled"><span class="parent">/Basic</span>/IsOutputEnabled</a> <span class="methods"><a href="#basic_isoutputenabled_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_isoutputenabled" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_isoutputenabled_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets the state of the output.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_isoutputenabled_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/IsOutputEnabled</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets the state of the output.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_isoutputenabled_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_isoutputenabled_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Output state (true/false) is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>true
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_closeoutput"><span class="parent">/Basic</span>/CloseOutput</a> <span class="methods"><a href="#basic_closeoutput_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_basic_closeoutput" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_closeoutput_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Closes (and disables) output.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_closeoutput_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/Basic</span>/CloseOutput</h4></div><div class="modal-body"><div class="alert alert-info"><p>Closes (and disables) output.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_closeoutput_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_closeoutput_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Laser output has been closed and disabled.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Laser is in a state that forbids disabling the output (this is only possible in states when the laser is not running anyway).</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_enableoutput"><span class="parent">/Basic</span>/EnableOutput</a> <span class="methods"><a href="#basic_enableoutput_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_basic_enableoutput" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_enableoutput_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Enables output. It now depends on external factor whether laser is emitting light or not (for example, PP is controlled externally).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_enableoutput_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/Basic</span>/EnableOutput</h4></div><div class="modal-body"><div class="alert alert-info"><p>Enables output. It now depends on external factor whether laser is emitting light or not (for example, PP is controlled externally).</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_enableoutput_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_enableoutput_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Laser output has been enabled.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Laser is in a state that forbids enabling the output.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_actualshutterstate"><span class="parent">/Basic</span>/ActualShutterState</a> <span class="methods"><a href="#basic_actualshutterstate_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_actualshutterstate" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_actualshutterstate_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual, physical, shutter state. This state doesn&#39;t depend on global laser state. Possible shutter states are "Opened", "Closed".</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_actualshutterstate_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/ActualShutterState</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual, physical, shutter state. This state doesn&#39;t depend on global laser state. Possible shutter states are "Opened", "Closed".</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_actualshutterstate_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_actualshutterstate_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Shutter state in in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"Closed"
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_actualoutputenergy"><span class="parent">/Basic</span>/ActualOutputEnergy</a> <span class="methods"><a href="#basic_actualoutputenergy_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_actualoutputenergy" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_actualoutputenergy_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual output pulse energy in μJ. Note that this is a calculated value, and may differ slightly from real value.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_actualoutputenergy_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/ActualOutputEnergy</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual output pulse energy in μJ. Note that this is a calculated value, and may differ slightly from real value.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_actualoutputenergy_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_actualoutputenergy_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Actual output energy is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>12.5595198
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_actualoutputfrequency"><span class="parent">/Basic</span>/ActualOutputFrequency</a> <span class="methods"><a href="#basic_actualoutputfrequency_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_actualoutputfrequency" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_actualoutputfrequency_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual output pulse frequency (repetition rate), in kHz. Takes into account PP divider.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_actualoutputfrequency_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/ActualOutputFrequency</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual output pulse frequency (repetition rate), in kHz. Takes into account PP divider.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_actualoutputfrequency_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_actualoutputfrequency_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Actual output pulse frequency is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>120.130226
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_actualoutputpower"><span class="parent">/Basic</span>/ActualOutputPower</a> <span class="methods"><a href="#basic_actualoutputpower_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_actualoutputpower" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_actualoutputpower_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual laser output power, taking PP divider and attenuator into account. Note that this is a calculated value, and may differ slightly from real value.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_actualoutputpower_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/ActualOutputPower</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual laser output power, taking PP divider and attenuator into account. Note that this is a calculated value, and may differ slightly from real value.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_actualoutputpower_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_actualoutputpower_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Actual output power is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2.000
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_actualharmonic"><span class="parent">/Basic</span>/ActualHarmonic</a> <span class="methods"><a href="#basic_actualharmonic_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_actualharmonic" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_actualharmonic_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual harmonic number.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_actualharmonic_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/ActualHarmonic</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual harmonic number.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_actualharmonic_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_actualharmonic_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Actual harmonic number is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_actualattenuatorpercentage"><span class="parent">/Basic</span>/ActualAttenuatorPercentage</a> <span class="methods"><a href="#basic_actualattenuatorpercentage_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_actualattenuatorpercentage" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>There may be multiple attenuator in the system (for example, harmonics waveplate and AOM), and one of them is set as a "master". It is only possible to control master attenuattor via REST. Possible values are in range [0.0, 100.0].</p></div><div class="list-group"><div onclick="window.location.href = '#basic_actualattenuatorpercentage_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual attenuator percentage. Usually it is very close to the target percentage, but may differ slightly.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_actualattenuatorpercentage_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/ActualAttenuatorPercentage</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual attenuator percentage. Usually it is very close to the target percentage, but may differ slightly.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_actualattenuatorpercentage_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_actualattenuatorpercentage_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Actual attenuator percentage is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>51.2
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_targetattenuatorpercentage"><span class="parent">/Basic</span>/TargetAttenuatorPercentage</a> <span class="methods"><a href="#basic_targetattenuatorpercentage_get"><span class="badge badge_get">get</span></a> <a href="#basic_targetattenuatorpercentage_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_basic_targetattenuatorpercentage" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>There may be multiple attenuator in the system (for example, harmonics waveplate and AOM), and one of them is set as a "master". It is only possible to control master attenuattor via REST. Possible values are in range [0.0, 100.0].</p></div><div class="list-group"><div onclick="window.location.href = '#basic_targetattenuatorpercentage_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets target attenuator percentage. Usually it is very close to the actual percentage, but may differ slightly.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#basic_targetattenuatorpercentage_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets target attenuator percentage. It may take a couple moments before actual attenuation is achieved.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_targetattenuatorpercentage_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/TargetAttenuatorPercentage</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets target attenuator percentage. Usually it is very close to the actual percentage, but may differ slightly.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_targetattenuatorpercentage_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_targetattenuatorpercentage_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Target attenuator percentage is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>1
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_targetattenuatorpercentage_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Basic</span>/TargetAttenuatorPercentage</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets target attenuator percentage. It may take a couple moments before actual attenuation is achieved.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_targetattenuatorpercentage_put_request" data-toggle="tab">Request</a></li><li><a href="#basic_targetattenuatorpercentage_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_targetattenuatorpercentage_put_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>51.2
</code></pre></div></div><div class="tab-pane" id="basic_targetattenuatorpercentage_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Target attenuator percentage has been set.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Target percentage is out of bounds. Should be between 0.0 and 100.0 (inclusive).</li><li>Laser is in a state that forbids setting attenuator percentage.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_actualpulseduration"><span class="parent">/Basic</span>/ActualPulseDuration</a> <span class="methods"><a href="#basic_actualpulseduration_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_actualpulseduration" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Actual pulse duration in femtoseconds. Sign denotes chirp polarity, i.e. positive numbers correspond to positively-chirped pulses and vice versa.</p></div><div class="list-group"><div onclick="window.location.href = '#basic_actualpulseduration_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual pulse duration.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_actualpulseduration_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/ActualPulseDuration</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual pulse duration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_actualpulseduration_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_actualpulseduration_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Actual pulse duration is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>-224.712677
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_targetpulseduration"><span class="parent">/Basic</span>/TargetPulseDuration</a> <span class="methods"><a href="#basic_targetpulseduration_get"><span class="badge badge_get">get</span></a> <a href="#basic_targetpulseduration_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_basic_targetpulseduration" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Target pulse duration in femtoseconds. Sign denotes chirp polarity, i.e. positive numbers correspond to positively-chirped pulses and vice versa. If this number differs from ActualPulseDuration, compression stage may still be in motion.</p></div><div class="list-group"><div onclick="window.location.href = '#basic_targetpulseduration_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets target pulse duration in femtoseconds.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#basic_targetpulseduration_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets target pulse duration in femtoseconds. Under normal circumstances, this immediately triggers movement of the compression stage.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_targetpulseduration_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/TargetPulseDuration</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets target pulse duration in femtoseconds.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_targetpulseduration_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_targetpulseduration_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Target pulse duration is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>312.5
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_targetpulseduration_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Basic</span>/TargetPulseDuration</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets target pulse duration in femtoseconds. Under normal circumstances, this immediately triggers movement of the compression stage.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_targetpulseduration_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_targetpulseduration_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Pulse duration is out of range.</li><li>Laser is in a state that forbids setting pulse duration.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_actualppdivider"><span class="parent">/Basic</span>/ActualPpDivider</a> <span class="methods"><a href="#basic_actualppdivider_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_actualppdivider" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_actualppdivider_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual PP divider.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_actualppdivider_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/ActualPpDivider</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual PP divider.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_actualppdivider_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_actualppdivider_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Actual PP divider is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>5
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_targetppdivider"><span class="parent">/Basic</span>/TargetPpDivider</a> <span class="methods"><a href="#basic_targetppdivider_get"><span class="badge badge_get">get</span></a> <a href="#basic_targetppdivider_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_basic_targetppdivider" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_targetppdivider_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets target PP divider.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#basic_targetppdivider_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets target PP divider.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_targetppdivider_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/TargetPpDivider</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets target PP divider.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_targetppdivider_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_targetppdivider_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Target PP divider is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>5
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_targetppdivider_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Basic</span>/TargetPpDivider</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets target PP divider.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_targetppdivider_put_request" data-toggle="tab">Request</a></li><li><a href="#basic_targetppdivider_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_targetppdivider_put_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>5
</code></pre></div></div><div class="tab-pane" id="basic_targetppdivider_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Target PP divider has been set.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Target PP divider is out of bounds. Should be no less than 1.</li><li>Laser is in a state that forbids setting PP divider.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_actualburstpulsecount"><span class="parent">/Basic</span>/ActualBurstPulseCount</a> <span class="methods"><a href="#basic_actualburstpulsecount_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_actualburstpulsecount" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_actualburstpulsecount_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual pulse burst count. 0 means continuous train (infinite count).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_actualburstpulsecount_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/ActualBurstPulseCount</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual pulse burst count. 0 means continuous train (infinite count).</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_actualburstpulsecount_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_actualburstpulsecount_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Actual pulse burst count is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>0
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_targetburstpulsecount"><span class="parent">/Basic</span>/TargetBurstPulseCount</a> <span class="methods"><a href="#basic_targetburstpulsecount_get"><span class="badge badge_get">get</span></a> <a href="#basic_targetburstpulsecount_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_basic_targetburstpulsecount" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_targetburstpulsecount_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets the target pulse burst count. 0 means continuous train (infinite count).</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#basic_targetburstpulsecount_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets the target pulse burst count. 0 means continuous train (infinite count).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_targetburstpulsecount_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/TargetBurstPulseCount</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets the target pulse burst count. 0 means continuous train (infinite count).</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_targetburstpulsecount_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_targetburstpulsecount_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Target pulse burst count is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>1

</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_targetburstpulsecount_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Basic</span>/TargetBurstPulseCount</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets the target pulse burst count. 0 means continuous train (infinite count).</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_targetburstpulsecount_put_request" data-toggle="tab">Request</a></li><li><a href="#basic_targetburstpulsecount_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_targetburstpulsecount_put_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>0
</code></pre></div></div><div class="tab-pane" id="basic_targetburstpulsecount_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Target pulse burst count has been set.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Laser is in a state that forbids setting PP divider.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_actualstatename"><span class="parent">/Basic</span>/ActualStateName</a> <span class="methods"><a href="#basic_actualstatename_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_actualstatename" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_actualstatename_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets Carbide state name from its global state machine. Possible states are "Initializing", "Service", "InFieldUpdate", "StandingBy", "GoingToStandby", "Failure", "Housekeeping", "Operational".</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_actualstatename_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/ActualStateName</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets Carbide state name from its global state machine. Possible states are "Initializing", "Service", "InFieldUpdate", "StandingBy", "GoingToStandby", "Failure", "Housekeeping", "Operational".</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_actualstatename_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_actualstatename_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Laser state name is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"Operational"
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_warnings"><span class="parent">/Basic</span>/Warnings</a> <span class="methods"><a href="#basic_warnings_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_warnings" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_warnings_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets the code list of all currently active warnings (those with the "W" prefix; consult manual for detailed explanation).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_warnings_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/Warnings</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets the code list of all currently active warnings (those with the "W" prefix; consult manual for detailed explanation).</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_warnings_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_warnings_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Warning list is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
    {
        "Description": "Cooling fans don&#39;t work properly.",
        "Code": "W0600"
    }
]
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_errors"><span class="parent">/Basic</span>/Errors</a> <span class="methods"><a href="#basic_errors_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_errors" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_errors_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets the code list of all active errors (those with the "E" prefix; cosult manual for detailed explanation). Note that errors are latched and only cleared on laser start (or preset execution).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_errors_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/Errors</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets the code list of all active errors (those with the "E" prefix; cosult manual for detailed explanation). Note that errors are latched and only cleared on laser start (or preset execution).</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_errors_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_errors_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Error list is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
    {
        "Description": "RA went down.",
        "Code": "E1000"
    }
]
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_selectedpresetindex"><span class="parent">/Basic</span>/SelectedPresetIndex</a> <span class="methods"><a href="#basic_selectedpresetindex_get"><span class="badge badge_get">get</span></a> <a href="#basic_selectedpresetindex_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_basic_selectedpresetindex" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_selectedpresetindex_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets selected preset. Presets are numbered incrementially starting at index 0.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#basic_selectedpresetindex_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Selects desired preset. Presets are numbered incrementially starting at index 0.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_selectedpresetindex_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/SelectedPresetIndex</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets selected preset. Presets are numbered incrementially starting at index 0.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_selectedpresetindex_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_selectedpresetindex_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Selected preset index is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>1
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_selectedpresetindex_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Basic</span>/SelectedPresetIndex</h4></div><div class="modal-body"><div class="alert alert-info"><p>Selects desired preset. Presets are numbered incrementially starting at index 0.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_selectedpresetindex_put_request" data-toggle="tab">Request</a></li><li><a href="#basic_selectedpresetindex_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_selectedpresetindex_put_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>1
</code></pre></div></div><div class="tab-pane" id="basic_selectedpresetindex_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Selected preset index has been set.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Incorrect preset index. It cannot be less that 0 and more than a total number of presets available.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_lastexecutedpresetindex"><span class="parent">/Basic</span>/LastExecutedPresetIndex</a> <span class="methods"><a href="#basic_lastexecutedpresetindex_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_lastexecutedpresetindex" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_lastexecutedpresetindex_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets last executed preset. Presets are numbered incrementially starting at index 0.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_lastexecutedpresetindex_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/LastExecutedPresetIndex</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets last executed preset. Presets are numbered incrementially starting at index 0.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_lastexecutedpresetindex_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_lastexecutedpresetindex_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Last executed preset index is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>1
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_applyselectedpreset"><span class="parent">/Basic</span>/ApplySelectedPreset</a> <span class="methods"><a href="#basic_applyselectedpreset_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_basic_applyselectedpreset" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_applyselectedpreset_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Triggers execution of the selected preset.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_applyselectedpreset_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/Basic</span>/ApplySelectedPreset</h4></div><div class="modal-body"><div class="alert alert-info"><p>Triggers execution of the selected preset.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_applyselectedpreset_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_applyselectedpreset_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Selected preset is now executing. Laser should go to "Housekeeping" state and shortly go back to "Operational".</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Laser is in a state that forbids executing preset.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_gotostandby"><span class="parent">/Basic</span>/GoToStandby</a> <span class="methods"><a href="#basic_gotostandby_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_basic_gotostandby" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_gotostandby_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Sends laser into Standby state.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_gotostandby_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/Basic</span>/GoToStandby</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sends laser into Standby state.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_gotostandby_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_gotostandby_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Laser standby sequence has been initiated.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Laser is in a state that forbids putting it to standby state.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_ispowerlockenabled"><span class="parent">/Basic</span>/IsPowerlockEnabled</a> <span class="methods"><a href="#basic_ispowerlockenabled_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_ispowerlockenabled" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_ispowerlockenabled_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets whether RA powerlock is currently enabled or not.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_ispowerlockenabled_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/IsPowerlockEnabled</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets whether RA powerlock is currently enabled or not.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_ispowerlockenabled_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_ispowerlockenabled_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Powerlock state is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>true
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_enablepowerlock"><span class="parent">/Basic</span>/EnablePowerlock</a> <span class="methods"><a href="#basic_enablepowerlock_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_basic_enablepowerlock" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_enablepowerlock_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Enables RA powerlock.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_enablepowerlock_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/Basic</span>/EnablePowerlock</h4></div><div class="modal-body"><div class="alert alert-info"><p>Enables RA powerlock.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_enablepowerlock_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_enablepowerlock_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. RA powerlock has been enabled.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Laser is in a state that forbids enabling RA powerlock.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_disablepowerlock"><span class="parent">/Basic</span>/DisablePowerlock</a> <span class="methods"><a href="#basic_disablepowerlock_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_basic_disablepowerlock" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_disablepowerlock_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Disables RA powerlock.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_disablepowerlock_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/Basic</span>/DisablePowerlock</h4></div><div class="modal-body"><div class="alert alert-info"><p>Disables RA powerlock.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_disablepowerlock_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_disablepowerlock_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. RA powerlock has been disabled.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Laser is in a state that forbids disabling RA powerlock.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_serialnumber"><span class="parent">/Basic</span>/SerialNumber</a> <span class="methods"><a href="#basic_serialnumber_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_serialnumber" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_serialnumber_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets Laser serial number.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_serialnumber_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/SerialNumber</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets Laser serial number.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_serialnumber_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_serialnumber_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successfull. Serial number is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"C12345"
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_basic_laseridentificationnumber"><span class="parent">/Basic</span>/LaserIdentificationNumber</a> <span class="methods"><a href="#basic_laseridentificationnumber_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_basic_laseridentificationnumber" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#basic_laseridentificationnumber_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets Laser identification number.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="basic_laseridentificationnumber_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Basic</span>/LaserIdentificationNumber</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets Laser identification number.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#basic_laseridentificationnumber_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="basic_laseridentificationnumber_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successfull. Laser identification number is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"D12345"
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="stretchercompressor" class="panel-title">/StretcherCompressor</h3></div><div class="panel-body"><div class="top-resource-description"><p>Various functions to control strecher/compressor unit in CARBIDE.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stretchercompressor"><span class="parent"></span>/StretcherCompressor</a> <span class="methods"><a href="#stretchercompressor_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_stretchercompressor" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#stretchercompressor_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets all external Stretcher/Compressor properties that have GET methods. All of them can be queried individually, but sometimes it is more convenient to get them all in one batch.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/StretcherCompressor</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets all external Stretcher/Compressor properties that have GET methods. All of them can be queried individually, but sometimes it is more convenient to get them all in one batch.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "PulseDurationPositiveChirpRange": {
        "To": 1500,
        "From": 222
    },
    "ActualPosition": 0,
    "PulseDurationNegativeChirpRange": {
        "To": -15000,
        "From": -222
    },
    "ActualPulseDuration": -222,
    "TargetPosition": 0,
    "PositionRange": {
        "To": 1.29286003,
        "From": -15.6400509
    },
    "TargetPulseDuration": -222
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stretchercompressor_actualpulseduration"><span class="parent">/StretcherCompressor</span>/ActualPulseDuration</a> <span class="methods"><a href="#stretchercompressor_actualpulseduration_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_stretchercompressor_actualpulseduration" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Actual pulse duration in femtoseconds. Sign denotes chirp polarity, i.e. positive numbers correspond to positively-chirped pulses and vice versa.</p></div><div class="list-group"><div onclick="window.location.href = '#stretchercompressor_actualpulseduration_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual pulse duration.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_actualpulseduration_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/StretcherCompressor</span>/ActualPulseDuration</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual pulse duration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_actualpulseduration_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_actualpulseduration_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Actual pulse duration is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>-224.712677
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stretchercompressor_targetpulseduration"><span class="parent">/StretcherCompressor</span>/TargetPulseDuration</a> <span class="methods"><a href="#stretchercompressor_targetpulseduration_get"><span class="badge badge_get">get</span></a> <a href="#stretchercompressor_targetpulseduration_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_stretchercompressor_targetpulseduration" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Target pulse duration in femtoseconds. Sign denotes chirp polarity, i.e. positive numbers correspond to positively-chirped pulses and vice versa. If this number differs from ActualPulseDuration, compression stage may still be in motion.</p></div><div class="list-group"><div onclick="window.location.href = '#stretchercompressor_targetpulseduration_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets target pulse duration in femtoseconds.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#stretchercompressor_targetpulseduration_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets target pulse duration in femtoseconds. Under normal circumstances, this immediately triggers movement of the compression stage.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_targetpulseduration_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/StretcherCompressor</span>/TargetPulseDuration</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets target pulse duration in femtoseconds.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_targetpulseduration_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_targetpulseduration_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Target pulse duration is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>312.5
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_targetpulseduration_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/StretcherCompressor</span>/TargetPulseDuration</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets target pulse duration in femtoseconds. Under normal circumstances, this immediately triggers movement of the compression stage.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_targetpulseduration_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_targetpulseduration_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Pulse duration is out of range.</li><li>Laser is in a state that forbids setting pulse duration.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stretchercompressor_saveasshortestimpulseduration"><span class="parent">/StretcherCompressor</span>/SaveAsShortestImpulseDuration</a> <span class="methods"><a href="#stretchercompressor_saveasshortestimpulseduration_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_stretchercompressor_saveasshortestimpulseduration" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#stretchercompressor_saveasshortestimpulseduration_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>CARBIDE ships with calibrated compression line. Sometimes, however, calibration reference point may drift (for example, stage moves slightly during transportation). In such cases, user may adjust the reference point.</p><ol><li>Move stage to a position of the shortest pulse.</li><li>Issue this command. CARBIDE will take current stage position as the new reference point.</li><li>All related data (like actual pulse duration) will be updated immediately.</li></ol></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_saveasshortestimpulseduration_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/StretcherCompressor</span>/SaveAsShortestImpulseDuration</h4></div><div class="modal-body"><div class="alert alert-info"><p>CARBIDE ships with calibrated compression line. Sometimes, however, calibration reference point may drift (for example, stage moves slightly during transportation). In such cases, user may adjust the reference point.</p><ol><li>Move stage to a position of the shortest pulse.</li><li>Issue this command. CARBIDE will take current stage position as the new reference point.</li><li>All related data (like actual pulse duration) will be updated immediately.</li></ol></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_saveasshortestimpulseduration_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_saveasshortestimpulseduration_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Laser is in a state that forbids this command.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stretchercompressor_pulsedurationpositivechirprange"><span class="parent">/StretcherCompressor</span>/PulseDurationPositiveChirpRange</a> <span class="methods"><a href="#stretchercompressor_pulsedurationpositivechirprange_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_stretchercompressor_pulsedurationpositivechirprange" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#stretchercompressor_pulsedurationpositivechirprange_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets range of valid positive chirp pulse durations.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_pulsedurationpositivechirprange_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/StretcherCompressor</span>/PulseDurationPositiveChirpRange</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets range of valid positive chirp pulse durations.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_pulsedurationpositivechirprange_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_pulsedurationpositivechirprange_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "To": 1500,
    "From": 222
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stretchercompressor_pulsedurationnegativechirprange"><span class="parent">/StretcherCompressor</span>/PulseDurationNegativeChirpRange</a> <span class="methods"><a href="#stretchercompressor_pulsedurationnegativechirprange_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_stretchercompressor_pulsedurationnegativechirprange" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#stretchercompressor_pulsedurationnegativechirprange_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets range of valid negative chirp pulse durations.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_pulsedurationnegativechirprange_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/StretcherCompressor</span>/PulseDurationNegativeChirpRange</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets range of valid negative chirp pulse durations.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_pulsedurationnegativechirprange_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_pulsedurationnegativechirprange_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "To": -15000,
    "From": -222
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stretchercompressor_actualposition"><span class="parent">/StretcherCompressor</span>/ActualPosition</a> <span class="methods"><a href="#stretchercompressor_actualposition_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_stretchercompressor_actualposition" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>It is recommended to operating compression stage in pulse duration units. If that is not an option for whatever reason, absolute stage position can also be used.</p></div><div class="list-group"><div onclick="window.location.href = '#stretchercompressor_actualposition_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual stage position in millimeters.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_actualposition_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/StretcherCompressor</span>/ActualPosition</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual stage position in millimeters.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_actualposition_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_actualposition_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>-0.00381000014
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stretchercompressor_targetposition"><span class="parent">/StretcherCompressor</span>/TargetPosition</a> <span class="methods"><a href="#stretchercompressor_targetposition_get"><span class="badge badge_get">get</span></a> <a href="#stretchercompressor_targetposition_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_stretchercompressor_targetposition" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>It is recommended to operating compression stage in pulse duration units. If that is not an option for whatever reason, absolute stage position can also be used.</p></div><div class="list-group"><div onclick="window.location.href = '#stretchercompressor_targetposition_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets target compressor position in millimeters.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#stretchercompressor_targetposition_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets target compressor position in millimeters. This triggers immediate stage movement.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_targetposition_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/StretcherCompressor</span>/TargetPosition</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets target compressor position in millimeters.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_targetposition_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_targetposition_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>-0.00381000014
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_targetposition_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/StretcherCompressor</span>/TargetPosition</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets target compressor position in millimeters. This triggers immediate stage movement.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_targetposition_put_request" data-toggle="tab">Request</a></li><li><a href="#stretchercompressor_targetposition_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_targetposition_put_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>1.22
</code></pre></div></div><div class="tab-pane" id="stretchercompressor_targetposition_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Target position is out of range.</li><li>Laser is in a state that forbids controlling comrpession stage.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_stretchercompressor_positionrange"><span class="parent">/StretcherCompressor</span>/PositionRange</a> <span class="methods"><a href="#stretchercompressor_positionrange_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_stretchercompressor_positionrange" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>It is recommended to operating compression stage in pulse duration units. If that is not an option for whatever reason, absolute stage position can also be used.</p></div><div class="list-group"><div onclick="window.location.href = '#stretchercompressor_positionrange_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets range of valid compressor positions in millimeters.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="stretchercompressor_positionrange_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/StretcherCompressor</span>/PositionRange</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets range of valid compressor positions in millimeters.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#stretchercompressor_positionrange_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="stretchercompressor_positionrange_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "To": 1.29286003,
    "From": -15.6400509
}
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="externalcontrol" class="panel-title">/ExternalControl</h3></div><div class="panel-body"><div class="top-resource-description"><p>Functions for external control frequency sync input, Pulse Picker and AOM trigger sources, etc.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_externalcontrol"><span class="parent"></span>/ExternalControl</a> <span class="methods"><a href="#externalcontrol_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_externalcontrol" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#externalcontrol_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets all external control properties that have GET methods. All of them can be queried individually, but sometimes it is more convenient to get them all in one batch.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/ExternalControl</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets all external control properties that have GET methods. All of them can be queried individually, but sometimes it is more convenient to get them all in one batch.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "ExternalSyncConfiguration": "Disabled",
    "AomTriggerSource": "Internal",
    "AnalogControlSource": "Internal",
    "FastEnergyControlSource": "Internal",
    "HvFastEnergyControlSource": "Internal"
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_externalcontrol_aomtriggersource"><span class="parent">/ExternalControl</span>/AomTriggerSource</a> <span class="methods"><a href="#externalcontrol_aomtriggersource_get"><span class="badge badge_get">get</span></a> <a href="#externalcontrol_aomtriggersource_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_externalcontrol_aomtriggersource" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Pulse Picker and AOM trigger source configuration. Available values are "Internal", "ExternalLow", "ExternalHigh". AOM feature is optional and depends on laser model.</p></div><div class="list-group"><div onclick="window.location.href = '#externalcontrol_aomtriggersource_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual Pulse Picker and AOM trigger source configuration.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#externalcontrol_aomtriggersource_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets new Pulse Picker and AOM trigger source configuration.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_aomtriggersource_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/ExternalControl</span>/AomTriggerSource</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual Pulse Picker and AOM trigger source configuration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_aomtriggersource_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_aomtriggersource_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"Internal"
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_aomtriggersource_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/ExternalControl</span>/AomTriggerSource</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets new Pulse Picker and AOM trigger source configuration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_aomtriggersource_put_request" data-toggle="tab">Request</a></li><li><a href="#externalcontrol_aomtriggersource_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_aomtriggersource_put_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"ExternalHigh"
</code></pre></div></div><div class="tab-pane" id="externalcontrol_aomtriggersource_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Configuration is not supported. Should be "Internal", "ExternalLow" or "ExternalHigh".</li><li>Laser is in a state that forbids setting AomTriggerSource.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_externalcontrol_analogcontrolsource"><span class="parent">/ExternalControl</span>/AnalogControlSource</a> <span class="methods"><a href="#externalcontrol_analogcontrolsource_get"><span class="badge badge_get">get</span></a> <a href="#externalcontrol_analogcontrolsource_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_externalcontrol_analogcontrolsource" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Gets analog control source configuration. Use only values listed below.</p><ul><li>"Internal" (laser provides voltage using internal source);</li><li>"External" (user provides control via pin in the external connector).</li></ul></div><div class="list-group"><div onclick="window.location.href = '#externalcontrol_analogcontrolsource_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets analog control source configuration.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#externalcontrol_analogcontrolsource_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets new analog control source configuration.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_analogcontrolsource_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/ExternalControl</span>/AnalogControlSource</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets analog control source configuration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_analogcontrolsource_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_analogcontrolsource_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"External"
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_analogcontrolsource_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/ExternalControl</span>/AnalogControlSource</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets new analog control source configuration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_analogcontrolsource_put_request" data-toggle="tab">Request</a></li><li><a href="#externalcontrol_analogcontrolsource_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_analogcontrolsource_put_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"Internal"
</code></pre></div></div><div class="tab-pane" id="externalcontrol_analogcontrolsource_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Configuration is not supported. Should be "Internal" or "External".</li><li>Laser is in a state that forbids setting AnalogControlSource.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_externalcontrol_externalsyncconfiguration"><span class="parent">/ExternalControl</span>/ExternalSyncConfiguration</a> <span class="methods"><a href="#externalcontrol_externalsyncconfiguration_get"><span class="badge badge_get">get</span></a> <a href="#externalcontrol_externalsyncconfiguration_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_externalcontrol_externalsyncconfiguration" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Allows to locks laser pulses to an external frequency generator. Available values are "Disabled", "PpOpensAndClosesAutomatically", "PpClosesOnFrequencyError".</p></div><div class="list-group"><div onclick="window.location.href = '#externalcontrol_externalsyncconfiguration_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets external sync configuration.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#externalcontrol_externalsyncconfiguration_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets new external sync configuration.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_externalsyncconfiguration_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/ExternalControl</span>/ExternalSyncConfiguration</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets external sync configuration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_externalsyncconfiguration_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_externalsyncconfiguration_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"Disabled"
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_externalsyncconfiguration_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/ExternalControl</span>/ExternalSyncConfiguration</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets new external sync configuration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_externalsyncconfiguration_put_request" data-toggle="tab">Request</a></li><li><a href="#externalcontrol_externalsyncconfiguration_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_externalsyncconfiguration_put_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"PpOpensAndClosesAutomatically"
</code></pre></div></div><div class="tab-pane" id="externalcontrol_externalsyncconfiguration_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Configuration is not supported. Should be "Disabled", "PpOpensAndClosesAutomatically" or "PpClosesOnFrequencyError".</li><li>Laser is in a state that forbids setting ExternalSyncConfiguration.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_externalcontrol_fastenergycontrolsource"><span class="parent">/ExternalControl</span>/FastEnergyControlSource</a> <span class="methods"><a href="#externalcontrol_fastenergycontrolsource_get"><span class="badge badge_get">get</span></a> <a href="#externalcontrol_fastenergycontrolsource_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_externalcontrol_fastenergycontrolsource" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Gets fast energy control source configuration. Use only values listed below. FEC feature is optional and depends on laser model.</p><ul><li>"Internal" (laser controls FEC internally. Depending on internal configuration, user may be able to control FEC via /TargetAttenuatorPercentage endpoint in this mode);</li><li>"External" (user provides control via pin in the external connector).</li></ul></div><div class="list-group"><div onclick="window.location.href = '#externalcontrol_fastenergycontrolsource_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets fast energy control source configuration.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#externalcontrol_fastenergycontrolsource_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets new fast energy control source configuration.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_fastenergycontrolsource_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/ExternalControl</span>/FastEnergyControlSource</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets fast energy control source configuration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_fastenergycontrolsource_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_fastenergycontrolsource_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"External"
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_fastenergycontrolsource_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/ExternalControl</span>/FastEnergyControlSource</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets new fast energy control source configuration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_fastenergycontrolsource_put_request" data-toggle="tab">Request</a></li><li><a href="#externalcontrol_fastenergycontrolsource_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_fastenergycontrolsource_put_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"Internal"
</code></pre></div></div><div class="tab-pane" id="externalcontrol_fastenergycontrolsource_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Configuration is not supported. Should be "Internal" or "External".</li><li>Laser is in a state that forbids setting FastEnergyControlSource.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_externalcontrol_hvfastenergycontrolsource"><span class="parent">/ExternalControl</span>/HvFastEnergyControlSource</a> <span class="methods"><a href="#externalcontrol_hvfastenergycontrolsource_get"><span class="badge badge_get">get</span></a> <a href="#externalcontrol_hvfastenergycontrolsource_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_externalcontrol_hvfastenergycontrolsource" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Gets high voltage fast energy control source configuration. Use only values listed below. HVFEC feature is optional and depends on laser model.</p><ul><li>"Internal" (laser controls HVFEC internally. User can control HVFEC via /TargetAttenuatorPercentage endpoint in this mode);</li><li>"External" (user provides control via pin in the external connector).</li></ul></div><div class="list-group"><div onclick="window.location.href = '#externalcontrol_hvfastenergycontrolsource_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets HV fast energy control source configuration.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#externalcontrol_hvfastenergycontrolsource_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets new HV fast energy control source configuration.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_hvfastenergycontrolsource_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/ExternalControl</span>/HvFastEnergyControlSource</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets HV fast energy control source configuration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_hvfastenergycontrolsource_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_hvfastenergycontrolsource_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"External"
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="externalcontrol_hvfastenergycontrolsource_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/ExternalControl</span>/HvFastEnergyControlSource</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets new HV fast energy control source configuration.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#externalcontrol_hvfastenergycontrolsource_put_request" data-toggle="tab">Request</a></li><li><a href="#externalcontrol_hvfastenergycontrolsource_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="externalcontrol_hvfastenergycontrolsource_put_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>"Internal"
</code></pre></div></div><div class="tab-pane" id="externalcontrol_hvfastenergycontrolsource_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Configuration is not supported. Should be "Internal" or "External".</li><li>Laser is in a state that forbids setting HvFastEnergyControlSource.</li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="advanced" class="panel-title">/Advanced</h3></div><div class="panel-body"><div class="top-resource-description"><p>These functions are for advanced use.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced"><span class="parent"></span>/Advanced</a> <span class="methods"><a href="#advanced_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_advanced" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets most of advanced properties that have GET methods. All of them can be queried individually, but sometimes it is more convenient to get them in one batch.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/Advanced</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets most of advanced properties that have GET methods. All of them can be queried individually, but sometimes it is more convenient to get them in one batch.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "ActualStateId": 128,
    "TargetRaFrequency": 0,
    "CurrentStateAsPreset": {
        "HvVoltage": 1130,
        "AttenuatorPercentage": 100,
        "RaFrequency": 120.130226,
        "PpDivider": 1,
        "PhotodiodeOffset": -543,
        "PhotodiodeFactor": 0.000768999977,
        "Harmonic": 0,
        "PpOffTiming": 2932,
        "Name": "Current state",
        "PulseDuration": -224.712677,
        "RaOnDelayTiming": 32,
        "TargetPower": 1,
        "NanosecondMode": false
    },
    "AvailableFeatures": {
        "OptionalFeatures": {
            "HarmonicsModule": {
                "AvailableHarmonics": [
                    {
                        "TurnPpOff": true,
                        "HasPhotodiode": true,
                        "UsesSolenoids": false,
                        "Number": 1
                    },
                    {
                        "TurnPpOff": false,
                        "HasPhotodiode": true,
                        "UsesSolenoids": false,
                        "Number": 2
                    },
                    {
                        "TurnPpOff": true,
                        "HasPhotodiode": true,
                        "UsesSolenoids": false,
                        "Number": 3
                    }
                ]
            },
            "Attenuation": {
                "AvailableAttenuators": [
                    {
                        "IsMaster": true,
                        "Type": "AOM"
                    },
                    {
                        "IsMaster": false,
                        "Type": "Integrated"
                    },
                    {
                        "IsMaster": false,
                        "Type": "DirectCurrent"
                    },
                    {
                        "IsMaster": false,
                        "Type": "HarmonicsWaveplate1"
                    }
                ]
            }
        },
        "PermanentFeatures": [
            "OptionalFeatures-1.0.0",
            "Stama2-1.0.0",
            "GlobalWarnings-1.0.0",
            "SettingsJson-1.0.0",
            "HighLevelPresets-1.0.1",
            "AccessController-1.0.0",
            "ForbiddenFrequencies-1.0.0",
            "XbxConfigurator-1.0.0"
        ]
    },
    "ActualRaFrequency": 120.130226,
    "IsPpEnabled": false,
    "IsRemoteInterlockActive": false,
    "IsInNanosecondMode": false,
    "AttenuatorPercentageRange": {
        "To": 100,
        "From": 48
    }
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_actualstateid"><span class="parent">/Advanced</span>/ActualStateId</a> <span class="methods"><a href="#advanced_actualstateid_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_advanced_actualstateid" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Each state of CARBIDE state machine has a numerical ID assigned.</p><ul><li>StandingBy = 1</li><li>Service = 2</li><li>InFieldUpdate = 4</li><li>Initializing = 8</li><li>GoingToStandby = 16</li><li>Failure = 32</li><li>Housekeeping = 64</li><li>Operational = 128</li></ul></div><div class="list-group"><div onclick="window.location.href = '#advanced_actualstateid_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets numerical representation of Carbide state.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_actualstateid_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Advanced</span>/ActualStateId</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets numerical representation of Carbide state.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_actualstateid_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_actualstateid_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>128
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_availablefeatures"><span class="parent">/Advanced</span>/AvailableFeatures</a> <span class="methods"><a href="#advanced_availablefeatures_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_advanced_availablefeatures" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>This endpoint is mostly for CARBIDE User App, as it is supposed to support many different CARBIDE lasers with different feature set. From client perspective, this endpoint is probably of little value, but some useful information may still be retrieved (for example, list of available harmonics).</p></div><div class="list-group"><div onclick="window.location.href = '#advanced_availablefeatures_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets available Carbide features.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_availablefeatures_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Advanced</span>/AvailableFeatures</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets available Carbide features.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_availablefeatures_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_availablefeatures_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "OptionalFeatures": {
        "HarmonicsModule": {
            "AvailableHarmonics": [
                {
                    "TurnPpOff": true,
                    "HasPhotodiode": true,
                    "UsesSolenoids": false,
                    "Number": 1
                },
                {
                    "TurnPpOff": false,
                    "HasPhotodiode": true,
                    "UsesSolenoids": false,
                    "Number": 2
                },
                {
                    "TurnPpOff": true,
                    "HasPhotodiode": true,
                    "UsesSolenoids": false,
                    "Number": 3
                }
            ]
        },
        "Attenuation": {
            "AvailableAttenuators": [
                {
                    "IsMaster": true,
                    "Type": "AOM"
                },
                {
                    "IsMaster": false,
                    "Type": "Integrated"
                },
                {
                    "IsMaster": false,
                    "Type": "DirectCurrent"
                },
                {
                    "IsMaster": false,
                    "Type": "HarmonicsWaveplate1"
                }
            ]
        }
    },
    "PermanentFeatures": [
        "OptionalFeatures-1.0.0",
        "Stama2-1.0.0",
        "GlobalWarnings-1.0.0",
        "SettingsJson-1.0.0",
        "HighLevelPresets-1.0.1",
        "AccessController-1.0.0",
        "ForbiddenFrequencies-1.0.0",
        "XbxConfigurator-1.0.0"
    ]
}

</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_availableattenuatorpercentagerange"><span class="parent">/Advanced</span>/AvailableAttenuatorPercentageRange</a> <span class="methods"><a href="#advanced_availableattenuatorpercentagerange_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_advanced_availableattenuatorpercentagerange" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_availableattenuatorpercentagerange_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets range in which attenuator can work.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_availableattenuatorpercentagerange_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Advanced</span>/AvailableAttenuatorPercentageRange</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets range in which attenuator can work.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_availableattenuatorpercentagerange_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_availableattenuatorpercentagerange_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Available attenuation range is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "To": 100,
    "From": 0
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_currentstateaspreset"><span class="parent">/Advanced</span>/CurrentStateAsPreset</a> <span class="methods"><a href="#advanced_currentstateaspreset_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_advanced_currentstateaspreset" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>This endpoit is mostly used by CARBIDE User App to generate presets.</p></div><div class="list-group"><div onclick="window.location.href = '#advanced_currentstateaspreset_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets current laser state in form of a single preset.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_currentstateaspreset_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Advanced</span>/CurrentStateAsPreset</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets current laser state in form of a single preset.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_currentstateaspreset_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_currentstateaspreset_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "HvVoltage": 1130,
    "AttenuatorPercentage": 100,
    "RaFrequency": 120.130226,
    "PpDivider": 1,
    "PhotodiodeOffset": -543,
    "PhotodiodeFactor": 0.000768999977,
    "Harmonic": 0,
    "PpOffTiming": 2932,
    "Name": "Current state",
    "PulseDuration": -224.712677,
    "RaOnDelayTiming": 32,
    "TargetPower": 1,
    "NanosecondMode": false
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_actualrafrequency"><span class="parent">/Advanced</span>/ActualRaFrequency</a> <span class="methods"><a href="#advanced_actualrafrequency_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_advanced_actualrafrequency" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_actualrafrequency_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets raw RA frequency (repetition rate) in kHz, not taking into account PP divider.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_actualrafrequency_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Advanced</span>/ActualRaFrequency</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets raw RA frequency (repetition rate) in kHz, not taking into account PP divider.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_actualrafrequency_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_actualrafrequency_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>200.100
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_targetrafrequency"><span class="parent">/Advanced</span>/TargetRaFrequency</a> <span class="methods"><a href="#advanced_targetrafrequency_get"><span class="badge badge_get">get</span></a> <a href="#advanced_targetrafrequency_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_advanced_targetrafrequency" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Although presets is the preferred way of operation, RA frequency can still be adjusted manually over a wide range without stopping pulse generation. Note that large changes requires some time for the output to settle down (around 30 minutes, give or take). Also, other parameters (timings, photodiode calibration constants, etc.) may also require adjustment.</p></div><div class="list-group"><div onclick="window.location.href = '#advanced_targetrafrequency_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets target RA frequency (repetition rate) in kHz, not taking into account PP divider.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#advanced_targetrafrequency_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets target RA frequency (repetition rate) in kHz, not taking into account PP divider.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_targetrafrequency_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Advanced</span>/TargetRaFrequency</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets target RA frequency (repetition rate) in kHz, not taking into account PP divider.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_targetrafrequency_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_targetrafrequency_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_targetrafrequency_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Advanced</span>/TargetRaFrequency</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets target RA frequency (repetition rate) in kHz, not taking into account PP divider.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_targetrafrequency_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_targetrafrequency_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Target frequency is out of bounds.</li><li>Laser is in a state that forbids setting RA frequency.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_isppenabled"><span class="parent">/Advanced</span>/IsPpEnabled</a> <span class="methods"><a href="#advanced_isppenabled_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_advanced_isppenabled" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_isppenabled_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets whether pulse picker is currently enabled or not.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_isppenabled_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Advanced</span>/IsPpEnabled</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets whether pulse picker is currently enabled or not.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_isppenabled_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_isppenabled_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Pulse picker state is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>true
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_enablepp"><span class="parent">/Advanced</span>/EnablePp</a> <span class="methods"><a href="#advanced_enablepp_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_advanced_enablepp" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_enablepp_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Enables pulse picker.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_enablepp_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/Advanced</span>/EnablePp</h4></div><div class="modal-body"><div class="alert alert-info"><p>Enables pulse picker.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_enablepp_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_enablepp_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Laser is in a state that forbids enabling pulse picker.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_disablepp"><span class="parent">/Advanced</span>/DisablePp</a> <span class="methods"><a href="#advanced_disablepp_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_advanced_disablepp" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_disablepp_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Disables pulse picker.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_disablepp_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/Advanced</span>/DisablePp</h4></div><div class="modal-body"><div class="alert alert-info"><p>Disables pulse picker.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_disablepp_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_disablepp_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Laser is in a state that forbits disabling pulse picker.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_presets"><span class="parent">/Advanced</span>/Presets</a> <span class="methods"><a href="#advanced_presets_get"><span class="badge badge_get">get</span></a> <a href="#advanced_presets_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_advanced_presets" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_presets_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets list of available laser presets.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#advanced_presets_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets new presets list.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_presets_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Advanced</span>/Presets</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets list of available laser presets.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_presets_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_presets_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
    {
        "HvVoltage": 1130,
        "AttenuatorPercentage": 100,
        "RaFrequency": 120.130203,
        "PpDivider": 1,
        "PhotodiodeOffset": -543,
        "PhotodiodeFactor": 0.000768999977,
        "Harmonic": 1,
        "PpOffTiming": 2932,
        "Name": "Default",
        "PulseDuration": -222,
        "RaOnDelayTiming": 32,
        "TargetPower": 1
    },
    {
        "HvVoltage": 1130,
        "AttenuatorPercentage": 100,
        "RaFrequency": 120.130203,
        "PpDivider": 1,
        "PhotodiodeOffset": -543,
        "PhotodiodeFactor": 0.000768999977,
        "Harmonic": 2,
        "PpOffTiming": 2932,
        "Name": "Another preset",
        "PulseDuration": -222,
        "RaOnDelayTiming": 32,
        "TargetPower": 1.5
    },
    {
        "HvVoltage": 1131,
        "AttenuatorPercentage": 50,
        "RaFrequency": 120.130203,
        "PpDivider": 1,
        "PhotodiodeOffset": -543,
        "PhotodiodeFactor": 0.000768999977,
        "Harmonic": 1,
        "PpOffTiming": 2932,
        "Name": "Custom preset",
        "PulseDuration": -222,
        "RaOnDelayTiming": 32,
        "TargetPower": 1
    }
]
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_presets_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Advanced</span>/Presets</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets new presets list.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_presets_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_presets_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. New presets list is now saved in Carbide memory and ready to execute.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Incorrect presets received.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_reduceleak"><span class="parent">/Advanced</span>/ReduceLeak</a> <span class="methods"><a href="#advanced_reduceleak_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_advanced_reduceleak" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_reduceleak_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Initiates PP leak reducing algorithm, which tries to adjust timing parameters automatically. It usually takes up to 2 seconds. Note that results are susceptible to thermal drift; we recommend to run laser at target power for two hours prior to triggering leak reducing procedure, and then give an hour afterwards for the results to fully stabilize. Exact settle-down time highly depends on situation.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_reduceleak_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/Advanced</span>/ReduceLeak</h4></div><div class="modal-body"><div class="alert alert-info"><p>Initiates PP leak reducing algorithm, which tries to adjust timing parameters automatically. It usually takes up to 2 seconds. Note that results are susceptible to thermal drift; we recommend to run laser at target power for two hours prior to triggering leak reducing procedure, and then give an hour afterwards for the results to fully stabilize. Exact settle-down time highly depends on situation.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_reduceleak_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_reduceleak_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Leak reducing procedure has been initiated.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Laser is in a state that forbids trigerring leak reducer.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_isremoteinterlockactive"><span class="parent">/Advanced</span>/IsRemoteInterlockActive</a> <span class="methods"><a href="#advanced_isremoteinterlockactive_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_advanced_isremoteinterlockactive" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_isremoteinterlockactive_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets whether remote interlock is currently active or not.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_isremoteinterlockactive_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Advanced</span>/IsRemoteInterlockActive</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets whether remote interlock is currently active or not.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_isremoteinterlockactive_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_isremoteinterlockactive_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Remote interlock state is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>true
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_resetremoteinterlock"><span class="parent">/Advanced</span>/ResetRemoteInterlock</a> <span class="methods"><a href="#advanced_resetremoteinterlock_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_advanced_resetremoteinterlock" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_resetremoteinterlock_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Resets remote interlock.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_resetremoteinterlock_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/Advanced</span>/ResetRemoteInterlock</h4></div><div class="modal-body"><div class="alert alert-info"><p>Resets remote interlock.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_resetremoteinterlock_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_resetremoteinterlock_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Laser is in a state that forbids resetting remote interlock.</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_advanced_isinnanosecondmode"><span class="parent">/Advanced</span>/IsInNanosecondMode</a> <span class="methods"><a href="#advanced_isinnanosecondmode_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_advanced_isinnanosecondmode" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#advanced_isinnanosecondmode_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets whether nanosecond mode is currently active or not. If nanosecond mode is active, moving compressor (changing pulse duration) will have no effect. Therefore, you should ignore compressor endpoints completely while working in this mode. Generally, Carbide will produce ~15ns pulses while in nanosecond mode.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="advanced_isinnanosecondmode_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Advanced</span>/IsInNanosecondMode</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets whether nanosecond mode is currently active or not. If nanosecond mode is active, moving compressor (changing pulse duration) will have no effect. Therefore, you should ignore compressor endpoints completely while working in this mode. Generally, Carbide will produce ~15ns pulses while in nanosecond mode.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#advanced_isinnanosecondmode_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="advanced_isinnanosecondmode_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful. Nanosecond mode state is in the body of the response.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>true
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="burst" class="panel-title">/Burst</h3></div><div class="panel-body"><div class="top-resource-description"><p>Defines functionality related to CARBIDE CB3-burst. Ignore these endpoints if your laser doesn&#39;t have burst feature.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_burst"><span class="parent"></span>/Burst</a> <span class="methods"><a href="#burst_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_burst" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#burst_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets all burst properties that have GET methods. All of them can be queried individually, but sometimes it is more convenient to get them all in one batch.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/Burst</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets all burst properties that have GET methods. All of them can be queried individually, but sometimes it is more convenient to get them all in one batch.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
    "ActualParameterP": 5,
    "ActualParameterN": 4,
    "TargetParameterP": 5,
    "TargetParameterN": 4,
    "ActualEnvelopeParameterP": 0.1,
    "ActualEnvelopeParameterN": 0.5,
    "TargetEnvelopeParameterP": 0.1,
    "TargetEnvelopeParameterN": 0.5
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_burst_actualparameterp"><span class="parent">/Burst</span>/ActualParameterP</a> <span class="methods"><a href="#burst_actualparameterp_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_burst_actualparameterp" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#burst_actualparameterp_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual number of pulses in picosecond pulse group.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_actualparameterp_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Burst</span>/ActualParameterP</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual number of pulses in picosecond pulse group.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_actualparameterp_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_actualparameterp_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>1
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_burst_actualparametern"><span class="parent">/Burst</span>/ActualParameterN</a> <span class="methods"><a href="#burst_actualparametern_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_burst_actualparametern" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#burst_actualparametern_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual number of pulses in nanosecond pulse group.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_actualparametern_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Burst</span>/ActualParameterN</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual number of pulses in nanosecond pulse group.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_actualparametern_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_actualparametern_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>1
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_burst_targetparameterp"><span class="parent">/Burst</span>/TargetParameterP</a> <span class="methods"><a href="#burst_targetparameterp_get"><span class="badge badge_get">get</span></a> <a href="#burst_targetparameterp_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_burst_targetparameterp" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#burst_targetparameterp_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets target number of pulses in picosecond pulse group.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#burst_targetparameterp_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets new target number of pulses in picosecond pulse group.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_targetparameterp_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Burst</span>/TargetParameterP</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets target number of pulses in picosecond pulse group.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_targetparameterp_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_targetparameterp_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>1
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_targetparameterp_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Burst</span>/TargetParameterP</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets new target number of pulses in picosecond pulse group.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_targetparameterp_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_targetparameterp_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Laser is in a state that forbids setting this parameter.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_burst_targetparametern"><span class="parent">/Burst</span>/TargetParameterN</a> <span class="methods"><a href="#burst_targetparametern_get"><span class="badge badge_get">get</span></a> <a href="#burst_targetparametern_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_burst_targetparametern" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#burst_targetparametern_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets target number of pulses in nanosecond pulse group.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#burst_targetparametern_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets new target number of pulses in nanosecond pulse group.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_targetparametern_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Burst</span>/TargetParameterN</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets target number of pulses in nanosecond pulse group.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_targetparametern_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_targetparametern_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>1
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_targetparametern_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Burst</span>/TargetParameterN</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets new target number of pulses in nanosecond pulse group.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_targetparametern_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_targetparametern_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Laser is in a state that forbids setting this parameter.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_burst_actualenvelopeparameterp"><span class="parent">/Burst</span>/ActualEnvelopeParameterP</a> <span class="methods"><a href="#burst_actualenvelopeparameterp_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_burst_actualenvelopeparameterp" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#burst_actualenvelopeparameterp_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual picosecond burst group envelope control parameter.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_actualenvelopeparameterp_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Burst</span>/ActualEnvelopeParameterP</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual picosecond burst group envelope control parameter.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_actualenvelopeparameterp_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_actualenvelopeparameterp_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>0.5
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_burst_actualenvelopeparametern"><span class="parent">/Burst</span>/ActualEnvelopeParameterN</a> <span class="methods"><a href="#burst_actualenvelopeparametern_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_burst_actualenvelopeparametern" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#burst_actualenvelopeparametern_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets actual nanosecond burst group envelope control parameter.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_actualenvelopeparametern_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Burst</span>/ActualEnvelopeParameterN</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets actual nanosecond burst group envelope control parameter.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_actualenvelopeparametern_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_actualenvelopeparametern_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>-0.5
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_burst_targetenvelopeparameterp"><span class="parent">/Burst</span>/TargetEnvelopeParameterP</a> <span class="methods"><a href="#burst_targetenvelopeparameterp_get"><span class="badge badge_get">get</span></a> <a href="#burst_targetenvelopeparameterp_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_burst_targetenvelopeparameterp" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#burst_targetenvelopeparameterp_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets target picosecond burst group envelope control parameter.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#burst_targetenvelopeparameterp_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets new target picosecond burst group envelope control parameter. Accepted value is from -1.0 to 1.0.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_targetenvelopeparameterp_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Burst</span>/TargetEnvelopeParameterP</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets target picosecond burst group envelope control parameter.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_targetenvelopeparameterp_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_targetenvelopeparameterp_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>0.5
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_targetenvelopeparameterp_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Burst</span>/TargetEnvelopeParameterP</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets new target picosecond burst group envelope control parameter. Accepted value is from -1.0 to 1.0.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_targetenvelopeparameterp_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_targetenvelopeparameterp_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Laser is in a state that forbids setting this parameter.</li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_burst_targetenvelopeparametern"><span class="parent">/Burst</span>/TargetEnvelopeParameterN</a> <span class="methods"><a href="#burst_targetenvelopeparametern_get"><span class="badge badge_get">get</span></a> <a href="#burst_targetenvelopeparametern_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel_burst_targetenvelopeparametern" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#burst_targetenvelopeparametern_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Gets target nanosecond burst group envelope control parameter.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#burst_targetenvelopeparametern_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Sets new target nanosecond burst group envelope control parameter. Accepted value is from -1.0 to 1.0.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_targetenvelopeparametern_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Burst</span>/TargetEnvelopeParameterN</h4></div><div class="modal-body"><div class="alert alert-info"><p>Gets target nanosecond burst group envelope control parameter.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_targetenvelopeparametern_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_targetenvelopeparametern_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>-0.5
</code></pre></div></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="burst_targetenvelopeparametern_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/Burst</span>/TargetEnvelopeParameterN</h4></div><div class="modal-body"><div class="alert alert-info"><p>Sets new target nanosecond burst group envelope control parameter. Accepted value is from -1.0 to 1.0.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#burst_targetenvelopeparametern_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="burst_targetenvelopeparametern_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Operation successful.</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><ul><li>Laser is in a state that forbids setting tis parameter.</li></ul></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#basic">/Basic</a></li><li><a href="#stretchercompressor">/StretcherCompressor</a></li><li><a href="#externalcontrol">/ExternalControl</a></li><li><a href="#advanced">/Advanced</a></li><li><a href="#burst">/Burst</a></li></ul></div></div></div></div></body></html>