-
Notifications
You must be signed in to change notification settings - Fork 1
/
PITreaderClient.xml
3117 lines (3115 loc) · 140 KB
/
PITreaderClient.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"?>
<doc>
<assembly>
<name>Pilz.PITreader.Client</name>
</assembly>
<members>
<member name="T:Pilz.PITreader.Client.ApiEndpointMonitor`1">
<summary>
Wrapper to monitor an API endpoint periodically for changes.
</summary>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpointMonitor`1.#ctor(Pilz.PITreader.Client.PITreaderClient,System.String,System.Func{`0,System.Boolean},System.Func{`0,System.Threading.Tasks.Task},System.Int32)">
<summary>
Create a new instance of the class.
</summary>
<param name="client">API client</param>
<param name="endpoint">Endpoint to be monitored.</param>
<param name="changeTrigger">Callback for change detection (returns true if change occured).</param>
<param name="changeHandler">Callback executed when a change was detected.</param>
<param name="queryInterval">Query interval.</param>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpointMonitor`1.Dispose(System.Boolean)">
<summary>
Implementation of the dispose functionality.
The disposing parameter should be false when called from a finalizer, and true when called from the IDisposable.Dispose method. In other words, it is true when deterministically called and false when non-deterministically called.
</summary>
<param name="disposing"></param>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpointMonitor`1.Dispose">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
</member>
<member name="T:Pilz.PITreader.Client.ApiEndpoints">
<summary>
REST API endpoints of PITreader devices.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.Status">
<summary>
Status endpoint
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.StatusAuthentication">
<summary>
Authentication status endpoint
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.StatusMonitor">
<summary>
Status monitoring endpoint
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.Config">
<summary>
Configuration endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.ConfigBlocklist">
<summary>
Blocklist endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.FilesCertificate">
<summary>
Regenerate certificate endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.ConfigCertificateRegenerate">
<summary>
Regenerate certificate endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.ConfigCoding">
<summary>
Coding endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.ConfigCodingOem">
<summary>
OEM Coding endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.ConfigPermissionList">
<summary>
Permission list endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.ConfigUserData">
<summary>
User data configuration endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.ConfigUserDataReset">
<summary>
User data configuration reset endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.ConfigUserDataParameter">
<summary>
User data configuration parameter endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.ConfigUserDataVersion">
<summary>
User data configuration version endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.Led">
<summary>
Led endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.Transponder">
<summary>
Transponder data endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.TransponderUserData">
<summary>
Transponder user data endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.TransponderUserDataClear">
<summary>
Transponder user data clear endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.TransponderUserDataRead">
<summary>
Transponder user data read endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.TransponderUserDataWrite">
<summary>
Transponder user data write endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.TransponderUserDataClearGroup">
<summary>
Transponder user data clear group data endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.TransponderUserDataAddGroupValues">
<summary>
Transponder user data add group values endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.TransponderTeachIn">
<summary>
Transponder teach-in endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.FilesFirmware">
<summary>
Firmware upload endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.FirmwareUpdate">
<summary>
Firmware update endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.FilesOpcuaServer">
<summary>
OPC UA server certificate endpoint.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.ApiEndpoints.FilesBackup">
<summary>
Configuration backup endpoint.
</summary>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetDeviceStatus(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Read general device information (e.g. device name, order number, serial number, firmware version, hardware version, software version)
</summary>
<param name="client">PITreader client instance.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetDeviceConfiguration(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Returns the device settings of a PITreader.
</summary>
<param name="client">PITreader client instance.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.SetDeviceConfiguration(Pilz.PITreader.Client.PITreaderClient,Pilz.PITreader.Client.Model.ConfigRequest)">
<summary>
Changes device settings of a PITreader.
</summary>
<param name="client">PITreader client instance.</param>
<param name="config"></param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetBasicCoding(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Returns information about the basic coding settings on a device.
</summary>
<param name="client">PITreader client instance.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetOemCoding(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Returns information about the oem coding settings on a device.
</summary>
<param name="client">PITreader client instance.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.SetBasicCoding(Pilz.PITreader.Client.PITreaderClient,Pilz.PITreader.Client.Model.BasicCodingRequest)">
<summary>
Sets or updates the basic coding on a device.
</summary>
<param name="client">PITreader client instance.</param>
<param name="coding"></param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.SetOemCoding(Pilz.PITreader.Client.PITreaderClient,Pilz.PITreader.Client.Model.OemCodingRequest)">
<summary>
Sets or updates the oem coding on a device.
</summary>
<param name="client">PITreader client instance.</param>
<param name="coding"></param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetAuthenticationStatus(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Returns the authentication status of the current transponder.
</summary>
<param name="client">PITreader client instance.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetStatusMonitor(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Returns the status monitoring data.
</summary>
<param name="client">PITreader client instance.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetTransponderData(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Returns general data of a transpodner currently authenticated.
</summary>
<param name="client">PITreader client instance.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.TeachInTransponder(Pilz.PITreader.Client.PITreaderClient,System.String)">
<summary>
Performs a teach-in of the current transponder to the basic coding of the device.
</summary>
<param name="client">PITreader client instance.</param>
<param name="teachInId">The teach-in id of the transponder as returned by <see cref="M:Pilz.PITreader.Client.ApiEndpoints.GetTransponderData(Pilz.PITreader.Client.PITreaderClient)"/></param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetLed(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Returns the current LED status (GET request to /api/led)
</summary>
<param name="client">PITreader client instance.</param>
<returns>The current LED status.</returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.SetLed(Pilz.PITreader.Client.PITreaderClient,Pilz.PITreader.Client.Model.LedRequest)">
<summary>
Changes LED settings.
</summary>
<param name="client">PITreader client instance.</param>
<param name="settings"></param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.SetExternalAuth(Pilz.PITreader.Client.PITreaderClient,Pilz.PITreader.Client.Model.SecurityId,Pilz.PITreader.Client.Model.Permission)">
<summary>
Sets the permission for the current transponder key in external mode.
</summary>
<param name="client">PITreader client instance.</param>
<param name="securityId">The security id for which the permission should be set.</param>
<param name="permission">The permission to be set for the specified security id.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.SetExternalAuth(Pilz.PITreader.Client.PITreaderClient,System.String,Pilz.PITreader.Client.Model.Permission)">
<summary>
Sets the permission for the current transponder key in external mode.
</summary>
<param name="client">PITreader client instance.</param>
<param name="securityId">The security id for which the permission should be set.</param>
<param name="permission">The permission to be set for the specified security id.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetUserDataConfig(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Returns the current user data configuration of the device.
</summary>
<param name="client">PITreader client instance.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetBlocklist(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Returns all blocklist entries currently configured in the device.
</summary>
<param name="client">PITreader client instance.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.UpdateBlocklist(Pilz.PITreader.Client.PITreaderClient,Pilz.PITreader.Client.Model.CrudAction,Pilz.PITreader.Client.Model.BlocklistEntry)">
<summary>
Adds, deletes or updates a blocklist entry on the device.
</summary>
<param name="client">PITreader client instance.</param>
<param name="action">Action to be performed.</param>
<param name="entry">Data of the blocklist entry.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetPermissionList(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Returns all permission list entries currently configured in the device.
</summary>
<param name="client">PITreader client instance.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.UpdatePermissionList(Pilz.PITreader.Client.PITreaderClient,Pilz.PITreader.Client.Model.CrudAction,Pilz.PITreader.Client.Model.PermissionListEntry)">
<summary>
Adds, deletes or updates a permission list entry on the device.
</summary>
<param name="client">PITreader client instance.</param>
<param name="action">Action to be performed.</param>
<param name="entry">Data of the permission list entry.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.UploadCertificate(Pilz.PITreader.Client.PITreaderClient,System.IO.Stream)">
<summary>
Uploads a TLS certificate to the PITreader device.
</summary>
<param name="client">PITreader client instance.</param>
<param name="certificate">Stream with certificate data.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.RegenerateCertificate(Pilz.PITreader.Client.PITreaderClient,Pilz.PITreader.Client.Model.CertificateRegenerateScope)">
<summary>
Request to renew certificate on PITreader device.
</summary>
<param name="client">PITreader client instance.</param>
<param name="scope">Scope of certificate renew request</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetOpcUaServerCertificate(Pilz.PITreader.Client.PITreaderClient,System.IO.Stream)">
<summary>
Downloads the current OPC UA Server certificate to provided io stream.
</summary>
<param name="client">PITreader client instance.</param>
<param name="stream">IO stream to receive the certificate data.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiEndpoints.GetConfigurationBackup(Pilz.PITreader.Client.PITreaderClient,System.IO.Stream)">
<summary>
Downloads the current configuration backup to provided io stream.
</summary>
<param name="client">PITreader client instance.</param>
<param name="stream">IO stream to receive the configuration backup.</param>
<returns></returns>
</member>
<member name="T:Pilz.PITreader.Client.ApiUtilities">
<summary>
Utility functions for PITreader API requests and responses.
</summary>
</member>
<member name="M:Pilz.PITreader.Client.ApiUtilities.HexStringToByteArray(System.String)">
<summary>
Converts a string of hexadecimal numbers (with even length) to a byte array.
</summary>
<param name="hexString">A string of hexadecimal numbers.</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.ApiUtilities.GetThumbprintSha2(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>
Returns the SHA2 thumbprint for the certificate.
</summary>
<param name="certificate"></param>
<returns></returns>
<exception cref="T:System.ArgumentNullException"></exception>
</member>
<member name="M:Pilz.PITreader.Client.ApiUtilities.GetThumbprintSha1(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>
Returns the SHA1 thumbprint for the certificate (<seealso cref="P:System.Security.Cryptography.X509Certificates.X509Certificate2.Thumbprint"/>).
</summary>
<param name="certificate"></param>
<returns></returns>
<exception cref="T:System.ArgumentNullException"></exception>
</member>
<member name="M:Pilz.PITreader.Client.ApiUtilities.SafeEquals``1(System.IEquatable{``0},System.IEquatable{``0})">
<summary>
Indicates whether two objects of the same type are equal.
</summary>
<typeparam name="T">type of objects for comparison</typeparam>
<param name="value">An object.</param>
<param name="other">An object to compare with this object.</param>
<returns>true if the current object is equal to the other parameter; otherwise, false.</returns>
</member>
<member name="T:Pilz.PITreader.Client.BlocklistManager">
<summary>
Class to manage (sync) blocklist entries of a device.
</summary>
</member>
<member name="M:Pilz.PITreader.Client.BlocklistManager.#ctor(Pilz.PITreader.Client.PITreaderClient)">
<summary>
Creates a new instance of the class.
</summary>
<param name="client">Reference to PITreaderClient object</param>
</member>
<member name="M:Pilz.PITreader.Client.BlocklistManager.GetEntriesAsync">
<summary>
Returns all blocklist entries currently stored on the device.
</summary>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.BlocklistManager.SyncAsync(System.Collections.Generic.IList{Pilz.PITreader.Client.Model.BlocklistEntry})">
<summary>
Sync entries on the device with entries passed to the function as an argument.
</summary>
<param name="imported">List of imported (to be synced) entries.</param>
</member>
<member name="M:Pilz.PITreader.Client.BlocklistManager.UpdateBlockListAsync(Pilz.PITreader.Client.Model.CrudAction,Pilz.PITreader.Client.Model.BlocklistEntry)">
<summary>
Modify block list
</summary>
<param name="action">see <see cref="T:Pilz.PITreader.Client.Model.CrudAction"/></param>
<param name="entry">the <see cref="T:Pilz.PITreader.Client.Model.BlocklistEntry"/> to modify</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.BlocklistManager.AddEntryAsync(Pilz.PITreader.Client.Model.BlocklistEntry)">
<summary>
Adds an entry to the block list
</summary>
<param name="blocklistEntry">see <see cref="T:Pilz.PITreader.Client.Model.BlocklistEntry"/> to add</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.BlocklistManager.UpdateEntryAsync(Pilz.PITreader.Client.Model.BlocklistEntry)">
<summary>
Update block list entry
</summary>
<param name="blocklistEntry">the <see cref="T:Pilz.PITreader.Client.Model.BlocklistEntry"/> to modify</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.BlocklistManager.DeleteEntryAsync(Pilz.PITreader.Client.Model.BlocklistEntry)">
<summary>
Delete entry from block list
</summary>
<param name="blocklistEntry">the <see cref="T:Pilz.PITreader.Client.Model.BlocklistEntry"/> to delete</param>
<returns></returns>
</member>
<member name="T:Pilz.PITreader.Client.CertificateValidationDelegate">
<summary>
Delegate for certificate validation.
</summary>
<param name="message">HTTP request message.</param>
<param name="certificate">Certificate recieved from the device.</param>
<param name="chain">Chain of intermediate certificates received from the device</param>
<param name="pollicyErrors">SSL policy errors.</param>
<returns></returns>
</member>
<member name="T:Pilz.PITreader.Client.CertificateValidators">
<summary>
Container for predefined certificate validation strategies.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.CertificateValidators.AcceptAll">
<summary>
Accept all certificates (insecure).
</summary>
</member>
<member name="F:Pilz.PITreader.Client.CertificateValidators.AcceptThumbprintSha2">
<summary>
Accept only the certificates with the specified SHA2 thumbprint.
</summary>
</member>
<member name="T:Pilz.PITreader.Client.ExternalAuthService">
<summary>
Service for externally authenticating transponder keys inserted into a PITreader device.
</summary>
</member>
<member name="M:Pilz.PITreader.Client.ExternalAuthService.#ctor(Pilz.PITreader.Client.PITreaderClient,System.Func{Pilz.PITreader.Client.Model.SecurityId,Pilz.PITreader.Client.Model.Permission},System.Int32)">
<summary>
Creates a new instance of the class.
</summary>
<param name="client">Reference to PITreaderClient object.</param>
<param name="evaluator">Function to resolve a security id (input parameter) to a permission.</param>
<param name="queryInterval">Interval in milliseconds to check for transponder waiting for authentication.</param>
</member>
<member name="M:Pilz.PITreader.Client.ExternalAuthService.#ctor(Pilz.PITreader.Client.PITreaderClient,System.Func{Pilz.PITreader.Client.Model.SecurityId,System.Threading.Tasks.Task{Pilz.PITreader.Client.Model.Permission}},System.Int32)">
<summary>
Creates a new instance of the class.
</summary>
<param name="client">Reference to PITreaderClient object.</param>
<param name="asyncEvaluator">Function to resolve a security id (input parameter) to a permission.</param>
<param name="queryInterval">Interval in milliseconds to check for transponder waiting for authentication.</param>
</member>
<member name="M:Pilz.PITreader.Client.ExternalAuthService.Dispose(System.Boolean)">
<summary>
Implementation of the dispose functionality.
The disposing parameter should be false when called from a finalizer, and true when called from the IDisposable.Dispose method. In other words, it is true when deterministically called and false when non-deterministically called.
</summary>
<param name="disposing"></param>
</member>
<member name="M:Pilz.PITreader.Client.ExternalAuthService.Dispose">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
</member>
<member name="T:Pilz.PITreader.Client.FirmwareVersion">
<summary>
PITreader device or update package version.
</summary>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.#ctor">
<summary>
Create a new FirmwareVersion instance.
</summary>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.#ctor(System.Version)">
<summary>
Create a new FirmwareVersion instance.
</summary>
<param name="version">Base version</param>
<exception cref="T:System.ArgumentNullException"></exception>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.#ctor(System.Int32,System.Int32,System.Int32)">
<summary>
Create a new FirmwareVersion instance.
</summary>
<param name="major"></param>
<param name="minor"></param>
<param name="patch"></param>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.#ctor(System.Int32,System.Int32,System.Int32,System.UInt32)">
<summary>
Create a new FirmwareVersion instance.
</summary>
<param name="major"></param>
<param name="minor"></param>
<param name="patch"></param>
<param name="build"></param>
</member>
<member name="P:Pilz.PITreader.Client.FirmwareVersion.Major">
<summary>
Major component of firmware version.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.FirmwareVersion.Minor">
<summary>
Minor component of firmware version.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.FirmwareVersion.Patch">
<summary>
Patch component of firmware version.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.FirmwareVersion.Build">
<summary>
(Optional) Build component of firmware version.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.FirmwareVersion.Released">
<summary>
Released flag (true/false)
</summary>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.CompareTo(System.Object)">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.CompareTo(Pilz.PITreader.Client.FirmwareVersion)">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.CompareTo(System.Version)">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.Equals(System.Object)">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.GetHashCode">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.ToString">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.op_Equality(Pilz.PITreader.Client.FirmwareVersion,Pilz.PITreader.Client.FirmwareVersion)">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.op_Inequality(Pilz.PITreader.Client.FirmwareVersion,Pilz.PITreader.Client.FirmwareVersion)">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.op_GreaterThan(Pilz.PITreader.Client.FirmwareVersion,Pilz.PITreader.Client.FirmwareVersion)">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.op_LessThan(Pilz.PITreader.Client.FirmwareVersion,Pilz.PITreader.Client.FirmwareVersion)">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.op_GreaterThanOrEqual(Pilz.PITreader.Client.FirmwareVersion,Pilz.PITreader.Client.FirmwareVersion)">
<inheritdoc/>
</member>
<member name="M:Pilz.PITreader.Client.FirmwareVersion.op_LessThanOrEqual(Pilz.PITreader.Client.FirmwareVersion,Pilz.PITreader.Client.FirmwareVersion)">
<inheritdoc/>
</member>
<member name="T:Pilz.PITreader.Client.Model.ApiResponse`1">
<summary>
Response object returned on API requests.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="P:Pilz.PITreader.Client.Model.ApiResponse`1.Success">
<summary>
The request was executed successfully.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ApiResponse`1.Retryable">
<summary>
Request can be retried.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ApiResponse`1.ResponseCode">
<summary>
Response code returned by the PITreader.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ApiResponse`1.Data">
<summary>
The Data element is filled with the response on successfull requests.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ApiResponse`1.ErrorData">
<summary>
The ErrorData element is filled with the response on not successfull requests.
It is always of type GenericResponse.
</summary>
</member>
<member name="M:Pilz.PITreader.Client.Model.ApiResponse`1.ToString">
<summary>
Returns a string that represents the current object.
</summary>
<returns>A string that represents the current object.</returns>
</member>
<member name="M:Pilz.PITreader.Client.Model.ApiResponse`1.AsGenericResponse">
<summary>
Returns new ApiResponse of type GenericResponse with ErrorData of current response object.
</summary>
<returns>New ApiResponse of type GenericResponse with ErrorData of current response object.</returns>
</member>
<member name="M:Pilz.PITreader.Client.Model.ApiResponse`1.Ok(`0)">
<summary>
Creates a new ApiResponse{T} instance on successful requests.
</summary>
<param name="data">Response data object</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.Model.ApiResponse`1.Error(System.Net.HttpStatusCode,System.Boolean,Pilz.PITreader.Client.Model.GenericResponse)">
<summary>
Creates a new ApiResponse{T} instance on errors.
</summary>
<param name="statusCode">HTTP Status code of response.</param>
<param name="retry">Possibility to retry request.</param>
<param name="data">Response data object</param>
<returns></returns>
</member>
<member name="M:Pilz.PITreader.Client.Model.ApiResponse`1.Error(System.String,System.Boolean,System.Nullable{Pilz.PITreader.Client.Model.ResponseCode})">
<summary>
Creates a new ApiResponse{T} instance on errors.
</summary>
<param name="message">Message text.</param>
<param name="retry">Possibility to retry request.</param>
<param name="code">Response code.</param>
<returns></returns>
</member>
<member name="T:Pilz.PITreader.Client.Model.AuthenticationFailureReason">
<summary>
Failure reasons of the authentication process running for transponders of the PITreader.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationFailureReason.None">
<summary>
No error
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationFailureReason.NoTransponder">
<summary>
No transponder key inserted
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationFailureReason.Permission_0">
<summary>
Permission "0"
The transponder key has no permissions for device groups.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationFailureReason.TimeLimitation">
<summary>
The validity of the transponder key is outside the validity period.
(Start date/end date)
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationFailureReason.Blocklist">
<summary>
The transponder key is included in the block list.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationFailureReason.ExternalModeWating">
<summary>
No permission has been stored for the security-ID yet. ("External" authentication mode)
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationFailureReason.IoPortLock">
<summary>
Authentication is locked by the 24 V I/O port.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationFailureReason.SingleAuthLock">
<summary>
The "Single authentication" authentication type is configured and authentication is locked by another registered transponder key.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationFailureReason.FourEyesFirstKey">
<summary>
The "4 Eyes Principle" authentication type is configured and the second transponder key was not authenticated yes.
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationFailureReason.NotInPermissionList">
<summary>
Authentication mode "permission list" is used but the transponder is not part of the permission list on the device.
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.AuthenticationMode">
<summary>
Device's authentication mode
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationMode.ExternalAuthentication">
<summary>
External
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationMode.TransponderData">
<summary>
Transponder data
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationMode.PermissionList">
<summary>
Permissino list
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.AuthenticationStatus">
<summary>
Status of authentication process
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationStatus.NoTransponder">
<summary>
No transponder key
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationStatus.Completed">
<summary>
Process completed
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.AuthenticationStatus.Waiting">
<summary>
Waiting for external authentication
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.AuthenticationStatusResponse">
<summary>
Current information on a transponder key’s authentication status
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.AuthenticationStatusResponse.Authenticated">
<summary>
Authentication status of the transponder key
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.AuthenticationStatusResponse.Permission">
<summary>
Authenticated permission
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.AuthenticationStatusResponse.AuthenticationStatus">
<summary>
Status of authentication process
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.AuthenticationStatusResponse.FailureReason">
<summary>
Reason for failed authentication
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.AuthenticationStatusResponse.SecurityId">
<summary>
Security ID
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.AuthenticationStatusResponse.OrderNumber">
<summary>
Order number of the transponder key
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.AuthenticationStatusResponse.SerialNumber">
<summary>
Serial number of the transponder key
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.AuthenticationStatusResponse.UserData">
<summary>
User data
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.BasicCodingRequest">
<summary>
Request to set or update the basic coding of a device.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.BasicCodingRequest.Identifier">
<summary>
Coding indentifier.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.BasicCodingRequest.Comment">
<summary>
Comment
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.BlocklistCrudRequest">
<summary>
Request to create, update or delete a blocklist entry.
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.BlocklistEntry">
<summary>
An entry in the blocklist.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.BlocklistEntry.Id">
<summary>
Security ID
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.BlocklistEntry.Comment">
<summary>
Comment stored with the security id.
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.BlocklistResponse">
<summary>
Response with the list of blocklist entries stored on the device.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.BlocklistResponse.Items">
<summary>
List of blocklist entries stored on the device.
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.CertificateRegenerateRequest">
<summary>
Request to renew TLS certificate (and key)
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.CertificateRegenerateRequest.Scope">
<summary>
Scope of renew operation
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.CertificateRegenerateScope">
<summary>
Scope of certificate renew request
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.CertificateRegenerateScope.CertOnly">
<summary>
Only renew certificate (keeps the same key)
</summary>
</member>
<member name="F:Pilz.PITreader.Client.Model.CertificateRegenerateScope.All">
<summary>
Renew certificate and key
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.CodingResponse">
<summary>
Status of a coding on a device.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.CodingResponse.Activated">
<summary>
Device is coded.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.CodingResponse.Checksum">
<summary>
Checksum of the coding.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.CodingResponse.Comment">
<summary>
Comment stored with the coding.
</summary>
</member>
<member name="T:Pilz.PITreader.Client.Model.ConfigRequest">
<summary>
Request to update the device configuration.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.HostName">
<summary>
Hostname/device name
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.Location">
<summary>
Location information of the device.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.Domain">
<summary>
Domain name for HTTPS certificates
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.IpAddress">
<summary>
Device's IP address
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.SubnetMask">
<summary>
Device’s subnet mask
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.DefaultGateway">
<summary>
Standard Gateway's IP address
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.HttpPort">
<summary>
HTTP port number
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.HttpEnabled">
<summary>
HTTP protocol enabled
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.HttpsPort">
<summary>
HTTPS port number
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.NetworkDiscoveryEnabled">
<summary>
Network discovery using MDNS enabled
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.MulticastConfigurationEnabled">
<summary>
Multicast configuration protocol for initial setup of device enabled
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.SntpEnabled">
<summary>
Status of SNTP client on the device
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.SntpServer">
<summary>
IP address of configured SNTP server.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.SntpPort">
<summary>
Port number of configured SNTP server.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.SntpRefreshRate">
<summary>
SNTP refresh interval in minutes.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.ModbusTcpEnabled">
<summary>
Activation state of the Modbus/TCP slave (server) in the device.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.ModbusTcpPort">
<summary>
Port number of the Modbus/TCP slave (server) in the device.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.SupportThirdPartyTransponders">
<summary>
Support third-party transponders.
</summary>
</member>
<member name="P:Pilz.PITreader.Client.Model.ConfigRequest.RfidProtocols">
<summary>
Selected rfid protocol for support of third-party transponders.
</summary>