Rc522

java.lang.Object
- com.galarzaa.androidthings.Rc522

```
public class Rc522
extends java.lang.Object
```
Library to interact with the RFID-RC522 module
Based on pi-rc22 by ondryaso

Author:

Allan Galarza

See Also:

MFRC522 Reference

Field Summary

Fields
Modifier and Type Field and Description

static byte AUTH_A
Authentication using Key A

static byte AUTH_B
Authentication using Key B

Fields
Modifier and Type	Field and Description
`static byte`	`AUTH_A` Authentication using Key A
`static byte`	`AUTH_B` Authentication using Key B

Constructor Summary

Constructors
Constructor and Description
`Rc522(android.content.Context context, com.google.android.things.pio.SpiDevice spiDevice, com.google.android.things.pio.Gpio resetPin)` Deprecated. use `Rc522(SpiDevice, Gpio)` instead.
`Rc522(com.google.android.things.pio.SpiDevice spiDevice, com.google.android.things.pio.Gpio resetPin)` Initializes RC522 with the configured SPI port and pins.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`antiCollisionDetect()` Checks for collision errors
`boolean`	`authenticateCard(byte authMode, byte address, byte[] key)` Authenticates the use of a specific address.
`boolean`	`authenticateCard(byte authMode, byte address, byte[] key, byte[] uid)` Deprecated. use `authenticateCard(byte, byte, byte[])` instead
`static byte[]`	`calculateAccessBits(byte[][] accessConditions)` Calculates the access bits for a sector trailer (bytes 6 to 7) based on Table 6 and Table 7 on MIFARE 1k's reference
`static byte[]`	`calculateAccessBits(byte[] c1, byte[] c2, byte[] c3)` Calculates the access bits for a sector trailer (bytes 6 to 7) based on Table 6 and Table 7 on MIFARE 1k's reference
`static byte[][]`	`calculateAccessConditions(byte[] accessBits)` Calculates the individual access conditions given the access bits
`static java.lang.String`	`dataToHexString(byte[] data)` Converts a data byte array to a string representing its 16 bytes in hexadecimal
`boolean`	`decreaseBlock(byte address, int operand)` Decreases the value of a block by the specified operand.
`java.lang.String`	`dumpMifare1k()` Dumps all the data in all data blocks in MIFARE 1K cards with default authentication keys.
`static byte`	`getBlockAddress(byte sector, byte block)` MIFARE tags blocks are organized in sectors, this calculates the address of a block in a specific sector
`static byte`	`getBlockAddress(int sector, int block)` MIFARE tags blocks are organized in sectors, this calculates the address of a block in a specific sector
`byte[]`	`getUid()` Gets the UID of the last card that was successfully read.
`java.lang.String`	`getUidString()` Returns a string representation of the last read tag's UID, separated by '-'
`java.lang.String`	`getUidString(java.lang.String separator)` Returns a string representation of the last read tag's UID
`byte[]`	`getUuid()` Deprecated. Method renamed, use `getUid()` instead
`boolean`	`increaseBlock(byte address, int operand)` Increases the value of a block by the specified operand.
`byte[]`	`readBlock(byte address)` Deprecated. Use `readBlock(byte, byte[])` as it can report read status
`boolean`	`readBlock(byte address, byte[] buffer)` Reads the current data stored in the tag's block.
`java.lang.Integer`	`readValue(byte address)` Reads a value block and converts the stored value
`boolean`	`request()` Requests for a tag
`boolean`	`request(byte requestMode)` Requests for a tag
`boolean`	`restoreBlock(byte address)` Writes on the transfer buffer the contents of a value block
`boolean`	`selectTag(byte[] uid)` Selects the tag to be used in following operations
`void`	`setDebugging(boolean debugging)`
`void`	`stopCrypto()` Ends operations that use crypto and cleans up
`boolean`	`transferBlock(byte address)` Writes the contents of the transfer buffer to a block
`boolean`	`write(byte address, byte[] data)` Deprecated. renamed to `writeBlock(byte, byte[])`.
`boolean`	`writeBlock(byte address, byte[] data)` Writes data to a block in the tag.
`boolean`	`writeTrailer(byte sector, byte[] keyA, byte[] accessBits, byte userData, byte[] keyB)` Writes a sector's trailer's data.
`boolean`	`writeValue(byte address, int value)` Writes a 32-bit signed integer to a value block in the required format The format is specified in section 8.6.2.1 in MIFARE 1k's datasheet Tag must be selected and block authenticated

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

