Internal parameters of the PN532 to configure its behavior regarding different cases.

Type: number

Stores registered middlewares to be compose. Middleware is similar to hooks. middleware will be compose and execute in order at specific key hook.

Type: object

Stores registered plugins

Type: Map

Buffer of unhandled response

Type: Array<PN532Frame>

Buffer of unhandled response bytes

Type: Packet

A TransformStream to send frame to Adapter

Type: TransformStream

A TransformStream to read frame from Adapter

Type: TransformStream

install a plugin instance to this PN532 instance.

// setup
const {
  _, // lodash: https://cdn.jsdelivr.net/npm/lodash@4/lodash.min.js
  Pn532: { Pn532, Packet, utils: Pn532utils },
  Crypto1,
  Pn532Hf14a,
  Pn532WebbleAdapter,
  Pn532WebserialAdapter,
} = window

const pn532usb = new Pn532()
pn532usb.use(new Pn532WebserialAdapter())

Determines whether pluginId has been installed.

Middleware is similar to hooks. middleware will be compose and execute in order at specific key hook.

Write Packet to Adapter

Send a command to adapter via PN532 noraml frame.

Send a command to adapter via PN532 extended frame.

Send a Wakeup Command.

Reset parameters and internal registers of PN532 to default value.

Clear the buffer of unhandled response.

Read any response or specific response from adapter.

This command is designed for self-diagnosis.

This test is for communication test between host controller and the PN532. "Parameter Length" and "Parameters" in response packet are same as "Parameter Length" and "Parameter" in command packet.

This test is for checking ROM data by 8 bits checksum.

This test is for checking RAM; 768 bytes of XRAM and 128 bytes of IDATA. The test method used consists of saving original content, writing test data, checking test data and finally restore original data. So, this test is non destructive.

This test is for checking the percentage of failure regarding response packet receiving after polling command transmission. In this test, the PN532 sends a FeliCa polling command packet 128 times to target. The PN532 counts the number of fails and returns the failed number to host controller. This test doesn’t require specific system code for target.

Polling is done with system code (0xFF, 0xFF). The baud rate used is either 212 kbps or 424 kbps.

One polling is considered as defective after no correct polling response within 4 ms. During this test, the analog settings used are those defined in command RFConfiguration within the item n°7 (§7.3.1, p: 101).

This test can be used by an initiator to ensure that a target/card is still in the field:

• In case of DEP target, an Attention Request command is sent to the target, and it is expected to receive the same answer from the target. In that case, the test is declared as successful;
• In case of ISO/IEC14443-4 card, a R(NACK) block is sent to the card and it is expected to receive either a R(ACK) block or the last I-Block. In that case, the test is declared as successful (ISO/IEC14443-4 card is still in the RF field).

This test is used to check the continuity of the transmission paths of the antenna.

The PN532 sends back the version of the embedded firmware.

• res.firmware (string): Version and revision of the firmware.
• res.ic (string): Version of the IC. For PN532, the value is PN532.
• res.iso14443a (boolean): Indicating whether or not support ISO/IEC 14443 TypeA
• res.iso14443b (boolean): Indicating whether or not support ISO/IEC 14443 TypeB
• res.iso18092 (boolean): Indicating whether or not support ISO18092

This command is used to read the content of one or several internal registers of the PN532 (located either in the SFR area or in the XRAM memory space).

This command is used to overwrite the content of one or several internal registers of the PN532 (located either in the SFR area or in the XRAM memory space).

This command is used to update the masked value of several internal registers of the PN532 (located either in the SFR area or in the XRAM memory space).

The PN532 reads the value for each port and returns the information to the host controller.

The PN532 applies the value for each port that is validated by the host controller.

This command is used to set internal parameters of the PN532, and then to configure its behavior regarding different cases.

This command is used to select the data flow path by configuring the internal serial data switch.

This command is used to configure the different settings of the PN532 as described in the input section of this command.

Switching on or off the RF field immediately.

When the bit AutoRFCA is off, the PN532 does not need to take care of external field before switching on its own field. In other words, if the bit AutoRFCA is off and RFon/off is on, the PN532 will generate RF field whatever external field is (present or not).

Set timeouts of PN532.

Define the number of retries that the PN532 will use in case of the following processes.

This command is used to detect as many targets (maximum MaxTg) as possible in passive mode.

This command is used to support protocol data exchanges between the PN532 as initiator and a target.

This command is used to support basic data exchanges between the PN532 and a target.

This command is used to deselect the target(s) Tg. The PN532 keeps all the information relative to this target.

This command is used to release the target(s) Tg.

This command is used to select the target Tg.

This command is used to poll card(s) / target(s) of specified Type present in the RF field.

Returns a new Packet object initialized from one of the ArrayBuffer views

