:mod:`rfid` --- RFID related functions
======================================

.. module:: rfid
   :synopsis: RFID related functions

The ``rfid`` module contains various RFID & NFC chips bindings to read and write RFID tags.

Constants
---------

.. data:: rfid.KEY_A
          rfid.KEY_B

   MIFARE Classic key types

.. data:: rfid.TAG_MF1K
          rfid.TAG_MF4K
          rfid.TAG_UL
          rfid.TAG_UL_EV1_80
          rfid.TAG_UL_EV1_164
          rfid.TAG_NTAG213
          rfid.TAG_NTAG215
          rfid.TAG_NTAG216

   Several card types, as returned by the mfrc522.info()

.. data:: rfid.G_18dB
          rfid.G_23dB
          rfid.G_33dB
          rfid.G_38dB
          rfid.G_43dB
          rfid.G_48dB

   Antenna gain values (in dBm)

.. data:: rfid.EOK

   Result code: all good

.. data:: rfid.EINVARG

   Result code: one or more parameters are invalid

.. data:: rfid.EPAR

   Result code: parity error

.. data:: rfid.ECRC

   Result code: CRC error

.. data:: rfid.ECOLL

   Result code: collision error

.. data:: rfid.EOVERFLOW

   Result code: overflow error

.. data:: rfid.ETEAR

   Result code: tear event occured

.. data:: rfid.ETEMP

   Result code: chip overheated

.. data:: rfid.EWRITE

   Result code: write error

.. data:: rfid.ETIMEOUT

   Result code: operation timed out

.. data:: rfid.ENACK

   Result code: operation not acknowledged, but should be

.. data:: rfid.EAUTH

   Result code: authentication error

.. data:: rfid.ECOMM

   Result code: generic communication error

.. data:: rfid.ENOMEM

   Result code: the tag returned more data than was expected

.. data:: rfid.EINT

   Result code: data flow integrity error

Classes
-------

.. toctree::
   :maxdepth: 1

   rfid.MFRC522.rst