- Field Detail
  - AUTH_A
```
public static final byte AUTH_A
```
    Authentication using Key A
    
    See Also:
    
    Constant Field Values
  - AUTH_B
```
public static final byte AUTH_B
```
    Authentication using Key B
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Rc522
```
@Deprecated
public Rc522(android.content.Context context,
                         com.google.android.things.pio.SpiDevice spiDevice,
                         com.google.android.things.pio.Gpio resetPin)
                  throws java.io.IOException
```
    Deprecated. use Rc522(SpiDevice, Gpio) instead.
    
    Initializes RC522 with the configured SPI port and pins.
    
    Parameters:
    
    context - Parameter no longer used, use Rc522(SpiDevice, Gpio) instead.
    
    spiDevice - SPI port used on the board
    
    resetPin - Pin connected to the RST pin on the RC522
    
    Throws:
    
    java.io.IOException
  - Rc522
```
public Rc522(com.google.android.things.pio.SpiDevice spiDevice,
             com.google.android.things.pio.Gpio resetPin)
      throws java.io.IOException
```
    Initializes RC522 with the configured SPI port and pins.
    
    Parameters:
    
    spiDevice - SPI port used on the board
    
    resetPin - Pin connected to the RST pin on the RC522
    
    Throws:
    
    java.io.IOException
- Method Detail
  - setDebugging
```
public void setDebugging(boolean debugging)
```
  - getUid
```
public byte[] getUid()
```
    Gets the UID of the last card that was successfully read. This may be empty if no card has been read before.
    
    Returns:
    
    A byte array containing the card's UID.
  - getUuid
```
@Deprecated
public byte[] getUuid()
```
    Deprecated. Method renamed, use getUid() instead
    
    Gets the UID of the last card that was successfully read. This may be empty if no card has been read before.
  - getUidString
```
public java.lang.String getUidString(java.lang.String separator)
```
    Returns a string representation of the last read tag's UID
    
    Parameters:
    
    separator - The character that separates each element of the uid
    
    Returns:
    
    A string representing the tag's UID
  - getUidString
```
public java.lang.String getUidString()
```
    Returns a string representation of the last read tag's UID, separated by '-'
  - request
```
public boolean request()
```
    Requests for a tag
    
    Returns:
    
    true if a tag is present
  - request
```
public boolean request(byte requestMode)
```
    Requests for a tag
    
    Parameters:
    
    requestMode - the type of request being made
    
    Returns:
    
    true if a tag is present
  - antiCollisionDetect
```
public boolean antiCollisionDetect()
```
    Checks for collision errors
    
    Returns:
    
    true if there are no collision errors
  - selectTag
```
public boolean selectTag(byte[] uid)
```
    Selects the tag to be used in following operations
    
    Parameters:
    
    uid - Byte array containing the tag's uid
    
    Returns:
    
    true if no errors occurred
  - authenticateCard
```
public boolean authenticateCard(byte authMode,
                                byte address,
                                byte[] key)
```
    Authenticates the use of a specific address. The tag must be selected before. For reference, see section 10.3.1.9 MFAuthent in MFRC522's datasheet
    
    Parameters:
    
    authMode - The authentication mode, AUTH_A or AUTH_B
    
    address - The byte address of the block to authenticate for
    
    key - A six byte array containing the key used to authenticate
    
    Returns:
    
    true if authentication was successful
  - authenticateCard
