YRfidReader (Yoctopuce Java API 2.1.15129-SNAPSHOT API)

java.lang.Object
- com.yoctopuce.YoctoAPI.YFunction
- - com.yoctopuce.YoctoAPI.YRfidReader

```
public class YRfidReader
extends YFunction
```
YRfidReader Class: RfidReader function interface The YRfidReader class allows you to detect RFID tags, as well as read and write on these tags if the security settings allow it. Short reminder:
- A tag's memory is generally organized in fixed-size blocks.
- At tag level, each block must be read and written in its entirety.
- Some blocks are special configuration blocks, and may alter the tag's behavior if they are rewritten with arbitrary data.
- Data blocks can be set to read-only mode, but on many tags, this operation is irreversible.
By default, the RfidReader class automatically manages these blocks so that arbitrary size data can be manipulated of without risk and without knowledge of tag architecture.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YRfidReader.TimedReportCallback` TimedReportCallback for RfidReader
`static interface`	`YRfidReader.UpdateCallback` Deprecated UpdateCallback for RfidReader
`static interface`	`YRfidReader.YEventCallback` Specialized event Callback for RfidReader

Field Summary

Fields
Modifier and Type	Field and Description
`protected YRfidReader.YEventCallback`	`_eventCallback`
`protected int`	`_eventPos`
`protected int`	`_eventStamp`
`protected boolean`	`_isFirstCb`
`protected int`	`_nTags`
`protected int`	`_prevCbPos`
`protected int`	`_refreshRate`
`protected YRfidReader.UpdateCallback`	`_valueCallbackRfidReader`
`static int`	`NTAGS_INVALID` invalid nTags value
`static int`	`REFRESHRATE_INVALID` invalid refreshRate value

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID

Constructor Summary

Constructors
Modifier Constructor and Description

protected YRfidReader(String func)

protected YRfidReader(YAPIContext ctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YRfidReader(String func)`
`protected`	`YRfidReader(YAPIContext ctx, String func)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`_chkerror(String tagId, byte[] json, YRfidStatus status)`
`int`	`_internalEventHandler(String cbVal)`
`int`	`_invokeValueCallback(String value)`
`protected void`	`_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)`
`static YRfidReader`	`FindRfidReader(String func)` Retrieves a RFID reader for a given identifier.
`static YRfidReader`	`FindRfidReaderInContext(YAPIContext yctx, String func)` Retrieves a RFID reader for a given identifier in a YAPI context.
`static YRfidReader`	`FirstRfidReader()` Starts the enumeration of RFID readers currently accessible.
`static YRfidReader`	`FirstRfidReaderInContext(YAPIContext yctx)` Starts the enumeration of RFID readers currently accessible.
`String`	`get_lastEvents()` Returns a string with last tag arrival/removal events observed.
`int`	`get_nTags()` Returns the number of RFID tags currently detected.
`int`	`get_refreshRate()` Returns the tag list refresh rate, measured in Hz.
`ArrayList<String>`	`get_tagIdList()` Returns the list of RFID tags currently detected by the reader.
`YRfidTagInfo`	`get_tagInfo(String tagId, YRfidStatus status)` Returns a description of the properties of an existing RFID tag.
`ArrayList<Boolean>`	`get_tagLockState(String tagId, int firstBlock, int nBlocks, YRfidOptions options, YRfidStatus status)` Reads the locked state for RFID tag memory data blocks.
`ArrayList<Boolean>`	`get_tagSpecialBlocks(String tagId, int firstBlock, int nBlocks, YRfidOptions options, YRfidStatus status)` Tells which block of a RFID tag memory are special and cannot be used to store user data.
`int`	`getNTags()` Returns the number of RFID tags currently detected.
`int`	`getRefreshRate()` Returns the tag list refresh rate, measured in Hz.
`YRfidReader`	`nextRfidReader()` Continues the enumeration of RFID readers started using yFirstRfidReader().
`int`	`registerEventCallback(YRfidReader.YEventCallback callback)` Registers a callback function to be called each time that an RFID tag appears or disappears.
`int`	`registerValueCallback(YRfidReader.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`reset()`
`int`	`set_refreshRate(int newval)` Changes the present tag list refresh rate, measured in Hz.
`int`	`setRefreshRate(int newval)` Changes the present tag list refresh rate, measured in Hz.
`int`	`tagGetAFI(String tagId, YRfidOptions options, YRfidStatus status)` Reads an RFID tag AFI byte (ISO 15693 only).
`int`	`tagGetConfigByte(String tagId, int addr, YRfidOptions options, YRfidStatus status)` Reads a byte from the Tag configuration (ISO 15693 ST25DVxx only).
`int`	`tagGetDSFID(String tagId, YRfidOptions options, YRfidStatus status)` Reads an RFID tag DSFID byte (ISO 15693 only).
`int`	`tagLockAFI(String tagId, YRfidOptions options, YRfidStatus status)` Locks the RFID tag AFI byte (ISO 15693 only).
`int`	`tagLockBlocks(String tagId, int firstBlock, int nBlocks, YRfidOptions options, YRfidStatus status)` Changes an RFID tag configuration to prevents any further write to the selected blocks.
`int`	`tagLockDSFID(String tagId, YRfidOptions options, YRfidStatus status)` Locks the RFID tag DSFID byte (ISO 15693 only).
`ArrayList<Integer>`	`tagReadArray(String tagId, int firstBlock, int nBytes, YRfidOptions options, YRfidStatus status)` Reads data from an RFID tag memory, as a byte list.
`byte[]`	`tagReadBin(String tagId, int firstBlock, int nBytes, YRfidOptions options, YRfidStatus status)` Reads data from an RFID tag memory, as a binary buffer.
`String`	`tagReadHex(String tagId, int firstBlock, int nBytes, YRfidOptions options, YRfidStatus status)` Reads data from an RFID tag memory, as an hexadecimal string.
`String`	`tagReadStr(String tagId, int firstBlock, int nChars, YRfidOptions options, YRfidStatus status)` Reads data from an RFID tag memory, as a text string.
`int`	`tagSetAFI(String tagId, int afi, YRfidOptions options, YRfidStatus status)` Changes an RFID tag AFI byte (ISO 15693 only).
`int`	`tagSetConfigByte(String tagId, int addr, int value, YRfidOptions options, YRfidStatus status)` Changes a byte in the tag's configuration (ISO 15693 ST25DVxx only).
`int`	`tagSetDSFID(String tagId, int dsfid, YRfidOptions options, YRfidStatus status)` Changes an RFID tag DSFID byte (ISO 15693 only).
`int`	`tagSetPassword(String tagId, int passwordType, String password, YRfidOptions options, YRfidStatus status)` Set a password that will be required to access the tag (ISO 15693 ST25DVxx only).
`int`	`tagWriteArray(String tagId, int firstBlock, ArrayList<Integer> byteList, YRfidOptions options, YRfidStatus status)` Writes data provided as a list of bytes to an RFID tag memory.
`int`	`tagWriteBin(String tagId, int firstBlock, byte[] buff, YRfidOptions options, YRfidStatus status)` Writes data provided as a binary buffer to an RFID tag memory.
`int`	`tagWriteBinNFC(String tagId, String ndefType, byte[] payload, YRfidOptions options, YRfidStatus status)` Writes data provided as a binary object to an RFID tag, using NFC compatible encoding.
`int`	`tagWriteHex(String tagId, int firstBlock, String hexString, YRfidOptions options, YRfidStatus status)` Writes data provided as an hexadecimal string to an RFID tag memory.
`int`	`tagWriteStr(String tagId, int firstBlock, String text, YRfidOptions options, YRfidStatus status)` Writes data provided as an ASCII string to an RFID tag memory.
`int`	`tagWriteUrlNFC(String tagId, String url, YRfidOptions options, YRfidStatus status)` Writes an URL to an RFID tag using NFC compatible encoding, so that mobile phones with NFC support automatically offer to open the URL when reading the tag.
`int`	`tagWriteWifiConfigNFC(String tagId, String ssid, String auth, String secret, YRfidOptions options, YRfidStatus status)` Writes WiFi settings to an RFID tag using NFC compatible encoding, so that mobile phones with NFC support automatically offer to connect to this WiFi network.

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction
_AddToCache, _clearDataStreamCache, _decode_json_int, _decode_json_string, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _is_valid_pass, _json_get_array, _json_get_key, _json_get_string, _parse, _parserHelper, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, _uploadEx, clearCache, describe, errMessage, errorMessage, errorType, errType, FindFunction, FindFunctionInContext, FirstFunction, FirstFunctionInContext, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_hardwareId, get_logicalName, get_module, get_serialNumber, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, isReadOnly, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NTAGS_INVALID
```
public static final int NTAGS_INVALID
```
    invalid nTags value
    
    See Also:
    
    Constant Field Values
  - REFRESHRATE_INVALID
```
public static final int REFRESHRATE_INVALID
```
    invalid refreshRate value
    
    See Also:
    
    Constant Field Values
  - _nTags
```
protected int _nTags
```
  - _refreshRate
```
protected int _refreshRate
```
  - _valueCallbackRfidReader
```
protected YRfidReader.UpdateCallback _valueCallbackRfidReader
```
  - _eventCallback
```
protected YRfidReader.YEventCallback _eventCallback
```
  - _isFirstCb
```
protected boolean _isFirstCb
```
  - _prevCbPos
```
protected int _prevCbPos
```
  - _eventPos
```
protected int _eventPos
```
  - _eventStamp
```
protected int _eventStamp
```
- Constructor Detail
  - YRfidReader
```
protected YRfidReader(YAPIContext ctx,
                      String func)
```
    Parameters:
    
    func - : functionid
  - YRfidReader
```
protected YRfidReader(String func)
```
    Parameters:
    
    func - : functionid
- Method Detail
  - _parseAttr
```
protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception
```
    Overrides:
    
    _parseAttr in class YFunction
    
    Throws:
    
    Exception
  - get_nTags
```
public int get_nTags()
              throws YAPI_Exception
```
    Returns the number of RFID tags currently detected.
    
    Returns:
    
    an integer corresponding to the number of RFID tags currently detected
    
    Throws:
    
    YAPI_Exception - on error
  - getNTags
```
public int getNTags()
             throws YAPI_Exception
```
    Returns the number of RFID tags currently detected.
    
    Returns:
    
    an integer corresponding to the number of RFID tags currently detected
    
    Throws:
    
    YAPI_Exception - on error
  - get_refreshRate
```
public int get_refreshRate()
                    throws YAPI_Exception
```
    Returns the tag list refresh rate, measured in Hz.
    
    Returns:
    
    an integer corresponding to the tag list refresh rate, measured in Hz
    
    Throws:
    
    YAPI_Exception - on error
  - getRefreshRate
```
public int getRefreshRate()
                   throws YAPI_Exception
```
    Returns the tag list refresh rate, measured in Hz.
    
    Returns:
    
    an integer corresponding to the tag list refresh rate, measured in Hz
    
    Throws:
    
    YAPI_Exception - on error
  - set_refreshRate
```
public int set_refreshRate(int newval)
                    throws YAPI_Exception
```
    Changes the present tag list refresh rate, measured in Hz. The reader will do its best to respect it. Note that the reader cannot detect tag arrival or removal while it is communicating with a tag. Maximum frequency is limited to 100Hz, but in real life it will be difficult to do better than 50Hz. A zero value will power off the device radio. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the present tag list refresh rate, measured in Hz
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setRefreshRate
```
public int setRefreshRate(int newval)
                   throws YAPI_Exception
```
    Changes the present tag list refresh rate, measured in Hz. The reader will do its best to respect it. Note that the reader cannot detect tag arrival or removal while it is communicating with a tag. Maximum frequency is limited to 100Hz, but in real life it will be difficult to do better than 50Hz. A zero value will power off the device radio. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the present tag list refresh rate, measured in Hz
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - FindRfidReader
```
public static YRfidReader FindRfidReader(String func)
```
    Retrieves a RFID reader for a given identifier. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the RFID reader is online at the time it is invoked. The returned object is nevertheless valid. Use the method YRfidReader.isOnline() to test if the RFID reader is indeed online at a given time. In case of ambiguity when looking for a RFID reader by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name. If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
    Parameters:
    
    func - : a string that uniquely characterizes the RFID reader, for instance MyDevice.rfidReader.
    
    Returns:
    
    a YRfidReader object allowing you to drive the RFID reader.
  - FindRfidReaderInContext
```
public static YRfidReader FindRfidReaderInContext(YAPIContext yctx,
                                                  String func)
```
    Retrieves a RFID reader for a given identifier in a YAPI context. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the RFID reader is online at the time it is invoked. The returned object is nevertheless valid. Use the method YRfidReader.isOnline() to test if the RFID reader is indeed online at a given time. In case of ambiguity when looking for a RFID reader by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
    Parameters:
    
    yctx - : a YAPI context
    
    func - : a string that uniquely characterizes the RFID reader, for instance MyDevice.rfidReader.
    
    Returns:
    
    a YRfidReader object allowing you to drive the RFID reader.
  - registerValueCallback
```
public int registerValueCallback(YRfidReader.UpdateCallback callback)
```
    Registers the callback function that is invoked on every change of advertised value. The callback is then invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. The callback is called once juste after beeing registered, passing the current advertised value of the function, provided that it is not an empty string. To unregister a callback, pass a null pointer as argument.
    
    Parameters:
    
    callback - : the callback function to call, or a null pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.
  - _invokeValueCallback
```
public int _invokeValueCallback(String value)
```
    Overrides:
    
    _invokeValueCallback in class YFunction
  - _chkerror
```
public int _chkerror(String tagId,
                     byte[] json,
                     YRfidStatus status)
              throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - reset
```
public int reset()
          throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_tagIdList
```
public ArrayList<String> get_tagIdList()
                                throws YAPI_Exception
```
    Returns the list of RFID tags currently detected by the reader.
    
    Returns:
    
    a list of strings, corresponding to each tag identifier (UID).
    
    Throws:
    
    YAPI_Exception - on error
  - get_tagInfo
```
public YRfidTagInfo get_tagInfo(String tagId,
                                YRfidStatus status)
                         throws YAPI_Exception
```
    Returns a description of the properties of an existing RFID tag. This function can cause communications with the tag.
    
    Parameters:
    
    tagId - : identifier of the tag to check
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    a YRfidTagInfo object.
    
    Throws:
    
    YAPI_Exception - on error When it happens, you can get more information from the status object.
  - tagLockBlocks
```
public int tagLockBlocks(String tagId,
                         int firstBlock,
                         int nBlocks,
                         YRfidOptions options,
                         YRfidStatus status)
                  throws YAPI_Exception
```
    Changes an RFID tag configuration to prevents any further write to the selected blocks. This operation is definitive and irreversible. Depending on the tag type and block index, adjascent blocks may become read-only as well, based on the locking granularity. Note that some tags may allow only a few blocks to be locked, for instance ST25DVxxx tags allows a lock on block 0 and 1 only.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : first block to lock
    
    nBlocks - : number of blocks to lock
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - get_tagLockState
```
public ArrayList<Boolean> get_tagLockState(String tagId,
                                           int firstBlock,
                                           int nBlocks,
                                           YRfidOptions options,
                                           YRfidStatus status)
                                    throws YAPI_Exception
```
    Reads the locked state for RFID tag memory data blocks. FirstBlock cannot be a special block, and any special block encountered in the middle of the read operation will be skipped automatically.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : number of the first block to check
    
    nBlocks - : number of blocks to check
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    a list of booleans with the lock state of selected blocks
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - get_tagSpecialBlocks
```
public ArrayList<Boolean> get_tagSpecialBlocks(String tagId,
                                               int firstBlock,
                                               int nBlocks,
                                               YRfidOptions options,
                                               YRfidStatus status)
                                        throws YAPI_Exception
```
    Tells which block of a RFID tag memory are special and cannot be used to store user data. Mistakely writing a special block can lead to an irreversible alteration of the tag.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : number of the first block to check
    
    nBlocks - : number of blocks to check
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    a list of booleans with the lock state of selected blocks
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagReadHex
```
public String tagReadHex(String tagId,
                         int firstBlock,
                         int nBytes,
                         YRfidOptions options,
                         YRfidStatus status)
                  throws YAPI_Exception
```
    Reads data from an RFID tag memory, as an hexadecimal string. The read operation may span accross multiple blocks if the requested number of bytes is larger than the RFID tag block size. By default firstBlock cannot be a special block, and any special block encountered in the middle of the read operation will be skipped automatically. If you rather want to read special blocks, use the EnableRawAccess field from the options parameter.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : block number where read should start
    
    nBytes - : total number of bytes to read
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    an hexadecimal string if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagReadBin
```
public byte[] tagReadBin(String tagId,
                         int firstBlock,
                         int nBytes,
                         YRfidOptions options,
                         YRfidStatus status)
                  throws YAPI_Exception
```
    Reads data from an RFID tag memory, as a binary buffer. The read operation may span accross multiple blocks if the requested number of bytes is larger than the RFID tag block size. By default firstBlock cannot be a special block, and any special block encountered in the middle of the read operation will be skipped automatically. If you rather want to read special blocks, use the EnableRawAccess field frrm the options parameter.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : block number where read should start
    
    nBytes - : total number of bytes to read
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    a binary object with the data read if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagReadArray
```
public ArrayList<Integer> tagReadArray(String tagId,
                                       int firstBlock,
                                       int nBytes,
                                       YRfidOptions options,
                                       YRfidStatus status)
                                throws YAPI_Exception
```
    Reads data from an RFID tag memory, as a byte list. The read operation may span accross multiple blocks if the requested number of bytes is larger than the RFID tag block size. By default firstBlock cannot be a special block, and any special block encountered in the middle of the read operation will be skipped automatically. If you rather want to read special blocks, use the EnableRawAccess field from the options parameter.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : block number where read should start
    
    nBytes - : total number of bytes to read
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    a byte list with the data read if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagReadStr
```
public String tagReadStr(String tagId,
                         int firstBlock,
                         int nChars,
                         YRfidOptions options,
                         YRfidStatus status)
                  throws YAPI_Exception
```
    Reads data from an RFID tag memory, as a text string. The read operation may span accross multiple blocks if the requested number of bytes is larger than the RFID tag block size. By default firstBlock cannot be a special block, and any special block encountered in the middle of the read operation will be skipped automatically. If you rather want to read special blocks, use the EnableRawAccess field from the options parameter.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : block number where read should start
    
    nChars - : total number of characters to read
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    a text string with the data read if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagWriteBin
```
public int tagWriteBin(String tagId,
                       int firstBlock,
                       byte[] buff,
                       YRfidOptions options,
                       YRfidStatus status)
                throws YAPI_Exception
```
    Writes data provided as a binary buffer to an RFID tag memory. The write operation may span accross multiple blocks if the number of bytes to write is larger than the RFID tag block size. By default firstBlock cannot be a special block, and any special block encountered in the middle of the write operation will be skipped automatically. The last data block affected by the operation will be automatically padded with zeros if neccessary. If you rather want to rewrite special blocks as well, use the EnableRawAccess field from the options parameter.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : block number where write should start
    
    buff - : the binary buffer to write
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagWriteArray
```
public int tagWriteArray(String tagId,
                         int firstBlock,
                         ArrayList<Integer> byteList,
                         YRfidOptions options,
                         YRfidStatus status)
                  throws YAPI_Exception
```
    Writes data provided as a list of bytes to an RFID tag memory. The write operation may span accross multiple blocks if the number of bytes to write is larger than the RFID tag block size. By default firstBlock cannot be a special block, and any special block encountered in the middle of the write operation will be skipped automatically. The last data block affected by the operation will be automatically padded with zeros if neccessary. If you rather want to rewrite special blocks as well, use the EnableRawAccess field from the options parameter.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : block number where write should start
    
    byteList - : a list of byte to write
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagWriteHex
```
public int tagWriteHex(String tagId,
                       int firstBlock,
                       String hexString,
                       YRfidOptions options,
                       YRfidStatus status)
                throws YAPI_Exception
```
    Writes data provided as an hexadecimal string to an RFID tag memory. The write operation may span accross multiple blocks if the number of bytes to write is larger than the RFID tag block size. By default firstBlock cannot be a special block, and any special block encountered in the middle of the write operation will be skipped automatically. The last data block affected by the operation will be automatically padded with zeros if neccessary. If you rather want to rewrite special blocks as well, use the EnableRawAccess field from the options parameter.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : block number where write should start
    
    hexString - : a string of hexadecimal byte codes to write
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagWriteStr
```
public int tagWriteStr(String tagId,
                       int firstBlock,
                       String text,
                       YRfidOptions options,
                       YRfidStatus status)
                throws YAPI_Exception
```
    Writes data provided as an ASCII string to an RFID tag memory. The write operation may span accross multiple blocks if the number of bytes to write is larger than the RFID tag block size. Note that only the characters present in the provided string will be written, there is no notion of string length. If your string data have variable length, you'll have to encode the string length yourself, with a terminal zero for instannce. This function only works with ISO-latin characters, if you wish to write strings encoded with alternate character sets, you'll have to use tagWriteBin() function. By default firstBlock cannot be a special block, and any special block encountered in the middle of the write operation will be skipped automatically. The last data block affected by the operation will be automatically padded with zeros if neccessary. If you rather want to rewrite special blocks as well, use the EnableRawAccess field from the options parameter (definitely not recommanded).
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    firstBlock - : block number where write should start
    
    text - : the text string to write
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagWriteBinNFC
```
public int tagWriteBinNFC(String tagId,
                          String ndefType,
                          byte[] payload,
                          YRfidOptions options,
                          YRfidStatus status)
                   throws YAPI_Exception
```
    Writes data provided as a binary object to an RFID tag, using NFC compatible encoding. The function will automatically create a NFC Capability Container, and encapsulate the content with the required NDEF header corresponding to the given content type.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    ndefType - : the content type, either "U" for a URL, or a generic MIME type like "text/vcard"
    
    payload - : the payload of the NDEF record
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagWriteUrlNFC
```
public int tagWriteUrlNFC(String tagId,
                          String url,
                          YRfidOptions options,
                          YRfidStatus status)
                   throws YAPI_Exception
```
    Writes an URL to an RFID tag using NFC compatible encoding, so that mobile phones with NFC support automatically offer to open the URL when reading the tag.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    url - : the URL to write on the tag
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagWriteWifiConfigNFC
```
public int tagWriteWifiConfigNFC(String tagId,
                                 String ssid,
                                 String auth,
                                 String secret,
                                 YRfidOptions options,
                                 YRfidStatus status)
                          throws YAPI_Exception
```
    Writes WiFi settings to an RFID tag using NFC compatible encoding, so that mobile phones with NFC support automatically offer to connect to this WiFi network.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    ssid - : the SSID of the WiFi network to connect to
    
    auth - : the network authentication type (currently always "WPA2")
    
    secret - : the network password
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagGetAFI
```
public int tagGetAFI(String tagId,
                     YRfidOptions options,
                     YRfidStatus status)
              throws YAPI_Exception
```
    Reads an RFID tag AFI byte (ISO 15693 only).
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    the AFI value (0...255)
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagGetConfigByte
```
public int tagGetConfigByte(String tagId,
                            int addr,
                            YRfidOptions options,
                            YRfidStatus status)
                     throws YAPI_Exception
```
    Reads a byte from the Tag configuration (ISO 15693 ST25DVxx only). This function is actually a call to the 0xA0 RFID command and is specific to ST25DVxx tags. Check ST25DVxx datasheet for more information about the data organisation of ST25DVxx tags configuration.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    addr - : offset of the byte in the tag configuation
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    the requested byte value (0...255)
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagSetConfigByte
```
public int tagSetConfigByte(String tagId,
                            int addr,
                            int value,
                            YRfidOptions options,
                            YRfidStatus status)
                     throws YAPI_Exception
```
    Changes a byte in the tag's configuration (ISO 15693 ST25DVxx only). Warning: modifing the tag configation may alter its behavior in a non-reversible way. This operation requires the CONFIG_PWD password to be set in the options, default value is "0000000000000000" (16 zeros). This function is actually a call to the 0xA1 RFID command and is specific to ST25DVxx tags. Check ST25DVxx datasheet for more information about the data organisation of ST25DVxx tags configuration.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    addr - : address of the byte to write
    
    value - : the value to write (0...255)
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagSetPassword
```
public int tagSetPassword(String tagId,
                          int passwordType,
                          String password,
                          YRfidOptions options,
                          YRfidStatus status)
                   throws YAPI_Exception
```
    Set a password that will be required to access the tag (ISO 15693 ST25DVxx only). The password must be a string of characters representing 8 bytes in hexadecimal. There are several types of password for the same tag; please consult your tags documentation to understand their respective applications. Once the password has been configured, operations requiring this password must be initiated with the password defined in the KeyType and HexKey fields of the options parameter for the operations in question. It is not necessarily required to consistently provide the same password for every operation during the same session with a tag.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    passwordType - : type of password to be set (YRfidOptions.ST25D_CONFIG_PWD,YRfidOptions.ST25D_PWD1,YRfidOptions.ST25D_PWD2..)
    
    password - : the password (16 characters hex string encoding 8 bytes)
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagSetAFI
```
public int tagSetAFI(String tagId,
                     int afi,
                     YRfidOptions options,
                     YRfidStatus status)
              throws YAPI_Exception
```
    Changes an RFID tag AFI byte (ISO 15693 only).
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    afi - : the AFI value to write (0...255)
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagLockAFI
```
public int tagLockAFI(String tagId,
                      YRfidOptions options,
                      YRfidStatus status)
               throws YAPI_Exception
```
    Locks the RFID tag AFI byte (ISO 15693 only). This operation is definitive and irreversible.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagGetDSFID
```
public int tagGetDSFID(String tagId,
                       YRfidOptions options,
                       YRfidStatus status)
                throws YAPI_Exception
```
    Reads an RFID tag DSFID byte (ISO 15693 only).
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    the DSFID value (0...255)
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagSetDSFID
```
public int tagSetDSFID(String tagId,
                       int dsfid,
                       YRfidOptions options,
                       YRfidStatus status)
                throws YAPI_Exception
```
    Changes an RFID tag DSFID byte (ISO 15693 only).
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    dsfid - : the DSFID value to write (0...255)
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - tagLockDSFID
```
public int tagLockDSFID(String tagId,
                        YRfidOptions options,
                        YRfidStatus status)
                 throws YAPI_Exception
```
    Locks the RFID tag DSFID byte (ISO 15693 only). This operation is definitive and irreversible.
    
    Parameters:
    
    tagId - : identifier of the tag to use
    
    options - : an YRfidOptions object with the optional command execution parameters, such as security key if required
    
    status - : an RfidStatus object that will contain the detailled status of the operation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error happens, you can get more information from the status object.
  - get_lastEvents
```
public String get_lastEvents()
                      throws YAPI_Exception
```
    Returns a string with last tag arrival/removal events observed. This method return only events that are still buffered in the device memory.
    
    Returns:
    
    a string with last events observed (one per line).
    
    Throws:
    
    YAPI_Exception - on error
  - registerEventCallback
```
public int registerEventCallback(YRfidReader.YEventCallback callback)
                          throws YAPI_Exception
```
    Registers a callback function to be called each time that an RFID tag appears or disappears. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a null pointer as argument.
    
    Parameters:
    
    callback - : the callback function to call, or a null pointer. The callback function should take four arguments: the YRfidReader object that emitted the event, the UTC timestamp of the event, a character string describing the type of event ("+" or "-") and a character string with the RFID tag identifier.
    
    Throws:
    
    YAPI_Exception - on error
  - _internalEventHandler
```
public int _internalEventHandler(String cbVal)
                          throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - nextRfidReader
```
public YRfidReader nextRfidReader()
```
    Continues the enumeration of RFID readers started using yFirstRfidReader(). Caution: You can't make any assumption about the returned RFID readers order. If you want to find a specific a RFID reader, use RfidReader.findRfidReader() and a hardwareID or a logical name.
    
    Returns:
    
    a pointer to a YRfidReader object, corresponding to a RFID reader currently online, or a null pointer if there are no more RFID readers to enumerate.
  - FirstRfidReader
```
public static YRfidReader FirstRfidReader()
```
    Starts the enumeration of RFID readers currently accessible. Use the method YRfidReader.nextRfidReader() to iterate on next RFID readers.
    
    Returns:
    
    a pointer to a YRfidReader object, corresponding to the first RFID reader currently online, or a null pointer if there are none.
  - FirstRfidReaderInContext
```
public static YRfidReader FirstRfidReaderInContext(YAPIContext yctx)
```
    Starts the enumeration of RFID readers currently accessible. Use the method YRfidReader.nextRfidReader() to iterate on next RFID readers.
    
    Parameters:
    
    yctx - : a YAPI context.
    
    Returns:
    
    a pointer to a YRfidReader object, corresponding to the first RFID reader currently online, or a null pointer if there are none.

Class YRfidReader

Nested Class Summary

Field Summary

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction

Constructor Summary

Method Summary

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction

Methods inherited from class java.lang.Object

Field Detail

NTAGS_INVALID

REFRESHRATE_INVALID

_nTags

_refreshRate

_valueCallbackRfidReader

_eventCallback

_isFirstCb

_prevCbPos

_eventPos

_eventStamp

Constructor Detail

YRfidReader

YRfidReader

Method Detail

_parseAttr

get_nTags

getNTags

get_refreshRate

getRefreshRate

set_refreshRate

setRefreshRate

FindRfidReader

FindRfidReaderInContext

registerValueCallback

_invokeValueCallback

_chkerror

reset

get_tagIdList

get_tagInfo

tagLockBlocks

get_tagLockState

get_tagSpecialBlocks

tagReadHex

tagReadBin

tagReadArray

tagReadStr

tagWriteBin

tagWriteArray

tagWriteHex

tagWriteStr

tagWriteBinNFC

tagWriteUrlNFC

tagWriteWifiConfigNFC

tagGetAFI

tagGetConfigByte

tagSetConfigByte

tagSetPassword

tagSetAFI

tagLockAFI

tagGetDSFID

tagSetDSFID

tagLockDSFID

get_lastEvents

registerEventCallback

_internalEventHandler

nextRfidReader

FirstRfidReader

FirstRfidReaderInContext