NAME
CFG_MODE_ISO_14443_A
DESCRIPTION
Parameter for SPROX_SetConfig entering to the ISO 14443-A mode
NOTES
This is the default configuration of the reader after power-up.
NAME
CFG_MODE_ISO_14443_B
DESCRIPTION
Parameter for SPROX_SetConfig entering to the ISO 14443-B mode
NAME
SPROX_ControlBuzzer
DESCRIPTION
Manages reader's LEDs
INPUTS
WORD time_ms : buzzer duration in ms
RETURNS
MI_OK : success Other code if internal or communication error has occured.
NAME
SPROX_ControlLed
DESCRIPTION
Manages reader's LEDs
INPUTS
BYTE led_r : value for the red LED BYTE led_g : value for the green LED
NOTES
Allowed values for led_r and led_g are : 0 : LED is OFF 1 : LED is ON 2 : LED is BLINKING 3 : LED is managed by the reader If led_r is set to 3, the red LED blinks slowly If led_g is set to 3, the green LED reflects reader activity
RETURNS
MI_OK : success Other code if internal or communication error has occured.
SEE ALSO
SPROX_ControlLedY
NAME
SPROX_ControlLedY
DESCRIPTION
Manages reader's LEDs
INPUTS
BYTE led_r : value for the red LED BYTE led_g : value for the green LED BYTE led_y : value for the yellow LED
NOTES
Allowed values for led_r and led_g are : 0 : LED is OFF 1 : LED is ON 2 : LED is BLINKING 3 : LED is managed by the reader If led_r is set to 3, the red LED blinks slowly If led_g is set to 3, the green LED reflects reader activity If led_y is set to 3, the yellow LED reflects antenna status
RETURNS
MI_OK : success Other code if internal or communication error has occured.
SEE ALSO
SPROX_ControlLed
NAME
SPROX_ControlReadModeIO
DESCRIPTION
Read value of reader's MODE pin
INPUTS
BOOL *in_value : returns the current level of the input pin.
RETURNS
MI_OK : success Other code if internal or communication error has occured.
SEE ALSO
SPROX_ControlReadUserIO
NAME
SPROX_ControlReadUserIO
DESCRIPTION
Configure the USER pin as input and read its value
INPUTS
BOOL *in_value : returns the current level of the USER pin.
RETURNS
MI_OK : success Other code if internal or communication error has occured.
SEE ALSO
SPROX_ControlWriteUserIO SPROX_ControlReadModeIO
NAME
SPROX_ControlRF
DESCRIPTION
Turn ON or OFF reader's RF field
INPUTS
BOOL mode : TRUE starts the RF field, FALSE shuts it down
RETURNS
MI_OK : success Other code if internal or communication error has occured.
NOTES
Shutting down the RF field means that every tags are stopped. When the RF field will be turned on again, they all will be in the IDLE state.
NAME
SPROX_ControlWriteUserIO
DESCRIPTION
Configure the USER pin as output and write its value
WARNING
Do not call this function is the USER pin is tied to an external hardware that assume it is an input. This may damage the product.
INPUTS
BOOL outvalue : level to be assigned to the USER pin.
RETURNS
MI_OK : success Other code if internal or communication error has occured.
SEE ALSO
SPROX_ControlReadUserIO
NAME
SPROX_ReaderGetDevice
DESCRIPTION
Retrieve the name of the device where the SpringProx has been found by SPROX_ReaderOpen
INPUTS
TCHAR device[] : buffer to receive the device name WORD len : size of the buffer
RETURNS
MI_OK : success
NAME
SPROX_ReaderGetDeviceSettings
DESCRIPTION
Retrieve current reader's operating mode
INPUTS
DWORD *features : feature set return buffer
RETURNS
MI_OK : success
NOTES
On a successfull return, the current status is retrieved as follow : b31 b24 b23 b16 b15 b8 b7 b0 ........ ........ ........ ........ ++-- Current protocol 00 = OSI 01 = ASCII 10 = Fast Binary 11 = Binary bus +---- Hardware control enabled ++------- Channel 00 = RS232/RS422 01 = RS485 10 = USB 11 = RFU +--------- Baudrate 0 = 38400bps 1 = 115200bps ++++++++-++++++++-++++++++----------- RFU
NAME
SPROX_ReaderGetFeatures
DESCRIPTION
Used to retrieve the features supported by the selected device
INPUTS
DWORD *features : feature set return buffer
RETURNS
MI_OK : success
NOTES
On a successfull return, the feature set tells which functions are actually implemented inside the reader. b31 b24 b23 b16 b15 b8 b7 b0 ........ ........ ........ ........ +-- ISO 14443 stack +--- ISO 15698 stack ++---- RFU +------ GemCore based smartcard reader +------- Sagem MSO CMB fingerprint reader ++-------- RFU +----------- ASCII communication protocol +------------ Fast Binary communication protocol +------------- RFU +-------------- Adressing enabled (for bus operation) +--------------- Physical link is RS485, not RS232/422 +---------------- RFU +----------------- Reader supports 115200bps +------------------ Reader can receive frames up to 1024 bytes ++++++++-------------------- RFU +----------------------------- Reader has an internal command processor ("console") ++++++------------------------------ RFU +------------------------------------ Reader is not compliant to the SpringProx library (the reader may implement proprietary functions only) (See products datasheet for a detailed explanation of the feature set)
NAME
SPROX_ReaderGetFirmware
DESCRIPTION
Retrieve the SpringProx reader version info
INPUTS
TCHAR firmware[] : buffer to receive the firmware info WORD len : character-size of the buffer
RETURNS
MI_OK : success Other code if internal or communication error has occured.
NOTES
The reader returns - "SPRINGCARD SPRINGPROX-CF <level> <version>" for the SpringProx-CF family - "SPRINGCARD CSB-IV <level> <version>" for the CryptoSignBox family - "SPRINGCARD K531 <level> <version>" for the the MOD-K531 OEM module <level> shows firmware capabilities : - 1 basic firmware <version> is the version field, formatted "M.mm" as follow : - M is the major release number (1 to 2 digits) - m is the minor release number (1 to 3 digits)
NAME
SPROX_ReaderGetRc500Id
DESCRIPTION
Retrieve the SpringProx reader chipset type and serial number
INPUTS
BYTE micore_type[5] : 5-byte buffer to receive the chipset type BYTE micore_snr[4] : 4-byte buffer to receive the chipset serial number
RETURNS
MI_OK : success Other code if internal or communication error has occured.
NOTES
Please refer to Philips MfRC5xx official documentation for explanation of the 5-byte chipset type identifier.
NAME
SPROX_ReaderReset
DESCRIPTION
Reset the device
INPUTS
none
RETURNS
MI_OK : success
NAME
SPROX_ReaderSetDeviceSettings
NOTES
This function is RFU and intentionaly left undocumented. Do not call it.
NAME
SPROX_SetIsoConfig
DESCRIPTION
Configure the reader in any available ISO mode
INPUTS
BYTE mode : can be either CFG_MODE_ISO_14443_A or CFG_MODE_ISO_14443_B
RETURNS
MI_OK : success Other code if internal or communication error has occured.