```
@Deprecated
public boolean authenticateCard(byte authMode,
                                            byte address,
                                            byte[] key,
                                            byte[] uid)
```
    Deprecated. use authenticateCard(byte, byte, byte[]) instead
    
    Authenticates the use of a specific address. The tag must be selected before. For reference, see section 10.3.1.9 MFAuthent in MFRC522's datasheet
    
    Parameters:
    
    authMode - The authentication mode, AUTH_A or AUTH_B
    
    address - The byte address of the block to authenticate for
    
    key - A six byte array containing the key used to authenticate
    
    uid - The tag's UID
    
    Returns:
    
    true if authentication was successful
  - stopCrypto
```
public void stopCrypto()
```
    Ends operations that use crypto and cleans up
  - readBlock
```
public boolean readBlock(byte address,
                         byte[] buffer)
```
    Reads the current data stored in the tag's block. Authentication is required
    
    Parameters:
    
    address - the address of the block to read data from
    
    buffer - the byte array to store the read data to. Length must be 16
    
    Returns:
    
    true if reading was successful
  - readBlock
```
@Deprecated
public byte[] readBlock(byte address)
```
    Deprecated. Use readBlock(byte, byte[]) as it can report read status
    
    Reads the current data stored in the tag's block. Authentication is required
    
    Parameters:
    
    address - the byte address of the block to read from
    
    Returns:
    
    16 bytes array of the current value in that block
  - writeBlock
```
public boolean writeBlock(byte address,
                          byte[] data)
```
    Writes data to a block in the tag. Authentication is required.
    
    Parameters:
    
    address - the byte address of the block to write to
    
    data - 16 byte array with the data that wants to be written
    
    Returns:
    
    true if writing was successful
  - write
```
@Deprecated
public boolean write(byte address,
                                 byte[] data)
```
    Deprecated. renamed to writeBlock(byte, byte[]).
    
    Writes data to a block in the tag. Authentication is required.
    
    Parameters:
    
    address - the byte address of the block to write to
    
    data - 16 byte array with the data that wants to be written
  - increaseBlock
```
public boolean increaseBlock(byte address,
                             int operand)
```
    Increases the value of a block by the specified operand. The data is stored in the internal transfer buffer. The block must be a value block. Tag must be selected and block authenticated
    
    Parameters:
    
    address - the block's address
    
    operand - the sum's operand
    
    Returns:
    
    true if operation was successful
  - decreaseBlock
```
public boolean decreaseBlock(byte address,
                             int operand)
```
    Decreases the value of a block by the specified operand. The data is stored in the internal transfer buffer. The block must be a value block. Tag must be selected and block authenticated
    
    Parameters:
    
    address - the block's address
    
    operand - the substraction's operand
    
    Returns:
    
    true if operation was successful
  - transferBlock
```
public boolean transferBlock(byte address)
```
    Writes the contents of the transfer buffer to a block
    
    Parameters:
    
    address - the address of the block to write to
    
    Returns:
    
    true if operation was successful
  - restoreBlock
```
public boolean restoreBlock(byte address)
```
    Writes on the transfer buffer the contents of a value block
    
    Parameters:
    
    address - the address of the block to read from
    
    Returns:
    
    true if operation was successful
  - writeValue
```
public boolean writeValue(byte address,
                          int value)
```
    Writes a 32-bit signed integer to a value block in the required format The format is specified in section 8.6.2.1 in MIFARE 1k's datasheet Tag must be selected and block authenticated
    
    Parameters:
    
    address - the block's address
    
    value - new value to be written to the block
    
    Returns:
    
    true if writing was successful
  - readValue
```
@Nullable
public java.lang.Integer readValue(byte address)
```
    Reads a value block and converts the stored value
    
    Parameters:
    
    address - the block's address
    
    Returns:
    
    null,if read failed, otherwise it returns an Integer object containing the 32-bit signed value
  - writeTrailer
