TABLE OF CONTENTS

 

[Modules] ISO15693

NAME

   SpringProxAPI :: ISO 15693

DESCRIPTION

   Implementation of ISO/IEC 15693 (and ICODE1)

[Functions] SPROX_I1_Halt

NAME

   SPROX_I1_Halt

DESCRIPTION

   Send the ICODE1 HALT command to the currently selected card.

INPUTS

   none

RETURNS

   MI_OK              : success, card halted
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_I1_SelectAny
   SPROX_I1_Write
   SPROX_I1_Read

[Functions] SPROX_I1_Read

NAME

   SPROX_I1_Read

DESCRIPTION

   Read multiple blocks of a ICODE1 tag.

INPUTS

   BYTE bloc           : address of the first block to read
   BYTE nb_bloc        : number of blocks to read
   const BYTE *data    : buffer to receive the data
   const WORD *datalen : length of the receive data

RETURNS

   MI_OK              : success, data have been read
   MI_NOTAGERR        : the required tag is not available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_I1_SelectAny
   SPROX_I1_Halt
   SPROX_I1_Write

[Functions] SPROX_I1_SelectAny

NAME

   SPROX_I1_SelectAny

DESCRIPTION

   Select "Any" ISO 15693 card available in the RF field

INPUTS

   BOOL fast_mode     : RF setting mode (TRUE = fast mode, False = standard mode)
   BYTE snr[8]        : 8-byte buffer to receive card's Unique ID

RETURNS

   MI_OK              : success, card selected
   MI_NOTAGERR        : no card available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_I1_SelectAny
   SPROX_I1_Write
   SPROX_I1_Read

[Functions] SPROX_I1_Write

NAME

   SPROX_I1_Write

DESCRIPTION

   Write bytes in a block of a ICODE1 tag.

INPUTS

   BYTE bloc          : address of the block to write
   BYTE data[4]       : buffer of data

RETURNS

   MI_OK              : success, data have been written
   MI_NOTAGERR        : the required tag is not available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_I1_SelectAny
   SPROX_I1_Halt
   SPROX_I1_Read

[Functions] SPROX_Iso15693_Halt

NAME

   SPROX_Iso15693_Halt

DESCRIPTION

   Send the ISO 15693 HALT command to the currently selected card.

INPUTS

   none

RETURNS

   MI_OK              : success, card halted
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_Iso15693_SelectAny
   SPROX_Iso15693_SelectAgain

[Functions] SPROX_Iso15693_LockBlock

NAME

   SPROX_Iso15693_LockBlock

DESCRIPTION

   Lock permanently one 4-byte block of a ISO 15693 tag.

INPUTS

   const BYTE snr[8]  : 8-byte UID of the ISO 15693 card to read
                        If NULL, the reader will work with currently selected tag
   BYTE bloc          : address of the block to write

WARNING

   When a block is locked, it will be imposssible to change the value of block again.

   For more details, please refer to specific tag documentation.

RETURNS

   MI_OK              : success, data have been written
   MI_NOTAGERR        : the required tag is not available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_15693_IsoWriteBlock
   SPROX_15693_IsoReadBlock

[Functions] SPROX_Iso15693_ReadMultipleBlocks

NAME

   SPROX_Iso15693_ReadMultipleBlocks

DESCRIPTION

   Read multiple blocks of a ISO 15693 tag, using the "read multiple blocks" command.

INPUTS

   const BYTE snr[8]   : 8-byte UID of the ISO 15693 card to read
                         If NULL, the reader will work with currently selected tag
   BYTE bloc           : address of the first block to read
   BYTE nb_bloc        : number of blocks to read
   BYTE data[]         : buffer to receive the data
   WORD *datalen       : length of the receive data

WARNING

   The number of blocks available on a ISO 15693 tag depends on the tag type.

   For example, a ISO 15693 ICODE-SLI tag stores 28 blocks (address 0 to 27), a
   ISO 15693 ICODE-SLI-L tag stores 8 blocks (address 0 to 7), a ISO 15693 Tag-It
   Plus Inlay tag stores 64 blocks (address 0 to 63).

   For more details, please refer to specific tag documentation.

RETURNS

   MI_OK              : success, data have been read
   MI_NOTAGERR        : the required tag is not available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_Iso15693_ReadSingleBlock
   SPROX_Iso15693_ReadMultipleBytes
   SPROX_Iso15693_WriteBlock
   SPROX_Iso15693_LockBlock

[Functions] SPROX_Iso15693_ReadMultipleBytes

NAME

   SPROX_Iso15693_ReadMultipleBytes

DESCRIPTION

   Read multiple bytes of a ISO 15693 tag.

INPUTS

   const BYTE snr[8]   : 8-byte UID of the ISO 15693 card to read
                         If NULL, the reader will work with currently selected tag
   BYTE bloc           : address of the first block to read
   BYTE data[]         : buffer to receive the data
   WORD *datalen       : length of the receive data

