Package-level declarations

Types

Link copied to clipboard
class LinuxI2cNciPacketIo(val i2cDevicePath: String = defaultI2cDevicePath(), val i2cAddress: Int = defaultI2cAddress(), val gpioChipPath: String = defaultGpioChipPath(), val irqGpioPin: Int = defaultIrqGpioPin(), val venGpioPin: Int = defaultVenGpioPin()) : NciPacketIo

Linux I2C (/dev/i2c-*) + GPIO character device v2 (/dev/gpiochip*) implementation of NciPacketIo for NXP PN7160 / PN7150 NFC controllers (such as the NXP OM27160A1EVK board on Raspberry Pi 5).

Link copied to clipboard
class NciNfcController(packetIo: NciPacketIo, registerWithMultipaz: Boolean = true, externalReader: Boolean = false, disableReaderModeDelay: Duration = 5.seconds, openTagDisconnectDelay: Duration = 30.seconds, pollInterval: Duration = 100.milliseconds, commandTimeout: Duration = 3.seconds, scope: CoroutineScope = CoroutineScope(SupervisorJob() + Dispatchers.Default)) : NfcApduRouterBackend

High-level NFC controller coordinating both NFC Reader/Writer mode (NfcTagReaderNci) and NFC Card/Tag Emulation mode (NfcApduRouterBackend) over an NciPacketIo transport (such as an NXP PN7160 connected via I2C + GPIO on a Raspberry Pi).

Link copied to clipboard
interface NciPacketIo

Abstraction for reading and writing raw NFC Controller Interface (NCI) packets (3-byte header [MT|PBF|GID_or_ConnID, OID_or_RFU, PayloadLen] + payload) and controlling the hardware reset / enable (VEN) pin.

Link copied to clipboard
data class NciRfActivatedEvent(val rfDiscoveryId: Int, val rfInterface: Int, val rfProtocol: Int, val activationRfTechAndMode: Int, val maxDataPacketPayloadSize: Int, val initialCredits: Int, val historicalBytes: ByteString?, val applicationData: ByteString?)

Details of an activated RF interface reported by RF_INTF_ACTIVATED_NTF.

Link copied to clipboard

NfcIsoTag implementation backed by an NciEngine over NCI Static RF Connection 0x00 with RF_INTERFACE_ISO_DEP.

Link copied to clipboard

NfcTagReader implementation backed by an NciNfcController.