forked from onvif/specs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
DeviceIo.xml
1192 lines (1192 loc) · 52.8 KB
/
DeviceIo.xml
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
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<?xml-stylesheet href="docbook.xsl" type="text/xsl" ?>
<book xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
<title>Device IO Service Specification</title>
<titleabbrev>Device-IO</titleabbrev>
<releaseinfo>22.06</releaseinfo>
<author>
<orgname>ONVIF™</orgname>
<uri>www.onvif.org</uri>
</author>
<pubdate>June, 2022</pubdate>
<mediaobject>
<imageobject>
<imagedata fileref="media/logo.png" contentwidth="60mm" />
</imageobject>
</mediaobject>
<copyright>
<year>2008-2022</year>
<holder>ONVIF™ All rights reserved.</holder>
</copyright>
<legalnotice>
<para>Recipients of this document may copy, distribute, publish, or display this document so long as this copyright notice, license and disclaimer are retained with all copies of the document. No license is granted to modify this document.</para>
<para>THIS DOCUMENT IS PROVIDED "AS IS," AND THE CORPORATION AND ITS MEMBERS AND THEIR AFFILIATES, MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THIS DOCUMENT ARE SUITABLE FOR ANY PURPOSE; OR THAT THE IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.</para>
<para>IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT, WHETHER OR NOT (1) THE CORPORATION, MEMBERS OR THEIR AFFILIATES HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR (2) SUCH DAMAGES WERE REASONABLY FORESEEABLE, AND ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT. THE FOREGOING DISCLAIMER AND LIMITATION ON LIABILITY DO NOT APPLY TO, INVALIDATE, OR LIMIT REPRESENTATIONS AND WARRANTIES MADE BY THE MEMBERS AND THEIR RESPECTIVE AFFILIATES TO THE CORPORATION AND OTHER MEMBERS IN CERTAIN WRITTEN POLICIES OF THE CORPORATION.</para>
</legalnotice>
<revhistory>
<revision>
<revnumber>2.1</revnumber>
<date>Jul-2011</date>
<author>
<personname>Hans Busch</personname>
</author>
<revremark>Split from Core 2.0
Change Request 232</revremark>
</revision>
<revision>
<revnumber>2.1.1</revnumber>
<date>Jan-2012</date>
<author>
<personname>Hans Busch</personname>
</author>
<revremark>Change Requests 259, 291, 535</revremark>
</revision>
<revision>
<revnumber>2.2</revnumber>
<date>May-2012</date>
<author>
<personname>M.Tonomura</personname>
</author>
<revremark>Add serial port function</revremark>
</revision>
<revision>
<revnumber>2.2.1</revnumber>
<date>Dec-2012</date>
<author>
<personname>Hans Busch</personname>
</author>
<revremark>Change Request 708</revremark>
</revision>
<revision>
<revnumber>2.4.1</revnumber>
<date>Dec-2013</date>
<author>
<personname>Michio Hirai</personname>
</author>
<revremark>Change Request 1217</revremark>
</revision>
<revision>
<revnumber>2.5</revnumber>
<date>Dec-2014</date>
<author>
<personname>Michio Hirai</personname>
</author>
<revremark>Change Request 1492, 1516</revremark>
</revision>
<revision>
<revnumber>2.6</revnumber>
<date>Jun-2015</date>
<author>
<personname>Michio Hirai</personname>
</author>
<revremark>Change Request 1589, 1639, 1642</revremark>
</revision>
<revision>
<revnumber>2.6.1</revnumber>
<date>Aug-2015</date>
<author>
<personname>Tom Yui</personname>
</author>
<author>
<personname>Hans Busch</personname>
</author>
<revremark>Add Digital Input Configuration
Change Request 1633</revremark>
</revision>
<revision>
<revnumber>16.06</revnumber>
<date>Jun-2016</date>
<author>
<personname>Hiroyuki Sano</personname>
</author>
<revremark>Change Request 1802, 1853</revremark>
</revision>
<revision>
<revnumber>16.12</revnumber>
<date>Dec-2016</date>
<author>
<personname>Hiroyuki Sano</personname>
</author>
<revremark>Change Request 1985</revremark>
</revision>
<revision>
<revnumber>17.06</revnumber>
<date>Jun-2017</date>
<author>
<personname>Hans Busch</personname>
</author>
<author>
<personname>Hiroyuki Sano</personname>
</author>
<revremark>Update method layouts.
Change Request 1843, 2046
Change Request 2065</revremark>
</revision>
<revision>
<revnumber>17.12</revnumber>
<date>Dec-2017</date>
<author>
<personname>Hiroyuki Sano</personname>
</author>
<revremark>Change Request 2212, 2213</revremark>
</revision>
<revision>
<revnumber>18.12</revnumber>
<date>Dec-2018</date>
<author>
<personname>Hiroyuki Sano</personname>
</author>
<revremark>Change Request 2372</revremark>
</revision>
<revision>
<revnumber>19.06</revnumber>
<date>Jun-2019</date>
<author>
<personname>Hiroyuki Sano</personname>
</author>
<revremark>Change Request 2454</revremark>
</revision>
<revision>
<revnumber>22.06</revnumber>
<date>Jun-2022</date>
<author>
<personname>Sergey Bogdanov</personname>
</author>
<revremark>Rename sections to show real name of service command.</revremark>
</revision>
</revhistory>
</info>
<chapter>
<title>Scope</title>
<para>This document defines the web service interface for all physical inputs and outputs. For most inputs and outputs this is a pure get interface while for e.g. relays also configuration and control is include.</para>
<para>Web service usage is outside of the scope of this document. Please refer to the ONVIF core specification.</para>
</chapter>
<chapter>
<title>Normative references</title>
<para>ONVIF Core Specification</para>
<para role="reference"><<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.onvif.org/specs/core/ONVIF-Core-Specification.pdf"></link>></para>
</chapter>
<chapter>
<title>Terms and Definitions</title>
<section>
<title>Definitions</title>
<informaltable>
<tgroup cols="2">
<colspec colname="c1" colwidth="24*" />
<colspec colname="c2" colwidth="76*" />
<tbody valign="top">
<row>
<entry align="left">
<para>
<emphasis role="bold">Input/Output (I/O)</emphasis>
</para>
</entry>
<entry align="left">
<para>Currently relay ports and Video/Audio Inputs/Outputs are handled.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</chapter>
<chapter>
<title>Overview</title>
<para>The DevideIO service offers commands to retrieve and configure the settings of physical inputs and outputs of a device. </para>
<para>The DeviceIO service supports the configuration of the following device interfaces:</para>
<itemizedlist>
<listitem>
<para>VideoOutputs</para>
</listitem>
<listitem>
<para>RelayOutputs</para>
</listitem>
<listitem>
<para>DigitalInputs</para>
</listitem>
<listitem>
<para>Send and/or Receive serial data communication</para>
</listitem>
</itemizedlist>
<para>The following commands list existing interfaces:</para>
<itemizedlist>
<listitem>
<para>GetVideoOutputs – Gets all existing video outputs of the device.</para>
</listitem>
<listitem>
<para>GetVideoSources – Gets all existing video sources of the device.</para>
</listitem>
<listitem>
<para>GetAudioOutputs – Gets all existing audio outputs of the device.</para>
</listitem>
<listitem>
<para>GetAudioSources – Gets all existing audio sources of the device</para>
</listitem>
<listitem>
<para>GetRelayOutputs– Gets all existing relay outputs of the device</para>
</listitem>
<listitem>
<para>GetDigitalInputs – Gets all existing digital inputs of the device</para>
</listitem>
<listitem>
<para>GetSerialPorts - Gets a list of all available serial ports and their settings.</para>
</listitem>
</itemizedlist>
<para>For VideoOutputs the following commands are supported:</para>
<itemizedlist>
<listitem>
<para>
<emphasis>Set<device name>Configuration</emphasis> – Modifies the configuration of a specific interface.</para>
</listitem>
<listitem>
<para>
<emphasis>Get< device name >Configuration</emphasis> – Gets the configuration of a specific interface.</para>
</listitem>
<listitem>
<para>
<emphasis>Get< device name >ConfigurationOptions</emphasis> – Gets the supported property values for a specific interface.</para>
</listitem>
</itemizedlist>
<para>RelayOutputs supports following commands:</para>
<itemizedlist>
<listitem>
<para>
<phrase>SetRelayOutputSettings</phrase> – Modifies the configuration of a relay output</para>
</listitem>
<listitem>
<para>SetRelayOutputState – Sets the logical state</para>
</listitem>
</itemizedlist>
<para>SerialPorts additionally support the following command:</para>
<itemizedlist>
<listitem>
<para>Send and/or Receive serial command - Transmit/receive generic controlling data to/from a serial device</para>
</listitem>
</itemizedlist>
<para>WSDL for the DeviceIO service is specified in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.onvif.org/ver10/deviceio.wsdl">http://www.onvif.org/ver10/deviceio.wsdl</link>.</para>
<table>
<title>Referenced namespaces (with prefix)</title>
<tgroup cols="2">
<colspec colname="c1" colwidth="13*" />
<colspec colname="c2" colwidth="87*" />
<thead>
<row>
<entry>
<para>Prefix</para>
</entry>
<entry>
<para>Namespace URI</para>
</entry>
</row>
</thead>
<tbody valign="top">
<row>
<entry>
<para>env</para>
</entry>
<entry>
<para>http://www.w3.org/2003/05/soap-envelope</para>
</entry>
</row>
<row>
<entry>
<para>ter</para>
</entry>
<entry>
<para>http://www.onvif.org/ver10/error</para>
</entry>
</row>
<row>
<entry>
<para>xs </para>
</entry>
<entry>
<para>http://www.w3.org/2001/XMLSchema </para>
</entry>
</row>
<row>
<entry>
<para>tt</para>
</entry>
<entry>
<para>http://www.onvif.org/ver10/schema</para>
</entry>
</row>
<row>
<entry>
<para>tmd</para>
</entry>
<entry>
<para>http://www.onvif.org/ver10/deviceIO/wsdl</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</chapter>
<chapter>
<title>Service</title>
<para>This service offers commands to retrieve and configure the physical Inputs and Outputs of a device. </para>
<para>Commands to request the available video and audio in- and outputs are defined as well as commands to request the available relays. This service also offers functions to request and change the configuration of these entities. </para>
<para>A device that has physical sources and outputs SHALL support this service as described in [DeviceIOService.wsdl].</para>
<section>
<title>VideoOutputs</title>
<para>The VideoOutput type represents the physical Video Outputs of a device that can be connected to a monitor to display the video signal. The structure contains the Layout Settings that can be configured using the Display Service.</para>
<section>
<title>GetVideoOutputs</title>
<para>This command lists all available video outputs of a device. A device that has one or more physical video outputs shall support listing of available video outputs through the GetVideoOutputs command. </para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">Token - optional, unbounded [tt:ReferenceToken]</para>
<para role="text">List of tokens enumerating all available video outputs of the device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="text">None</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_MEDIA</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<section>
<title>VideoOutputConfiguration</title>
<section>
<title>GetVideoOutputConfiguration</title>
<para>This operation requests the configuration of a Video Output. A device that has one or more Video Outputs shall support the retrieval of the VideoOutputConfiguration through this command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">VideoOutputToken [tt:ReferenceToken]</para>
<para role="text">Existing reference of a video output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">Configuration [tt:VideoOutputConfiguration]</para>
<para role="text">The configuration of the video output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:NoVideoOutput</para>
<para role="text">The requested Video Output does not exist.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_MEDIA</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>SetVideoOutputConfiguration</title>
<para>This operation modifies a video output configuration. A device that has one or more video outputs shall support the setting of its video output configuration through this command. </para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">Configuration [tt:VideoOutputConfiguration]</para>
<para role="text">The configuration of the video output.</para>
<para role="param">ForcePersistence [xs:boolean]</para>
<para role="text">Deprecated modifier for temporary settings if supported by the device. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:NoVideoOutput</para>
<para role="text">The requested Video Output does not exist.</para>
<para role="param">env:Sender - ter:InvalidArgVal - ter:<phrase>ConfigModify</phrase></para>
<para role="text">The configuration parameters are not possible to set.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">ACTUATE</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>GetVideoOutputConfigurationOptions</title>
<para>This operation requests the VideoOutputConfigurationOptions of a VideoOutput. A device that has one or more video outputs shall support the retrieval of VideoOutputConfigurationOptions through this command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">VideoOutputToken [tt:ReferenceToken]</para>
<para role="text">Existing reference of a video output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">VideoOutputOptions [tt:VideoOutputConfigurationOptions]</para>
<para role="text">The configuration options for the video output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:NoVideoOutput</para>
<para role="text">The requested Video Output does not exist.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<section>
<title>VideoSources</title>
<para>A VideoSource represents physical video input. The structure contains the pixel resolution of the video, framerate and imaging settings. The imaging settings can be manipulated through the ImagingService if supported and contains parameters for focus, exposure and brightness, for example. </para>
<section>
<title>GetVideoSources</title>
<para>This operation lists all available video sources for the device. The device that has one or more video inputs shall support the listing of available video sources through the GetVideoSources command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">Token - optional, unbounded [tt:ReferenceToken]</para>
<para role="text">List of tokens enumerating all available video sources of the device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="text">None</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_MEDIA</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<section>
<title>AudioOutputs</title>
<para>The Audio Output represents the physical audio outputs that can be connected to a loudspeaker. </para>
<section>
<title>GetAudioOutputs</title>
<para>This command lists all available audio outputs of a device. A device that has one or more physical audio outputs shall support listing of available audio outputs through the GetAudioOutputs command. </para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">Token - optional, unbounded [tt:ReferenceToken]</para>
<para role="text">List of tokens enumerating all available audio outputs of the device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="text">None</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_MEDIA</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<section>
<title>AudioSources</title>
<para>An AudioSource represents unencoded audio input and states the number of input channels</para>
<section>
<title>GetAudioSources</title>
<para>This operation lists all available audio sources for the device. The device that has one or more audio sources shall support the listing of available audio inputs through the GetAudioSources command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">Token - optional, unbounded [tt:ReferenceToken]</para>
<para role="text">List of tokens enumerating all available audio sources of the device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="text">None</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_MEDIA</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<section>
<title>Relay Outputs</title>
<para>The Input/Output (I/O) commands are used to control the state or observe the status of the I/O ports. If the device has I/O ports, then it shall support the I/O commands.</para>
<para>Handling of relay outputs is also defined in DeviceManagement, see ONVIF Core Specification section Input/Output. </para>
<section>
<title>GetRelayOutputs</title>
<para>This operation gets a list of all available relay outputs and their settings.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">RelayOutputs - optional, unbounded [tt:RelayOutput]</para>
<para role="text">List of tokens enumerating all available digital outputs of the device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="text">None</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_MEDIA</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>GetRelayOutputOptions</title>
<para>Request the available settings and ranges for one or all relay outputs. The method shall return the information for exactly one output when a RelayOutputToken is provided as request parameter. Otherwise the method shall return the information for all relay outputs.</para>
<para>A device that has one or more RelayOutputs should support this command.</para>
<para>Two examples:</para>
<orderedlist startingnumber="2">
<listitem>
<para>Device supports PT1S to PT120S:</para>
<para><tmd:RelayOutputOptions token='44'></para>
<para> <tmd:Mode>Monostable</tmd:Mode></para>
<para> <tmd:DelayTimes>1 120</tmd:DelayTimes></para>
<para></tmd:RelayOutputOptions></para>
</listitem>
</orderedlist>
<para>2) Device supports values PT0.5S, PT1S, PT2s and PT1M:</para>
<para><tmd:RelayOutputOptions token='123'></para>
<para> <tmd:Mode>Monostable</tmd:Mode></para>
<para> <tmd:DelayTimes Discrete='True'>0.5 1 2 60</tmd:DelayTimes></para>
<para></tmd:RelayOutputOptions></para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">RelayOutputToken - optional [tt:ReferenceToken]</para>
<para role="text">Optional token reference to the requested relay output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">RelayOutputOptions - optional, unbounded [tt:RelayOutputOptions]</para>
<para role="text">List of options available for the relay outputs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="text">None</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">PRE_AUTH</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>SetRelayOutputSettings</title>
<para>This operation sets the settings of a relay output.</para>
<para>The relay can work in two relay modes:</para>
<itemizedlist>
<listitem>
<para>Bistable – After setting the state, the relay remains in this state.</para>
</listitem>
<listitem>
<para>Monostable – After setting the state, the relay returns to its idle state after the specified time.</para>
</listitem>
</itemizedlist>
<para>The physical idle state of a relay output can be configured by setting the IdleState to ‘open’ or ‘closed’ (inversion of the relay behaviour). </para>
<para>Idle State ‘open’ means that the relay is open when the relay state is set to ‘inactive’ through the trigger command (see Section <xref linkend="_Ref296934565" />) and closed when the state is set to ‘active’ through the same command.</para>
<para>Idle State ‘closed’ means, that the relay is closed when the relay state is set to ‘inactive’ through the trigger command (see Section <xref linkend="_Ref296934565" />) and open when the state is set to ‘active’ through the same command.</para>
<para>The Duration parameter of the Properties field “DelayTime” describes the time after which the relay returns to its idle state if it is in monostable mode. If the relay is set to bistable mode the value of the parameter shall be ignored.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">RelayOutputToken [tt:ReferenceToken]</para>
<para role="text">Token reference to the requested relay output.</para>
<para role="param">RelayOutputSettings [tt:RelayOutputSettings]</para>
<para role="text">The settings to be applied to the relay output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:RelayToken</para>
<para role="text">Unknown relay token reference.</para>
<para role="param">env:Sender - ter:InvalidArgVal - ter:ModeError</para>
<para role="text">Monostable delay time not valid</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">ACTUATE</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="_Ref296934565">
<title>SetRelayOutputState</title>
<para>This operation triggers a relay output<footnote xml:id="__FN1__"><para>There is no GetRelayState command; the current logical state of the relay output is transmitted via notification and their properties.</para></footnote>.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">RelayOutputToken [tt:ReferenceToken]</para>
<para role="text">Token reference to the requested relay output.</para>
<para role="param">LogicalState [tt:RelayLogicalState]</para>
<para role="text">Trigger request, i.e., active or inactive.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:RelayToken</para>
<para role="text">Unknown relay token reference.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">ACTUATE</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<section>
<title>Digital Inputs</title>
<para>The DigitalInput type represents the integrated physical digital inputs of a device which enable connection to external devices, such as doorbells, detectors, lights or switches (device that can be toggled between an open and closed circuit). </para>
<section>
<title>GetDigitalInputs</title>
<para>This command lists all available digital inputs of a device. A device that signals support for digital inputs via its capabilities shall support listing of available inputs through the GetDigitalInputs command. A device having one or more digital inputs shall support the GetDigitalInputs command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">DigitalInputs - optional, unbounded [tt:DigitalInput]</para>
<para role="text">List enumerating all available digital inputs of the device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="text">None</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_SYSTEM</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>GetDigitalInputConfigurationOptions</title>
<para>This operation retrieves the digital input configuration options when the digital input configuration token is known. If a specific digital input is specified, the options shall concern that particular configuration. If a token is not specified, the options shall be considered generic for the device. A device shall support the GetDigitalInputConfigurationOptions command if the device signals capability of digital input configuration via DigitalInputOptions capability.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">Token - optional [tt:ReferenceToken]</para>
<para role="text">Optional token reference to the requested digital input.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">DigitalInputOptions - optional, unbounded [tt:DigitalInputConfigurationOptions]</para>
<para role="text">Options available for the specified digital input. If no token is specified, the options are applicable for all digital inputs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:NoConfig</para>
<para role="text">The requested configuration indicated by Token does not exist.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_SYSTEM</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>SetDigitalInputConfigurations</title>
<para>This operation modifies existing digital input configurations. When applying multiple configuration settings, the expected behaviour is to configure all or none. If one of the provided configurations is invalid, the expected behaviour of the device is to apply none of the configurations and an indication in the return fault which digital input configuration has not been accepted. A device shall support the SetDigitalInputConfigurations command if the device signals capability of digital input configuration via DigitalInputOptions capability.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">DigitalInputs - unbounded[tt:DigitalInput]</para>
<para role="text">the modified digital input configurations containing the unique configuration token. The digital input configuration shall exist in the device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:NoConfig</para>
<para role="text">The requested configuration indicated by Token does not exist.</para>
<para role="param">env:Sender - ter:InvalidArgVal - ter:SettingsInvalid</para>
<para role="text">The requested settings are incorrect. Token need to be returned to indicate which digital input configuration is not acceptable.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">ACTUATE</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<section>
<title>SerialPorts</title>
<para>The SerialPort type represents the physical serial port on the device and allows serial data to be read and written.</para>
<section>
<title>GetSerialPorts</title>
<para>This command lists all available serial ports of a device. A device that has one or more physical serial ports shall support listing of available serial ports through the GetSerialPorts command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">SerialPort - optional, unbounded [tt:SerialPort]</para>
<para role="text">list of structures describing all available serial ports of the device. If a device has no serial ports an empty list is returned</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="text">None</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_SYSTEM</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>GetSerialPortConfiguration</title>
<para>This operation gets the configuration of a serial port.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">SerialPortToken [tt:ReferenceToken]</para>
<para role="text">Token reference to the requested serial port.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">SerialPortConfiguration - [tmd:SerialPortConfiguration]</para>
<para role="text">The configuration of the serial port.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:InvalidSerialPort</para>
<para role="text">The supplied serial port token does not exist. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_SYSTEM</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>SetSerialPortConfiguration</title>
<para>This operation sets the setting of serial port.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">SerialPortConfiguration [tmd:SerialPortConfiguration]</para>
<para role="text">The desired configuration of the serial port.</para>
<para role="param">ForcePersistence [xs:boolean]</para>
<para role="text">Deprecated modifier for temporary settings if supported by the device. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:InvalidSerialPort</para>
<para role="text">The supplied serial port token does not exist. </para>
<para role="param">env:Sender - ter:InvalidArgVal - ter:ConfigModify</para>
<para role="text">The configuration parameters are not possible to set.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">ACTUATE</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>GetSerialPortConfigurationOptions</title>
<para>This operation requests the SerialPortConfigurationOptions of a SerialPort. A device that has one or more SerialPorts shall support this command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">SerialPortToken [tt:ReferenceToken]</para>
<para role="text">Token reference to the requested serial port.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">SerialPortConfigurationOptions [tmd:SerialPortConfigurationOptions]</para>
<para role="text">The configuration options for the specified serial port.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:InvalidSerialPort</para>
<para role="text">The supplied serial port token does not exist. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_SYSTEM</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>SendReceiveSerialCommand</title>
<para>This section describes operations to transmit/receive <emphasis>generic</emphasis> controlling data to/from a serial device that is connected to the serial port of the device.</para>
<para>This operation can be used for the following purposes.</para>
<itemizedlist>
<listitem>
<para>Transmitting arbitrary data to the connected serial device</para>
</listitem>
<listitem>
<para>Receiving data from the connected serial device</para>
</listitem>
<listitem>
<para>Transmitting arbitrary data to the connected serial device and then receiving its response data</para>
</listitem>
</itemizedlist>
<para>In order to make use of this command for the above purpose, this specification defines the input parameter structure as follows.</para>
<para>A device that indicates generic serial communication service capability shall support this command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">Token [tt:ReferenceToken]</para>
<para role="text">The physical serial port reference to be used when this request is invoked.</para>
</listitem>