-
Notifications
You must be signed in to change notification settings - Fork 15
/
CardTransceiver.xml
211 lines (211 loc) · 13.1 KB
/
CardTransceiver.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
<Type Name="CardTransceiver" FullName="Iot.Device.Card.CardTransceiver">
<TypeSignature Language="C#" Value="public abstract class CardTransceiver" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit CardTransceiver extends System.Object" />
<TypeSignature Language="DocId" Value="T:Iot.Device.Card.CardTransceiver" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class CardTransceiver" />
<TypeSignature Language="F#" Value="type CardTransceiver = class" />
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Abstract class implementing a specific Write and Read function
This class allow to transceive information with the card
This class has to be implemented in all RFID/NFC/Card readers
So Mifare cards can be used the same way independent of any reader
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CardTransceiver ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Card.CardTransceiver.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaximumReadSize">
<MemberSignature Language="C#" Value="public abstract uint MaximumReadSize { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int32 MaximumReadSize" />
<MemberSignature Language="DocId" Value="P:Iot.Device.Card.CardTransceiver.MaximumReadSize" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property MaximumReadSize As UInteger" />
<MemberSignature Language="F#" Value="member this.MaximumReadSize : uint32" Usage="Iot.Device.Card.CardTransceiver.MaximumReadSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum number of bytes that can be read from the card in a single transaction,
(excluding CRC). This is constrained by the operating mode as well as transceiver limitations (such as
the size of a FIFO buffer in the transceiver).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaximumWriteSize">
<MemberSignature Language="C#" Value="public abstract uint MaximumWriteSize { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int32 MaximumWriteSize" />
<MemberSignature Language="DocId" Value="P:Iot.Device.Card.CardTransceiver.MaximumWriteSize" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property MaximumWriteSize As UInteger" />
<MemberSignature Language="F#" Value="member this.MaximumWriteSize : uint32" Usage="Iot.Device.Card.CardTransceiver.MaximumWriteSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum number of bytes that can be written to the card in a single transaction,
(excluding CRC). This is constrained by the operating mode as well as transceiver limitations (such as
the size of a FIFO buffer in the transceiver).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReselectTarget">
<MemberSignature Language="C#" Value="public abstract bool ReselectTarget (byte targetNumber);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ReselectTarget(unsigned int8 targetNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Card.CardTransceiver.ReselectTarget(System.Byte)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function ReselectTarget (targetNumber As Byte) As Boolean" />
<MemberSignature Language="F#" Value="abstract member ReselectTarget : byte -> bool" Usage="cardTransceiver.ReselectTarget targetNumber" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targetNumber" Type="System.Byte" Index="0" FrameworkAlternate="iot-dotnet-1.3;iot-dotnet-1.4;iot-dotnet-1.5;iot-dotnet-2.0;iot-dotnet-2.1;iot-dotnet-latest" />
</Parameters>
<Docs>
<param name="targetNumber">The target number to reselect</param>
<summary>
Once you have an authentication operation failing with Mifare cards or a read/write, the card stop.
TYhe only way to have it back is to send the unselect and anti collision.
This function provides this feature
</summary>
<returns>True if success</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Transceive">
<MemberSignature Language="C#" Value="public abstract int Transceive (byte targetNumber, ReadOnlySpan<byte> dataToSend, Span<byte> dataFromCard);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 Transceive(unsigned int8 targetNumber, valuetype System.ReadOnlySpan`1<unsigned int8> dataToSend, valuetype System.Span`1<unsigned int8> dataFromCard) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Card.CardTransceiver.Transceive(System.Byte,System.ReadOnlySpan{System.Byte},System.Span{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function Transceive (targetNumber As Byte, dataToSend As ReadOnlySpan(Of Byte), dataFromCard As Span(Of Byte)) As Integer" />
<MemberSignature Language="F#" Value="abstract member Transceive : byte * ReadOnlySpan<byte> * Span<byte> -> int" Usage="cardTransceiver.Transceive (targetNumber, dataToSend, dataFromCard)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targetNumber" Type="System.Byte" Index="0" FrameworkAlternate="iot-dotnet-1.1;iot-dotnet-1.2;iot-dotnet-1.3;iot-dotnet-1.4;iot-dotnet-1.5;iot-dotnet-2.0;iot-dotnet-2.1" />
<Parameter Name="dataToSend" Type="System.ReadOnlySpan<System.Byte>" Index="1" FrameworkAlternate="iot-dotnet-1.1;iot-dotnet-1.2;iot-dotnet-1.3;iot-dotnet-1.4;iot-dotnet-1.5;iot-dotnet-2.0;iot-dotnet-2.1" />
<Parameter Name="dataFromCard" Type="System.Span<System.Byte>" Index="2" FrameworkAlternate="iot-dotnet-1.1;iot-dotnet-1.2;iot-dotnet-1.3;iot-dotnet-1.4;iot-dotnet-1.5;iot-dotnet-2.0;iot-dotnet-2.1" />
</Parameters>
<Docs>
<param name="targetNumber">Some readers have a notion of target number for the cards as they can read multiple ones</param>
<param name="dataToSend">A standardized raw buffer with the command at the position 0 in the array</param>
<param name="dataFromCard">If any data are read from the card, they will be put into this array</param>
<summary>
This function has to be implemented by all NFC/RFID/Card readers. This function is used in exchange of data with
the reader and the cards.
</summary>
<returns>-1 in case of error, otherwise the number of bytes read and copied into the <paramref name="dataFromCard" /> array</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Transceive">
<MemberSignature Language="C#" Value="public abstract int Transceive (byte targetNumber, ReadOnlySpan<byte> dataToSend, Span<byte> dataFromCard, Iot.Device.Card.NfcProtocol protocol);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 Transceive(unsigned int8 targetNumber, valuetype System.ReadOnlySpan`1<unsigned int8> dataToSend, valuetype System.Span`1<unsigned int8> dataFromCard, valuetype Iot.Device.Card.NfcProtocol protocol) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Card.CardTransceiver.Transceive(System.Byte,System.ReadOnlySpan{System.Byte},System.Span{System.Byte},Iot.Device.Card.NfcProtocol)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function Transceive (targetNumber As Byte, dataToSend As ReadOnlySpan(Of Byte), dataFromCard As Span(Of Byte), protocol As NfcProtocol) As Integer" />
<MemberSignature Language="F#" Value="abstract member Transceive : byte * ReadOnlySpan<byte> * Span<byte> * Iot.Device.Card.NfcProtocol -> int" Usage="cardTransceiver.Transceive (targetNumber, dataToSend, dataFromCard, protocol)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targetNumber" Type="System.Byte" Index="0" FrameworkAlternate="iot-dotnet-latest" />
<Parameter Name="dataToSend" Type="System.ReadOnlySpan<System.Byte>" Index="1" FrameworkAlternate="iot-dotnet-latest" />
<Parameter Name="dataFromCard" Type="System.Span<System.Byte>" Index="2" FrameworkAlternate="iot-dotnet-latest" />
<Parameter Name="protocol" Type="Iot.Device.Card.NfcProtocol" Index="3" FrameworkAlternate="iot-dotnet-latest" />
</Parameters>
<Docs>
<param name="targetNumber">Some readers have a notion of target number for the cards as they can read multiple ones</param>
<param name="dataToSend">A standardized raw buffer with the command at the position 0 in the array</param>
<param name="dataFromCard">If any data are read from the card, they will be put into this array</param>
<param name="protocol">NFC protocol for this data exchange (e.g., Mifare)</param>
<summary>
This function has to be implemented by all NFC/RFID/Card readers. This function is used in exchange of data with
the reader and the cards.
</summary>
<returns>-1 in case of error, otherwise the number of bytes read and copied into the <paramref name="dataFromCard" /> array</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>