const pack = Packet.fromView(new Uint8Array([1]))

Returns a new Packet object initialized from a string of hex numbers.

console.log(Packet.fromHex('01020304').hex)
// 01020304
console.log(Packet.fromHex('01020304', true).hex)
// 04030201

Returns a new Packet object initialized from a base64 or base64url string.

console.log(Packet.fromBase64('AA==').base64url) // AA

Returns a new Packet object initialized from a utf8 string.

const pack = Packet.fromUtf8('Hello world.')

Returns a new Packet which is the result of concatenating all the Packet instances in the packs together.

If the packs has no items, then a new zero-length Packet is returned.

const pack = Packet.merge(Packet.fromUtf8('Hello '), Packet.fromUtf8('world.'))

Determines whether pack is instance of Packet and pack.length is equal to len. pack.length will not be validated if len is null.

if (!Packet.isLen(key, 6)) throw new TypeError('invalid key')

Determines whether the two Packet has the same data.

const pack1 = new Packet([1, 2])
const pack2 = new Packet([3, 4])
if (!pack1.isEqual(pack2)) throw new Error('not equal')

Creates a new array of Packet with length of bytesPerChunk. The final chunk will be the remaining data if length isn't multiple of bytesPerChunk.

console.log(JSON.stringify(Packet.fromHex('00010203040506').chunk(3)))
// ["Packet(3): 000102","Packet(3): 030405","Packet(1): 06"]

The xor value of every byte in the Packet.

Type: number

console.log(Packet.fromHex('01020304').xor)
// 4

hex string of the Packet

Type: string

console.log(Packet.fromHex('123456').hex)
// 123456

reversed hex string of the Packet

Type: string

console.log(Packet.fromHex('123456').rhex)
// 563412

A string with format Packet(length): hex

Type: string

console.log(Packet.fromHex('123456').inspect)
// Packet(3): 12 34 56

utf8 string of the Packet

Type: string

console.log(Packet.fromHex('616263').utf8)
// abc

base64 string of the Packet

Type: string

console.log(Packet.fromHex('616263').base64)
// YWJj

base64url string of the Packet

Type: string

console.log(Packet.fromHex('616263').base64url)
// YWJj

The byteOffset of the Packets underlying ArrayBuffer object.

Type: number

console.log(Packet.fromHex('616263').offset)
// 0

the member function will be invoked when using JSON.stringify

the member function will be invoked when convert Packet to string.

Get a signed 64-bit integer (long long) at the specified byte offset from the start of the Packet.

Get an unsigned 64-bit integer (unsigned long long) at the specified byte offset from the start of the Packet.

Get a signed 32-bit float (float) at the specified byte offset from the start of the Packet.

Get a signed 64-bit float (double) at the specified byte offset from the start of the Packet.

Get a signed 16-bit integer (short) at the specified byte offset from the start of the Packet.

Get a signed 32-bit integer (long) at the specified byte offset from the start of the Packet.

Get a signed 8-bit integer (byte) at the specified byte offset from the start of the Packet.

Get an unsigned 16-bit integer (unsigned short) at the specified byte offset from the start of the Packet.

Get an unsigned 32-bit integer (unsigned long) at the specified byte offset from the start of the Packet.

Get an unsigned 8-bit integer (unsigned byte) at the specified byte offset from the start of the Packet.

Store a signed 64-bit integer (long long) value at the specified byte offset from the start of the Packet.

Store an unsigned 64-bit integer (unsigned long long) value at the specified byte offset from the start of the Packet.

Store a signed 32-bit float (float) value at the specified byte offset from the start of the Packet.

Store a signed 64-bit float (double) value at the specified byte offset from the start of the Packet.

Store a signed 16-bit integer (short) value at the specified byte offset from the start of the Packet.

Store a signed 32-bit integer (long) value at the specified byte offset from the start of the Packet.

Store a signed 8-bit integer (byte) value at the specified byte offset from the start of the Packet.

Store an unsigned 16-bit integer (unsigned short) value at the specified byte offset from the start of the Packet.

Store an unsigned 32-bit integer (unsigned long) value at the specified byte offset from the start of the Packet.

Store an unsigned 8-bit integer (unsigned byte) value at the specified byte offset from the start of the Packet.

Get an unsigned 24-bit integer at the specified byte offset from the start of the Packet.

Store an unsigned 24-bit integer value at the specified byte offset from the start of the Packet.

Get a signed 24-bit integer at the specified byte offset from the start of the Packet.

Store a signed 24-bit integer value at the specified byte offset from the start of the Packet.

Get a bit value at the specified bit offset from the Packet.

Store a bit value at the specified bit offset from the Packet.

Get bit of the unsigned reversed endian 32-bit integer x at position n.

const { Crypto1 } = window