WARNING

   The number of blocks available on a ISO 15693 tag depends on the tag type.

   For example, a ISO 15693 ICODE-SLI tag stores 28 blocks (address 0 to 27), a
   ISO 15693 ICODE-SLI-L tag stores 8 blocks (address 0 to 7), a ISO 15693 Tag-It
   Plus Inlay tag stores 64 blocks (address 0 to 63).

   For more details, please refer to specific tag documentation.

RETURNS

   MI_OK              : success, data have been read
   MI_NOTAGERR        : the required tag is not available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_Iso15693_ReadSingleBlock
   SPROX_Iso15693_ReadMultipleBlocks
   SPROX_Iso15693_WriteBlock
   SPROX_Iso15693_LockBlock

[Functions] SPROX_Iso15693_ReadSingleBlock

NAME

   SPROX_Iso15693_ReadSingleBlock

DESCRIPTION

   Read one block of a ISO 15693 tag.

INPUTS

   const BYTE snr[8]   : 8-byte UID of the ISO 15693 card to read
                         If NULL, the reader will work with currently selected tag
   BYTE bloc           : address of the block to read
   BYTE data[]         : buffer to receive the data
   WORD *datalen       : length of the receive data

WARNING

   The number of blocks available on a ISO 15693 tag depends on the tag type.

   For example, a ISO 15693 ICODE-SLI tag stores 28 blocks (address 0 to 27), a
   ISO 15693 ICODE-SLI-L tag stores 8 blocks (address 0 to 7), a ISO 15693 Tag-It
   Plus Inlay tag stores 64 blocks (address 0 to 63).

   For more details, please refer to specific tag documentation.

RETURNS

   MI_OK              : success, data have been read
   MI_NOTAGERR        : the required tag is not available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_Iso15693_ReadMultipleBlocks
   SPROX_Iso15693_ReadMultipleBytes
   SPROX_Iso15693_WriteBlock
   SPROX_Iso15693_LockBlock

[Functions] SPROX_Iso15693_SelectAgain

NAME

   SPROX_Iso15693_SelectAgain

DESCRIPTION

   Allow to re-select an ISO 15693 card, provided its serial number.

INPUTS

   BYTE snr[8]        : 8-byte buffer to receive card's Unique ID

RETURNS

   MI_OK              : success, card selected
   MI_NOTAGERR        : the required card is not available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_Iso15693_SelectAny
   SPROX_Iso15693_Halt

[Functions] SPROX_Iso15693_SelectAny

NAME

   SPROX_Iso15693_SelectAny

DESCRIPTION

   Select "Any" ISO 15693 card available in the RF field

INPUTS

   BOOL fast_mode     : RF setting mode (TRUE = fast mode, False = standard mode)
   BYTE snr[8]        : 8-byte buffer to receive card's Unique ID

RETURNS

   MI_OK              : success, card selected
   MI_NOTAGERR        : no card available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_Iso15693_SelectAgain
   SPROX_Iso15693_Halt

[Functions] SPROX_Iso15693_WriteBlock

NAME

   SPROX_Iso15693_WriteBlock

DESCRIPTION

   Write bytes in a block of a ISO 15693 tag.

INPUTS

   const BYTE snr[8]  : 8-byte UID of the ISO 15693 card to read
                        If NULL, the reader will work with currently selected tag
   BYTE bloc          : address of the block to write
   BYTE data[]        : buffer of data
   WORD datalen       : length of data

RETURNS

   MI_OK              : success, data have been written
   MI_NOTAGERR        : the required tag is not available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_15693_IsoReadBlock
   SPROX_15693_IsoLockBlock

[Functions] Iso15693_GetSystemInformation

SYNOPSIS

   SBYTE Iso15693_GetSystemInformation(BYTE *data, WORD *datalen)

DESCRIPTION

   Get system information in a ISO 15693 tag.
   The target card is the currently selected one (which params are loaded
   into vicc_tag).

INPUTS

   const BYTE snr[8]  : 8-byte UID of the ISO 15693 card to read
                         If NULL, the reader will work with currently selected tag
   BYTE *data         : data buffer (out)
   WORD *datalen      : length of data buffer (in or out)

WARNING

   For more details, please refer to specific tag documentation.

RETURNS

   MI_OK              : success, data have been read
   MI_NOTAGERR        : the required tag is not available in the RF field
   Other code if internal or communication error has occured. 

SEE ALSO

   SPROX_Iso15693_ReadMultipleBlocks
   SPROX_Iso15693_ReadMultipleBytes
   SPROX_Iso15693_WriteBlock
   SPROX_Iso15693_LockBlock

Generated from sprox_15693.c on Mon Jan 30 14:25:25 2012