com.yoctopuce.YoctoAPI

Class YRfidOptions

java.lang.Object

com.yoctopuce.YoctoAPI.YRfidOptions

public class YRfidOptions
extends Object

YRfidOptions Class: Additional parameters for operations on RFID tags. The YRfidOptions objects are used to specify additional optional parameters to RFID commands that interact with tags, including security keys. When instantiated,the parameters of this object are pre-initialized to a value which corresponds to the most common usage.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	DisableBoundaryChecks Disables the tag memory overflow test.
protected boolean	EnableDryRun Enables simulation mode to check the affected block range as well as access rights.
protected boolean	EnableRawAccess Enables direct access to RFID tag control blocks.
protected boolean	ForceMultiBlockAccess Forces the use of multi-block commands to access RFID tag memory blocks.
protected boolean	ForceSingleBlockAccess Forces the use of single-block commands to access RFID tag memory blocks.
protected String	HexKey Security key to be used to access the RFID tag, as an hexadecimal string.
protected int	KeyType Type of security key to be used to access the RFID tag.
static int	MIFARE_KEY_A
static int	MIFARE_KEY_B
static int	NO_RFID_KEY

Constructor Summary

Constructors

Constructor and Description
YRfidOptions()

Method Summary

Modifier and Type	Method and Description
String	imm_getParams()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_RFID_KEY

public static final int NO_RFID_KEY

See Also:

Constant Field Values

MIFARE_KEY_A

public static final int MIFARE_KEY_A

See Also:

Constant Field Values

MIFARE_KEY_B

public static final int MIFARE_KEY_B

See Also:

Constant Field Values

KeyType

protected int KeyType

Type of security key to be used to access the RFID tag. For MIFARE Classic tags, allowed values are Y_MIFARE_KEY_A or Y_MIFARE_KEY_B. The default value is Y_NO_RFID_KEY, in that case the reader will use the most common default key for the tag type. When a security key is required, it must be provided using property HexKey.

HexKey

protected String HexKey

Security key to be used to access the RFID tag, as an hexadecimal string. The key will only be used if you also specify which type of key it is, using property KeyType.

ForceSingleBlockAccess

protected boolean ForceSingleBlockAccess

Forces the use of single-block commands to access RFID tag memory blocks. By default, the Yoctopuce library uses the most efficient access strategy generally available for each tag type, but you can force the use of single-block commands if the RFID tags you are using do not support multi-block commands. If operation speed is not a priority, choose single-block mode as it will work with any mode.

ForceMultiBlockAccess

protected boolean ForceMultiBlockAccess

Forces the use of multi-block commands to access RFID tag memory blocks. By default, the Yoctopuce library uses the most efficient access strategy generally available for each tag type, but you can force the use of multi-block commands if you know for sure that the RFID tags you are using do support multi-block commands. Be aware that even if a tag allows multi-block operations, the maximum number of blocks that can be written or read at the same time can be (very) limited. If the tag does not support multi-block mode for the wanted operation, the option will be ignored.

EnableRawAccess

protected boolean EnableRawAccess

Enables direct access to RFID tag control blocks. By default, Yoctopuce library read and write functions only work on data blocks and automatically skip special blocks, as specific functions are provided to configure security parameters found in control blocks. If you need to access control blocks in your own way using read/write functions, enable this option. Use this option wisely, as overwriting a special block migth very well irreversibly alter your tag behavior.

DisableBoundaryChecks

protected boolean DisableBoundaryChecks

Disables the tag memory overflow test. By default, the Yoctopuce library's read/write functions detect overruns and do not run commands that are likely to fail. If you nevertheless wish to try to access more memory than the tag announces, you can try to use this option.

EnableDryRun

protected boolean EnableDryRun

Enables simulation mode to check the affected block range as well as access rights. When this option is active, the operation is not fully applied to the RFID tag but the affected block range is determined and the optional access key is tested on these blocks. The access key rights are not tested though. This option applies to write / configure operations only, it is ignored for read operations.

Constructor Detail

YRfidOptions

public YRfidOptions()

Method Detail

imm_getParams

public String imm_getParams()