console.log(Crypto1.beBit(0x01000000, 0)) // 1

Get bit of the unsigned 32-bit integer x at position n.

const { Crypto1 } = window

console.log(Crypto1.bit(0x1, 0)) // 1

Cast the number x to bit.

const { Crypto1 } = window

console.log(Crypto1.toBit(1)) // 1
console.log(Crypto1.toBit(2)) // 0

Indicates whether the number is truly or not.

const { Crypto1 } = window

console.log(Crypto1.toBool(1)) // 1
console.log(Crypto1.toBool(2)) // 1

Cast the number x to unsigned 24-bit integer.

const { Crypto1 } = window

console.log(Crypto1.toUint24(-1).toString(16)) // 'ffffff'

Cast the number x to unsigned 32-bit integer.

const { Crypto1 } = window

console.log(Crypto1.toUint32(-1).toString(16)) // 'ffffffff'

Cast the number x to unsigned 8-bit integer.

const { Crypto1 } = window

console.log(Crypto1.toUint8(-1).toString(16)) // 'ff'

The filter function of Crypto1.

Return the even parity of the unsigned 8-bit integer x.

Return the even parity of the unsigned 32-bit integer x.

Swap endian of the unsigned 32-bit integer x.

const { Crypto1 } = window

console.log(Crypto1.swapEndian(0x12345678).toString(16)) // '78563412'

Generate the new prng state from the current prng state x by n times.

A helper function to calculates the partial linear feedback contributions and puts in MSB (Most Significant Bit).

Using a bit of the keystream extend the table of possible lfsr states. (complex version)

Using a bit of the keystream extend the table of possible lfsr states. (simple version)

Recursively narrow down the search space, 4 bits of keystream at a time.

Recover the state of the lfsr given 32 bits of the keystream. Additionally you can use the in parameter to specify the value that was fed into the lfsr at the time the keystream was generated

Reverse 64 bits of keystream into possible lfsr states. Variation mentioned in the paper. Somewhat optimized version

Recover the key with the two authentication attempts from reader.

const { Crypto1, Pn532: { Packet } } = window

console.log(Crypto1.mfkey32v2({
  uid: 0x65535D33,
  nt0: 0xCB7B9ED9,
  nr0: 0x5A8FFEC6,
  ar0: 0x5C7C6F89,
  nt1: 0x1E6D9228,
  nr1: 0x6FB8B4A8,
  ar1: 0xEF4039FB,
}).hex) // A9AC67832330
console.log(Crypto1.mfkey32v2({
  uid: Packet.fromHex('65535D33'),
  nt0: Packet.fromHex('CB7B9ED9'),
  nr0: Packet.fromHex('5A8FFEC6'),
  ar0: Packet.fromHex('5C7C6F89'),
  nt1: Packet.fromHex('1E6D9228'),
  nr1: Packet.fromHex('6FB8B4A8'),
  ar1: Packet.fromHex('EF4039FB'),
}).hex) // A9AC67832330
console.log(Crypto1.mfkey32v2({
  uid: '65535D33',
  nt0: 'CB7B9ED9',
  nr0: '5A8FFEC6',
  ar0: '5C7C6F89',
  nt1: '1E6D9228',
  nr1: '6FB8B4A8',
  ar1: 'EF4039FB',
}).hex) // A9AC67832330

Recover the key with the successfully authentication between the reader and the tag.

const { Crypto1, Pn532: { Packet } } = window

console.log(Crypto1.mfkey32v2({
  uid: 0x65535D33,
  nt: 0x2C198BE4,
  nr: 0xFEDAC6D2,
  ar: 0xCF0A3C7E,
  at: 0xF4A81AF8,
}).hex) // A9AC67832330
console.log(Crypto1.mfkey32v2({
  uid: Packet.fromHex('65535D33'),
  nt: Packet.fromHex('2C198BE4'),
  nr: Packet.fromHex('FEDAC6D2'),
  ar: Packet.fromHex('CF0A3C7E'),
  at: Packet.fromHex('F4A81AF8'),
}).hex) // A9AC67832330
console.log(Crypto1.mfkey32v2({
  uid: '65535D33',
  nt: '2C198BE4',
  nr: 'FEDAC6D2',
  ar: 'CF0A3C7E',
  at: 'F4A81AF8',
}).hex) // A9AC67832330

Decrypt the data.

Reset the internal lfsr.

const { Crypto1 } = window

const state1 = new Crypto1({ even: 1, odd: 1 })
state1.reset()

Set the internal lfsr with the key.

const { Crypto1, Pn532: { Packet } } = window

const state1 = new Crypto1()
state1.setLfsr(new Packet('FFFFFFFFFFFF'))

Get the internal lfsr.

