[top]
DESCRIPTION
The SpringProx OCX (SpringProxActiveX.dll) provides a convenient way to access SpringProx readers (CSB, K531, SpringProx) without linking to the SpringProx API DLL.
NOTES
Using the DLL directly gives better performance. Some functions of the DLL are not implemented by the OCX. If targetting the .NET framework, consider using the .NET class library ("wrapper") available as SpringProxAPI.dll instead of the OCX
[top]
NAME
Active
DESCRIPTION
Reader open/close (boolean)
ACCESS
Read-write
VALUES
write True : try to connect to the reader write False : disconnect from the reader read True : reader connected read False : no access to reader
SEE ALSO
Open Close
[top]
NAME
Atq
DESCRIPTION
Answer To Query currently selected ISO/IEC 14443 card (hexadecimal text)
ACCESS
Read-only
NOTES
If type A is selected and a card has been found, this is the ATQa of the card (2 bytes). If type B is selected and a card has been found, this is the ATQb of the card (11 bytes). Pupi is the beggining (4 bytes) of this ATQb.
[top]
NAME
Close
DESCRIPTION
Disconnect from the reader
SEE ALSO
Active Open
[top]
NAME
Device
DESCRIPTION
Name of the reader communication port (text)
ACCESS
Read-write
VALUES
write "COMx" : tell springprox.dll that reader must be found on COMx serial device write "" : tell springprox.dll that default parameters must be tried read "COMx" : reader is connected on COMx serial device
[top]
NAME
Library
DESCRIPTION
SpringProx reader firmware version and info (text)
ACCESS
Read-only
[top]
NAME
Halt
DESCRIPTION
Halt currently selected card
NOTES
If card has entered layer 4, it must be halted with TclDeselect instead.
[top]
NAME
Active
DESCRIPTION
ISO/IEC 14443 configuration (numeric)
ACCESS
Read-write
VALUES
1 : use ISO/IEC 14443-A 2 : use ISO/IEC 14443-B
[top]
NAME
LastError
DESCRIPTION
Last error code (numeric)
ACCESS
Read-only
[top]
NAME
LastErrorTxt
DESCRIPTION
Last error message (text)
ACCESS
Read-only
[top]
NAME
LedGreen
DESCRIPTION
Control reader's Green LED (numeric)
ACCESS
Write-only
VALUES
0 : LED is off 1 : LED is on 2 : slow blinker 3 : LED is driven by firmware (= monitor activity of the reader) Values above 3 are available only with firmware >= 1.40 4 : fast blinker 5 : heart blinker
[top]
NAME
LedRed
DESCRIPTION
Control reader's Red LED (numeric)
ACCESS
Write-only
VALUES
0 : LED is off 1 : LED is on 2 : slow blinker 3 : LED is driven by firmware (= heart blinker) Values above 3 are available only with firmware >= 1.40 4 : fast blinker 5 : heart blinker
[top]
NAME
LedYellow
DESCRIPTION
Control reader's Yellow LED (numeric)
ACCESS
Write-only
VALUES
0 : LED is off 1 : LED is on 2 : slow blinker 3 : LED is driven by firmware (= monitor RF field and ISO configuration) Values above 3 are available only with firmware >= 1.40 4 : fast blinker 5 : heart blinker
[top]
NAME
Library
DESCRIPTION
SpringProx.dll library version and info (text)
ACCESS
Read-only
[top]
NAME
Open
DESCRIPTION
Try to connect to the reader
SEE ALSO
Active Close
[top]
NAME
Pupi
DESCRIPTION
Pseudo-Unique IDentifier of currently selected ISO/IEC 14443-B card (hexadecimal text)
ACCESS
Read-only
NOTES
This value is meaningfull only if type B configuration is selected and a card has been found with SelectAny or SelectIdle Pupi is the beggining (4 bytes) of Atq
[top]
NAME
RfField
DESCRIPTION
Control RF field of the reader (numeric)
ACCESS
Write-only
VALUES
0 : stop the RF field (antenna is powered down) 1 : start the RF field (antenna is powered up) other value : reset the RF field for the specified number of milliseconds
[top]
NAME
Sak
DESCRIPTION
Select AKnowledge of currently selected ISO/IEC 14443-A card (hexadecimal text)
ACCESS
Read-only
NOTES
This value is meaningfull only if type A configuration is selected and a card has been found with SelectAny or SelectIdle. It is 1 byte long.
[top]
NAME
SelectAgain
DESCRIPTION
Try to re-select the last contactless card
[top]
NAME
SelectAny
DESCRIPTION
Try to select a contactless card on the reader
NOTES
Depending on IsoConfig the reader tries to find either a type A or type B card. The SelectAny request will find any cards (even previously halted ones).
[top]
NAME
SelectIdle
DESCRIPTION
Try to select a contactless card on the reader
NOTES
Depending on IsoConfig the reader tries to find either a type A or type B card. The SelectIdle request will find only new cards in the RF field.
[top]
NAME
TclAts
DESCRIPTION
ATS or RAttrib of currently selected ISO/IEC 14443-4 card (hexadecimal text)
ACCESS
Read-only
NOTES
This value is meaningfull only if previous call to TclSelect was successfull. Size depends on the card.
[top]
NAME
TclData
DESCRIPTION
ISO/IEC 14443-4 frame data (hexadecimal text)
ACCESS
Read-write
NOTES
This property is the input and output buffer for TclExchange : - populate TclData with the command you want to send to the card - call TclExchange (of course card must have been selected first) - on success retrieve card's answer in TclData If you're more familiar with ISO/IEC 7816-4 vocabulary, - populate TclData with the APDU - call TclExchange (equivalent to a SCardTransmit) - on success retrieve card's response with status word in TclData The status word is also made available as a numeric value in TclDataSW
[top]
NAME
TclDataSW
DESCRIPTION
ISO/IEC 7816-4 status word of the last ISO/IEC 14443-4 exchange (numeric)
ACCESS
Read-only
[top]
NAME
TclDeselect
DESCRIPTION
Deselect the T=CL card
NOTES
If card is still in layer 3, it must be halted with Halt instead.
[top]
NAME
TclExchange
DESCRIPTION
Perform an ISO/IEC 14443-4 frame exchange with the card
NOTES
See explanation in TclData related notes
[top]
NAME
TclSelect
DESCRIPTION
Ask current card to enter ISO/IEC 14443 layer 4 (=select the T=CL card)
NOTES
This is possible only with cards that support layer 4 ! If card has type A, its ATS is returned in Ats. If card has type B, its "Answer to ATTRIB" (RAttrib) is returned in Ats.
[top]
NAME
Uid
DESCRIPTION
Unique IDentifier of currently selected ISO/IEC 14443-A card (hexadecimal text)
ACCESS
Read-only
NOTES
This value is meaningfull only if type A configuration is selected and a card has been found with SelectAny or SelectIdle. It is 4, 7 or 12 bytes long depending on the card.