```
public boolean writeTrailer(byte sector,
                            byte[] keyA,
                            byte[] accessBits,
                            byte userData,
                            byte[] keyB)
```
    Writes a sector's trailer's data. This block contains the access configuration for the entire sector, caution must be taken when modifying its contents as it can lead to inaccessible sectors. Please refer to the tag's documentation Tag must be selected and sector authenticated first
    
    Parameters:
    
    sector - the sector's number
    
    keyA - the new key A that will be set
    
    accessBits - the access bits that will be set. Can be obtained with calculateAccessBits(byte[], byte[], byte[])
    
    userData - a single byte containing user data
    
    keyB - the new key B that will be set
    
    Returns:
    
    true if writing was successful, false otherwise or if parameters are invalid
    
    See Also:
    
    Reference sheet
  - getBlockAddress
```
public static byte getBlockAddress(byte sector,
                                   byte block)
```
    MIFARE tags blocks are organized in sectors, this calculates the address of a block in a specific sector
    
    Parameters:
    
    sector - the sector number
    
    block - the sector's block
    
    Returns:
    
    the block's absolute address
  - getBlockAddress
```
public static byte getBlockAddress(int sector,
                                   int block)
```
    MIFARE tags blocks are organized in sectors, this calculates the address of a block in a specific sector
    
    Parameters:
    
    sector - the sector number
    
    block - the sector's block
  - dataToHexString
```
public static java.lang.String dataToHexString(byte[] data)
```
    Converts a data byte array to a string representing its 16 bytes in hexadecimal
    
    Parameters:
    
    data - the byte array holding the data
    
    Returns:
    
    A string representing the block's data
  - dumpMifare1k
```
public java.lang.String dumpMifare1k()
```
    Dumps all the data in all data blocks in MIFARE 1K cards with default authentication keys. Card must be selected using selectTag(byte[]) before This won't work if a sector's KEY A or access bits have been changed
    
    Returns:
    
    string containing all the data
  - calculateAccessBits
```
public static byte[] calculateAccessBits(byte[] c1,
                                         byte[] c2,
                                         byte[] c3)
```
    Calculates the access bits for a sector trailer (bytes 6 to 7) based on Table 6 and Table 7 on MIFARE 1k's reference
    
    Parameters:
    
    c1 - byte array for the c1 values for block 0, 1, 2 and 3 respectively
    
    c2 - byte array for the c2 values for block 0, 1, 2 and 3 respectively
    
    c3 - byte array for the c3 values for block 0, 1, 2 and 3 respectively
    
    Returns:
    
    a 3 byte array containing the access bits
    
    See Also:
    
    Reference sheet
  - calculateAccessBits
```
public static byte[] calculateAccessBits(byte[][] accessConditions)
```
    Calculates the access bits for a sector trailer (bytes 6 to 7) based on Table 6 and Table 7 on MIFARE 1k's reference
    
    Parameters:
    
    accessConditions - a 2d array containing the access conditions for each block
    
    Returns:
    
    a 3 byte array containing the access bits
  - calculateAccessConditions
```
public static byte[][] calculateAccessConditions(byte[] accessBits)
```
    Calculates the individual access conditions given the access bits
    
    Parameters:
    
    accessBits - 3 bytes array containing the access bits of a sector trailer (bytes 6 to 7)
    
    Returns:
    
    a 3-item array representing each of the access conditions (c1,c2,c3), each containing a byte array for the values of each block (0 to 3)

Class Rc522

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTH_A

AUTH_B

Constructor Detail

Rc522

Rc522

Method Detail

setDebugging

getUid

getUuid

getUidString

getUidString

request

request

antiCollisionDetect

selectTag

authenticateCard

authenticateCard

stopCrypto

readBlock

readBlock

writeBlock

write

increaseBlock

decreaseBlock

transferBlock

restoreBlock

writeValue

readValue

writeTrailer

getBlockAddress

getBlockAddress

dataToHexString

dumpMifare1k

calculateAccessBits

calculateAccessBits

calculateAccessConditions