const { Crypto1, Pn532: { Packet } } = window

const state1 = new Crypto1()
console.log(state1.setLfsr(new Packet('FFFFFFFFFFFF')).getLfsr().hex) // 'FFFFFFFFFFFF'

Get the lfsr output bit and update lfsr by input bit.

Get the lfsr output byte and update lfsr by input byte.

Get the lfsr 32-bit output word and update lfsr by 32-bit input word.

Rollback the lfsr in order to get previous states

Rollback the lfsr in order to get previous states

Rollback the lfsr in order to get previous states

This command is used to detect as many mifare targets (maximum MaxTg) as possible in passive mode.

Because Pn532#testTargetPresent failed to detect JCOP31 target so we need to do it manually.

This function is used to detect one mifare target in passive mode. It will release the target if reader connection is opened.

This function is used to authenticate block with a specific key type and key.

This function is used to validate the Access Control Bits of the sector.

This function is used to remove key that is invalid or duplicated in array.

Read block data from target by specific key type and key.

Read block data from target by key B and key A.

Read sector data from target by specific key type and key.

• res.data (Packet): 64 bytes sector data. Block data that failed to read will be filled with 0x00.
• res.success (Array<boolean>): Indicating whether or not the block read successfully. There are 4 blocks in sector.

Read sector data from target by key B and key A.

• res.data (Packet): 64 bytes sector data. Block data that failed to read will be filled with 0x00.
• res.success.read (Array<boolean>): Indicating whether or not the block read successfully. There are 4 blocks in sector.
• res.success.key (Array<boolean>): Indicating whether or not the key has authenticated successfully.

Check sector key of Mifare card.

Read all sector data from target. This function will try to auth sector by keys.

• res.data (Packet): All sector data. Block data that failed to read will be filled with 0x00.
• res.success.read (Array<boolean>): Indicating whether or not the block read successfully. There are 4 blocks in sector.
• res.success.key (Array<Packet, null>): Key A and Key B of all sector. Array may contains null if sector key not found.

Write block data to target by specific key type and key.

Write block data from target by key B and key A.

Set uid of chinese magic card gen2 (aka CUID).

Write sector data to target by specific key type and key.

• res.success (Array<boolean>): Indicating whether or not the block write successfully. There are 4 blocks in sector.

Write sector data to target by key B and key A.

• res.success (Array<boolean>): Indicating whether or not the block write successfully. There are 4 blocks in sector.

Write all sector data to target. This function will try to auth sector by keys.

• res.success (Array<boolean>): Indicating whether or not the block write successfully. There are 4 blocks in sector.

Increment from value block src by int32 and transfer to dist block.

Decrement from value block src by int32 and transfer to dist block.

Copy from value block src and transfer to dist block.

Send backdoor command of chinese magic card gen1a (aka UID).

Read block data from chinese magic card gen1a (aka UID).

Read sector data from chinese magic card gen1a (aka UID).

• res.data (Packet): 64 bytes sector data. Block data that failed to read will be filled with 0x00.
• res.success (Array<boolean>): Indicating whether or not the block read successfully. There are 4 blocks in sector.

Read all sector data from chinese magic card gen1a (aka UID).

• res.data (Packet): All sector data. Block data that failed to read will be filled with 0x00.
• res.success (Array<boolean>): Indicating whether or not the block read successfully. There are 4 blocks in sector.

Write block data to chinese magic card gen1a (aka UID).

Write sector data to chinese magic card gen1a (aka UID).

• res.success (Array<boolean>): Indicating whether or not the block write successfully. There are 4 blocks in sector.

Write all sector data to chinese magic card gen1a (aka UID).

• res.success (Array<boolean>): Indicating whether or not the block write successfully. There are 4 blocks in sector.

Set uid of chinese magic card gen1a (aka UID).

Wipe all sector data of chinese magic card gen1a (aka UID).

• res.success (Array<boolean>): Indicating whether or not the block wipe successfully. There are 4 blocks in sector.

Determines whether Web Bluetooth API is supported.

Determines whether the adapter is open.

Disconnect the connection of adapter.

Open the connection of adapter.

Determines whether SerialPort is supported.

Determines whether Web Serial API is supported.

Determines whether the connection of adapter is open.

Determines whether the connection of adapter is open.

Disconnect the connection of adapter.

Disconnect the connection of adapter.

Open the connection of adapter.

Open the connection of adapter.

Create a new Pn532FrameNormal or Pn532FrameExtended instance depends on data in pack.

Find offset and length of a PN532 Frame in buf

Type: Packet

Get cmd of this PN532 Frame

Type: number

Indicating whether or not this Frame is PN532 ACK Frame.

Type: boolean

Get tfi of this PN532 Frame

Type: number

Get format error in frame data.

Get application error in frame data.