-
Notifications
You must be signed in to change notification settings - Fork 0
/
ANT_NET.xml
3906 lines (3906 loc) · 214 KB
/
ANT_NET.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>ANT_NET</name>
</assembly>
<members>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters">
<summary>
ANT-FS Client Parameters.
The application should initialize ALL fields of the configuration struct,
otherwise, they will all be zero
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.SerialNumber">
<summary>
Device serial number. Set to 0 to use the serial number of the USB device
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.BeaconDeviceType">
<summary>
Client device type (transmitted in beacon)
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.BeaconManufacturerID">
<summary>
Client manufacturing ID (transmitted in beacon)
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.BeaconRadioFrequency">
<summary>
Radio frequency to use while in Link state.
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.LinkPeriod">
<summary>
Beacon Period, as described in the ANT-FS Technology specification
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.IsPairingEnabled">
<summary>
Indicates whether pairing authentication is enabled
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.IsUploadEnabled">
<summary>
Indicates whether upload functionality is supported
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.IsDataAvailable">
<summary>
Indicates whether there is data available for download
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.AuthenticationType">
<summary>
Authentication type to include in beacon, as described in the ANT-FS Technology specification
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.BeaconTimeout">
<summary>
Time, in seconds, that the client will wait without receiving any commands from the host before dropping to Link state.
Set to 255 to disable. Zero is NOT a valid value.
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.PairingTimeout">
<summary>
Time, in seconds, that the client library will wait for a response from the application to a pairing request.
</summary>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_ClientParameters.#ctor(System.UInt16,System.UInt16)">
<summary>
ANTFS_ClientParameters, with the default beacon parameters
</summary>
<param name="deviceType">Client device type</param>
<param name="manufacturerID">Client manufacturing ID</param>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ResponseTimeout`1">
<summary>
Internal structure
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ResponseTimeout`1.timeStart">
<summary>
Initial time
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ResponseTimeout`1.timeLeft">
<summary>
Desired timeout
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ResponseTimeout`1.ResponseID">
<summary>
ID of response we are waiting for
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ResponseTimeout`1.bWaitingForResponse">
<summary>
Flag to indicate whether we are waiting for a response or not
</summary>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ResponseTimeout`1.SetTimeout(`0,System.UInt32)">
<summary>
Configure a timeout to wait for a response
</summary>
<param name="theResponse">Response we are looking for</param>
<param name="theTimeout">Timeout, in miliseconds</param>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ResponseTimeout`1.ClearTimeout">
<summary>
Clear timeout
</summary>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ResponseTimeout`1.HasTimeoutExpired">
<summary>
Check if the timeout has expired.
Timeout is not triggered again, until enabled explicitly
</summary>
<returns>True if the timeout has expired, false otherwise</returns>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters">
<summary>
ANT-FS Device Parameters
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.DeviceID">
<summary>
Remote device ID
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.ManufacturerID">
<summary>
Manufacturer ID of remote device
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.DeviceType">
<summary>
Remote device type
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.AuthenticationType">
<summary>
Authentication type supported by remote device
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.StatusByte1">
<summary>
Status byte 1, as described in the ANT-FS Technology specification
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.StatusByte2">
<summary>
Status byte 2, as described in the ANT-FS Technology specification
</summary>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.#ctor(System.UInt32,System.UInt16,System.UInt16,System.Byte,System.Byte,System.Byte)">
<summary>
Configure specified device parameters
</summary>
<param name="DevID">Device ID</param>
<param name="usMfgID">Manufacturer ID</param>
<param name="usDevType">Device Type</param>
<param name="AuthType">Authentication Type</param>
<param name="Stat1">Status byte 1, as described in the ANT-FS Technology specification</param>
<param name="Stat2">Status byte 2, as described in the ANT-FS Technology specification</param>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.IsPairingEnabled">
<summary>
Checks if the remote device is capable of the pairing authentication scheme
</summary>
<returns>True if pairing is supported, false otherwise</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.IsUploadEnabled">
<summary>
Checks if the remote device supports uploads
</summary>
<returns>True if uploads are supported, false otherwise</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.IsDataAvailable">
<summary>
Checks if the remote device has data available for download
</summary>
<returns>True if data is available, false otherwise</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.GetBeaconPeriod">
<summary>
Obtains the beacon period of the remote device
</summary>
<returns>Beacon period of the remote device</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.GetClientState">
<summary>
Obtains current state of the remote device
</summary>
<returns>State of the remote device</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.SetPairingBit(System.Boolean)">
<summary>
Enables/disables the pairing bit in the device parameters
</summary>
<param name="bEnable">Set to true to enable pairing, false otherwise</param>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.SetUploadBit(System.Boolean)">
<summary>
Enables/disables the upload bit in the device parameters
</summary>
<param name="bEnable">Set to true to enable uploads, false otherwise</param>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.SetDataAvailableBit(System.Boolean)">
<summary>
Enables/disables the data available bit in the device parameters
</summary>
<param name="bEnable">Set to true if there is data available for download, false otherwise</param>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_DeviceParameters.ToString">
<summary>
Returns a string with the decoded device parameters
</summary>
<returns>String with decoded device parameters</returns>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_SearchResults">
<summary>
Parameters retrieved by the host after finding a client matching its search criteria
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_SearchResults.DeviceParameters">
<summary>
Remote device parameters
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_SearchResults.FriendlyName">
<summary>
Friendly name of the remote device
</summary>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_SearchResults.ToString">
<summary>
Returns a string with the decoded device parameters and friendly name
</summary>
<returns>String with decoded device parameters and friendly name</returns>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_Directory">
<summary>
ANT-FS Directory
Contains information about the files available on a remote device
</summary>
//TODO there is a version of this with more functionality in Shane's kiosk code if we wanted to use this for something it would be worth taking a look at that as well
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.dirHeader">
<summary>
Directory Header
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.dirSize">
<summary>
Number of entries contained in directory
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.dirFiles">
<summary>
Indexed entries in the directory
</summary>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Directory.#ctor">
<summary>
Creates an empty ANT-FS Directory structure
</summary>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Directory.#ctor(System.Byte[])">
<summary>
Creates an ANTFS_Directory object from downlaoded data
</summary>
<param name="DirectoryFile">Directory file received on a download</param>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Directory.GetNumberOfFileEntries(System.Byte[])">
<summary>
Obtains the number of file entries contained in the directory
</summary>
<param name="pvDirectory">Directory file</param>
<returns>Number of file entries contained in directory</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Directory.GetNewFileList(System.Byte[])">
<summary>
Decodes the directory and gets a list of files that need to be downloaded
</summary>
<param name="pvDirectory">Directory file</param>
<returns>Array containing the file indexes that need to be downloaded.
Returns an empty array if there are no new files.</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Directory.LookupFileEntry(System.Byte[],System.UInt32)">
<summary>
Looks up the requested directory entry
</summary>
<param name="pvDirectory">Directory file</param>
<param name="ulFileEntry">Zero-based entry number of the requested file (based on the order in which files are written in directory)</param>
<returns>Requested directory entry, or null if entry is not valid</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Directory.LookupFileIndex(System.Byte[],System.UInt16)">
<summary>
Looks up the requested directory entry
</summary>
<param name="pvDirectory">Directory file</param>
<param name="usFileIndex">Index of file to be looked up</param>
<returns>Requested directory entry, or null if entry is not valid</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Directory.GetHeader(System.Byte[])">
<summary>
Retrieves the directory file header
</summary>
<param name="pvDirectory">Directory file</param>
<returns>Directory header structure. An exception is thrown if the file is too small to contain a header</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Directory.ToString">
<summary>
Print directory
</summary>
<returns>Formatted string with decoded directory</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Directory.GetVersion">
<summary>
Obtains version of the directory
</summary>
<returns>Formatted string with ANT-FS directory version</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Directory.ParseFlags(System.Byte)">
<summary>
Parses general flags into a string
</summary>
<param name="ucFlags">Flag byte</param>
<returns>Formatted string with decoded flags</returns>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_Directory.TimeFormat">
<summary>
Format of time used in directory
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_Directory.GeneralFlags">
<summary>
Bit mapped flags of file permissions
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_Directory.Header">
<summary>
Directory header structure
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Header.Version">
<summary>
The version of the Directory File Structure. The most significant 4 bits
indicate major revision while the least significant 4 bits indicate a minor
revision
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Header.ElementLength">
<summary>
The length of each structure, in bytes
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Header.TimeFormat">
<summary>
Defines how the system will keep track of Date/Time stamps
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Header.Reserved">
<summary>
Reserved bytes
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Header.SystemTime">
<summary>
Number of seconds elapsed since the system was powered up
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Header.Date">
<summary>
The number of seconds elapsed since 00:00 in the morning of December 31, 1989.
The value zero (0) specifies an unknown date.
Values of less than 0x0FFFFFFF will be interpreted as being system time or
some other custom time format (e.g. counter incremented every time directory
entries are modified)
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_Directory.Entry">
<summary>
Directory file entry structure
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Entry.FileIndex">
<summary>
Data file index
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Entry.FileDataType">
<summary>
Data type of the file, which informs how to interpret the file
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Entry.FileSubType">
<summary>
Part of the identifier field, used to uniquely identify a file.
In .FIT, used to identify a sub type of the .FIT file type.
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Entry.FileNumber">
<summary>
Part of the identifier field, used to uniquely identify a file.
In .FIT, used to identify a particular instance of a file sub type.
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Entry.SpecificFlags">
<summary>
File data type specific bit mapped flags
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Entry.GeneralFlags">
<summary>
Bit mapped flags of file permissions
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Entry.FileSize">
<summary>
Size of file in bytes
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_Directory.Entry.TimeStamp">
<summary>
The number of seconds elapsed since 00:00 in the morning of December 31, 1989.
The value zero (0) specifies an unknown date.
Values of less than 0x0FFFFFFF will be interpreted as being system time or
some other custom time format.
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_Exception">
<summary>
Exceptions thrown by ANT-FS objects
</summary>
</member>
<member name="T:ANT_Managed_Library.ANT_Exception">
<summary>
An exception occuring in the ANT Managed Library
</summary>
</member>
<member name="M:ANT_Managed_Library.ANT_Exception.#ctor(System.String)">
<summary>
Prefixes given string with "ANTLibrary Exception: "
</summary>
<param name="exceptionDetail">String to prefix</param>
</member>
<member name="M:ANT_Managed_Library.ANT_Exception.#ctor(System.String,System.Exception)">
<summary>
Prefixes given string with "ANTLibrary Exception: " and propates inner exception
</summary>
<param name="exceptionDetail">String to prefix</param>
<param name="innerException">Inner exception</param>
</member>
<member name="M:ANT_Managed_Library.ANT_Exception.#ctor(ANT_Managed_Library.ANT_Exception)">
<summary>
Copy constructor
</summary>
<param name="aex">ANTException to copy</param>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Exception.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="exceptionDetail">String to append to exception message</param>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_Exception.#ctor(System.String,System.Exception)">
<summary>
Prefixes given string with "ANTLibrary Exception: " and propagates inner exception
</summary>
<param name="exceptionDetail">String to prefix</param>
<param name="innerException">Inner exception</param>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_RequestFailed_Exception">
<summary>
Exceptions thrown by ANT-FS objects when a request to perform a specific operation failed
Developers must ensure that these exceptions are handled appropiately to continue with the program execution
</summary>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_RequestFailed_Exception.#ctor(System.String,ANT_Managed_Library.ANTFS.ReturnCode)">
<summary>
Constructor
</summary>
<param name="strOperation">Requested operation that failed</param>
<param name="theReturn">ANT-FS Library return code</param>
</member>
<member name="M:ANT_Managed_Library.ANTFS.ANTFS_RequestFailed_Exception.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="exceptionDetail">Requested operation that failed</param>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ReturnCode">
<summary>
Return codes for ANT-FS operations
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.AuthenticationType">
<summary>
ANT-FS authentication types
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.DisconnectType">
<summary>
ANT-FS disconnect command type
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.Print">
<summary>
Helper class that prints human readable versions of the constants
</summary>
</member>
<member name="M:ANT_Managed_Library.ANTFS.Print.AsString(System.Enum)">
<summary>
Prints the description attribute of an enumeration value
</summary>
<param name="eMyEnum">Enumeration value to print</param>
<returns>Description string, e.g. "Operation successful"</returns>
</member>
<member name="M:ANT_Managed_Library.ANTFS.Print.AsEnum(System.Enum)">
<summary>
Prints the name of an enumeration value
</summary>
<param name="eMyEnum">Enumeration value to print</param>
<returns>Named enumeration string, e.g. "ANTFS.ReturnCode.Pass"</returns>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_RequestParameters">
<summary>
ANT-FS Request Parameters
These are the parameters received from the host
along with a download/upload/erase request
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_RequestParameters.FileIndex">
<summary>
File index of the requested download, upload or erase operation
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_RequestParameters.Offset">
<summary>
Requested offset. The client library handles offsets internally,
this is available for information purposes.
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_RequestParameters.BlockSize">
<summary>
Maximum number of bytes the host can send/receive in a single block.
The client library handles this internally, this is available for
information purposes.
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_RequestParameters.MaxSize">
<summary>
Maximum number of bytes that the host is requesting to upload.
This includes the offset plus the total remaining bytes.
This can be used to determine if there is enough space available
in the device to handle the upload.
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_RequestParameters.CrcSeed">
<summary>
CRC Seed for the download.
The client library handles this internally, this is available for
information purposes
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_RequestParameters.IsInitialRequest">
<summary>
Indicates whether this is an initial download request or an attempt
to resume a previous transfer.
Resuming within a single session is handled by the library, this is
available for information purposes.
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_DisconnectParameters">
<summary>
ANT-FS Disconnect Parameters
These are the parameters received from the host
along with the disconnect command
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DisconnectParameters.CommandType">
<summary>
Disconnect command type
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DisconnectParameters.TimeDuration">
<summary>
Requested amount in time (in 30 s increments) to become undiscoverable
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DisconnectParameters.ApplicationSpecificDuration">
<summary>
Requested application specific undiscoverable time
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_DownloadParameters">
<summary>
Application defined parameters for a download response
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DownloadParameters.FileIndex">
<summary>
File index of requested download
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_DownloadParameters.MaxBlockSize">
<summary>
Maximum number of bytes to send in a single block
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.ANTFS_UploadParameters">
<summary>
Application defined parameters for an upload response
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_UploadParameters.FileIndex">
<summary>
File index of requested upload
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_UploadParameters.MaxFileSize">
<summary>
Maximum file size that can be stored in requested upload location
</summary>
</member>
<member name="F:ANT_Managed_Library.ANTFS.ANTFS_UploadParameters.MaxBlockSize">
<summary>
Maximum number of bytes that can be received in a single block
</summary>
</member>
<member name="T:ANT_Managed_Library.ANTFS.TransferStatus">
<summary>
Status of an ongoing or completed data transfer
</summary>
</member>
<member name="M:ANT_Managed_Library.ANTFS.TransferStatus.#ctor(System.UInt32,System.UInt32)">
<summary>
Constructor initializes status and obtains percentage from parameters
</summary>
<param name="Progress">Current byte progress</param>
<param name="Length">Expected data length</param>
</member>
<member name="M:ANT_Managed_Library.ANTFS.TransferStatus.ToString">
<summary>
Provides a string containing the transfer status
</summary>
<returns>Formatted string with the current byte progress, expected length and percentage</returns>
</member>
<member name="P:ANT_Managed_Library.ANTFS.TransferStatus.ByteProgress">
<summary>
Current byte progress of a data transfer
</summary>
</member>
<member name="P:ANT_Managed_Library.ANTFS.TransferStatus.TotalLength">
<summary>
Expected length of a data transfer
</summary>
</member>
<member name="P:ANT_Managed_Library.ANTFS.TransferStatus.Percentage">
<summary>
Current percentage of completion of a data transfer
</summary>
</member>
<member name="T:ANT_Managed_Library.ANT_Channel">
<summary>
Control class for an individual ANT channel. Created and accessed through the ANTDevice class.
</summary>
</member>
<member name="T:ANT_Managed_Library.IANT_Channel">
<summary>
Interface for an ANT channel. Allows classes to use different channel implementations behind the interface.
</summary>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.getUnmgdFramer">
<summary>
Returns the underlying C++ ANT framer reference that this channel uses for messaging. Useful to pass to unmanaged C++ implementations.
</summary>
<returns>Pointer to the C++ ANT framer for messaging</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.getChannelNum">
<summary>
Returns the channel number of this chanel
</summary>
<returns>The channel number that is sent with messages on the ANT messaging layer</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.requestStatus(System.UInt32)">
<summary>
Returns current channel status.
Throws exception on timeout.
</summary>
<param name="responseWaitTime">Time to wait for device success response</param>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.requestID(System.UInt32)">
<summary>
Returns the channel ID
Throws exception on timeout
</summary>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns></returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.assignChannel(ANT_Managed_Library.ANT_ReferenceLibrary.ChannelType,System.Byte,System.UInt32)">
<overloads>Assign channel</overloads>
<summary>
Assign an ANT channel along with its main parameters.
Throws exception if the network number is invalid.
</summary>
<param name="channelTypeByte">Channel Type byte</param>
<param name="networkNumber">Network to assign to channel, must be less than device's max networks-1</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.assignChannelExt(ANT_Managed_Library.ANT_ReferenceLibrary.ChannelType,System.Byte,ANT_Managed_Library.ANT_ReferenceLibrary.ChannelTypeExtended,System.UInt32)">
<overloads>Assign channel (extended)</overloads>
<summary>
Assign an ANT channel, using extended channel assignment
Throws exception if the network number is invalid.
</summary>
<param name="channelTypeByte">Channel Type byte</param>
<param name="networkNumber">Network to assign to channel, must be less than device's max netwoks - 1</param>
<param name="extAssignByte">Extended assignment byte</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.unassignChannel(System.UInt32)">
<overloads>Unassign channel</overloads>
<summary>
Unassign this channel.
</summary>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.setChannelID(System.UInt16,System.Boolean,System.Byte,System.Byte,System.UInt32)">
<overloads>Set the Channel ID</overloads>
<summary>
Set the Channel ID of this channel.
Throws exception if device type is > 127.
</summary>
<param name="deviceNumber">Device number to assign to channel. Set to 0 for receiver wild card matching</param>
<param name="pairingEnabled">Device pairing bit.</param>
<param name="deviceTypeID">Device type to assign to channel. Must be less than 128. Set to 0 for receiver wild card matching</param>
<param name="transmissionTypeID">Transmission type to assign to channel. Set to 0 for receiver wild card matching</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.setChannelID_UsingSerial(System.Boolean,System.Byte,System.Byte,System.UInt32)">
<overloads>Sets the Channel ID, using serial number as device number</overloads>
<summary>
Identical to setChannelID, except last two bytes of serial number are used for device number.
Not available on all ANT devices.
Throws exception if device type is > 127.
</summary>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.setChannelPeriod(System.UInt16,System.UInt32)">
<overloads>Sets channel message period</overloads>
<summary>
Set this channel's messaging period
</summary>
<param name="messagePeriod_32768unitspersecond">Desired period in seconds * 32768</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.setChannelFreq(System.Byte,System.UInt32)">
<overloads>Sets channel RF Frequency</overloads>
<summary>
Set this channel's RF frequency, with the given offset from 2400Mhz.
Note: Changing this frequency may affect the ability to certify the product in certain areas of the world.
</summary>
<param name="RFFreqOffset">Offset to add to 2400Mhz</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.setChannelTransmitPower(ANT_Managed_Library.ANT_ReferenceLibrary.TransmitPower,System.UInt32)">
<overloads>Sets the channel transmission power</overloads>
<summary>
Set the transmission power of this channel
Throws exception if device is not capable of per-channel transmit power.
</summary>
<param name="transmitPower">Transmission power to set to</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.setChannelSearchTimeout(System.Byte,System.UInt32)">
<overloads>Sets the channel search timeout</overloads>
<summary>
Set the search timeout
</summary>
<param name="searchTimeout">timeout in 2.5 second units (in newer devices 255=infinite)</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.openChannel(System.UInt32)">
<overloads>Opens the channel</overloads>
<summary>
Opens this channel
</summary>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.sendBroadcastData(System.Byte[])">
<overloads>Sends broadcast message</overloads>
<summary>
Sends the given data on the broadcast transmission.
Throws exception if data > 8-bytes in length
</summary>
<param name="data">data to send (length 8 or less)</param>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.sendAcknowledgedData(System.Byte[],System.UInt32)">
<overloads>Sends acknowledged message</overloads>
<summary>
Sends the given data as an acknowledged transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled
Throws exception if data > 8-bytes in length
</summary>
<param name="data">data to send (length 8 or less)</param>
<param name="ackWaitTime">Time in ms to wait for acknowledgement</param>
<returns>0=fail, 1=pass, 2=timeout, 3=cancelled</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.sendBurstTransfer(System.Byte[],System.UInt32)">
<overloads>Sends burst transfer</overloads>
<summary>
Sends the given data as a burst transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled
</summary>
<param name="data">data to send, can be any length</param>
<param name="completeWaitTime">Time in ms to wait for completion of transfer</param>
<returns>0=fail, 1=pass, 2=timeout, 3=cancelled</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.sendAdvancedBurstTransfer(System.Byte[],System.Byte,System.UInt32)">
<summary>
Sends the given data as an advanced burst transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled
</summary>
<param name="data">data to send, can be any length</param>
<param name="numStdPcktsPerSerialMsg"> determines how many bytes of data are sent in each packet
over the serial port in multiples of packet size (the size of the packet payload at the
wireless level is determined by the pckt size set in the ConfigureAdvancedBurst command).</param>
<param name="completeWaitTime">Time in ms to wait for completion of transfer</param>
<returns>0=fail, 1=pass, 2=timeout, 3=cancelled, 4=invalid parameter</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.sendExtBroadcastData(System.UInt16,System.Byte,System.Byte,System.Byte[])">
<overloads>Sends extended broadcast message</overloads>
<summary>
Sends the given data as an extended broadcast transmission.
Throws exception if data > 8-bytes in length
</summary>
<param name="deviceNumber">Device number of channel ID to send to</param>
<param name="deviceTypeID">Device type of channel ID to send to</param>
<param name="transmissionTypeID">Transmission type of channel ID to send to</param>
<param name="data">data to send (length 8 or less)</param>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.sendExtAcknowledgedData(System.UInt16,System.Byte,System.Byte,System.Byte[],System.UInt32)">
<overloads>Sends extended acknowledged message</overloads>
<summary>
Sends the given data as an extended acknowledged transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled
Throws exception if data > 8-bytes in length
</summary>
<param name="deviceNumber">Device number of channel ID to send to</param>
<param name="deviceTypeID">Device type of channel ID to send to</param>
<param name="transmissionTypeID">Transmission type of channel ID to send to</param>
<param name="data">data to send (length 8 or less)</param>
<param name="ackWaitTime">Time in ms to wait for acknowledgement</param>
<returns>0=fail, 1=pass, 2=timeout, 3=cancelled</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.sendExtBurstTransfer(System.UInt16,System.Byte,System.Byte,System.Byte[],System.UInt32)">
<overloads>Sends extended burst data</overloads>
<summary>
Sends the given data as an extended burst transmission. Returns: 0=fail, 1=pass, 2=timeout, 3=cancelled
</summary>
<param name="deviceNumber">Device number of channel ID to send to</param>
<param name="deviceTypeID">Device type of channel ID to send to</param>
<param name="transmissionTypeID">Transmission type of channel ID to send to</param>
<param name="data">data to send, can be any length</param>
<param name="completeWaitTime">Time in ms to wait for completion of transfer</param>
<returns>0=fail, 1=pass, 2=timeout, 3=cancelled</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.closeChannel(System.UInt32)">
<overloads>Closes the channel</overloads>
<summary>
Close this channel
</summary>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.setLowPrioritySearchTimeout(System.Byte,System.UInt32)">
<overloads>Sets the channel low priority search timeout</overloads>
<summary>
Sets the search timeout for the channel's low-priority search, where it will not interrupt other open channels.
When this period expires the channel will drop to high-priority search.
This feature is not available in all ANT devices.
</summary>
<param name="lowPriorityTimeout">Timeout period in 2.5 second units</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.includeExcludeList_addChannel(System.UInt16,System.Byte,System.Byte,System.Byte,System.UInt32)">
<overloads>Adds a channel ID to the device inclusion/exclusion list</overloads>
<summary>
Add the given channel ID to the channel's inclusion/exclusion list.
The channelID is then included or excluded from the wild card search depending on how the list is configured.
Throws exception if listIndex > 3.
</summary>
<param name="deviceNumber">deviceNumber of the channelID to add</param>
<param name="deviceTypeID">deviceType of the channelID to add</param>
<param name="transmissionTypeID">transmissionType of the channelID to add</param>
<param name="listIndex">position in inclusion/exclusion list to add channelID at (Max size of list is 4)</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.includeExcludeList_Configure(System.Byte,System.Boolean,System.UInt32)">
<overloads>Configures the device inclusion/exclusion list</overloads>
<summary>
Configures the inclusion/exclusion list. If isExclusionList is true the channel IDs will be
excluded from any wild card search on this channel. Otherwise the IDs are the only IDs accepted in the search.
Throws exception if list size is greater than 4.
</summary>
<param name="listSize">The desired size of the list, max size is 4, 0=none</param>
<param name="isExclusionList">True = exclusion list, False = inclusion list</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.setProximitySearch(System.Byte,System.UInt32)">
<overloads>Configures proximity search</overloads>
<summary>
Enables a one time proximity requirement for searching. Only ANT devices within the set proximity bin can be acquired.
Search threshold values are not correlated to specific distances as this will be dependent on the system design.
This feature is not available on all ANT devices.
Throws exception if given bin value is > 10.
</summary>
<param name="thresholdBin">Threshold bin. Value from 0-10 (0= disabled). A search threshold value of 1 (i.e. bin 1) will yield the smallest radius search and is generally recommended as there is less chance of connecting to the wrong device. </param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.configFrequencyAgility(System.Byte,System.Byte,System.Byte,System.UInt32)">
<overloads>Configures the three operating RF frequencies for ANT frequency agility mode</overloads>
<summary>
This function configures the three operating RF frequencies for ANT frequency agility mode
and should be used with the ADV_FrequencyAgility_0x04 extended channel assignment flag.
Should not be used with shared, or Tx/Rx only channel types.
This feature is not available on all ANT devices.
</summary>
<param name="freq1">Operating RF frequency 1</param>
<param name="freq2">Operating RF frequency 2</param>
<param name="freq3">Operating RF frequency 3</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="M:ANT_Managed_Library.IANT_Channel.SetAGCConfig(System.Byte,System.UInt32)">
<overloads>Configures channel AGC</overloads>
<summary>
Configure channel AGC
</summary>
<param name="AGCConfigByte">Configuration byte</param>
<param name="responseWaitTime">Time to wait for device success response</param>
<returns>True on success. Note: Always returns true with a response time of 0</returns>
</member>
<member name="E:ANT_Managed_Library.IANT_Channel.DeviceNotification">
<summary>
This event is fired whenever there are events on the device level that may impact the channel.
Events that currently occur (Event, value of notification info Object):
Reset, null
Shutdown, null
</summary>
</member>
<member name="E:ANT_Managed_Library.IANT_Channel.rawChannelResponse">
<summary>
The channel callback event for forwarding the raw msg struct. Triggered every time a message is received from the ANT device.
Examples include transmit and receive messages. If you are coding in C# use the other response event version.
</summary>
</member>
<member name="E:ANT_Managed_Library.IANT_Channel.channelResponse">
<summary>
The channel callback event. Triggered every time a message is received from the ANT device.
Examples include transmit and receive messages.
</summary>
</member>
<member name="M:ANT_Managed_Library.ANT_Channel.getParentDevice">
<summary>
Returns the ANTDevice that this channel belongs to
</summary>
</member>
<member name="M:ANT_Managed_Library.ANT_Channel.getUnmgdFramer">
<summary>
Returns the underlying C++ ANT framer reference that this channel uses for messaging. Useful to pass to unmanaged C++ implementations.
</summary>
<returns>Pointer to the C++ ANT framer for messaging</returns>
</member>
<member name="M:ANT_Managed_Library.ANT_Channel.getChannelNum">
<summary>
Returns the channel number of this instance
</summary>
</member>
<member name="M:ANT_Managed_Library.ANT_Channel.Dispose">
<summary>
Dispose this channel.
</summary>
</member>
<member name="M:ANT_Managed_Library.ANT_Channel.requestStatus(System.UInt32)">
<summary>
Returns current channel status.
Throws exception on timeout.