Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 1.6 KB

index.rst

File metadata and controls

56 lines (42 loc) · 1.6 KB

Python module for near field communication

This documentation covers the '|release|' version of nfcpy. There are also other versions.

The nfcpy module implements NFC Forum specifications for wireless short-range data exchange with NFC devices and tags. It is written in Python and aims to provide an easy-to-use yet powerful framework for applications integrating NFC. The source code is licensed under the EUPL and hosted at GitHub. The latest release version can be installed from PyPI with pip install -U nfcpy.

To send a web link to a smartphone:

import nfc
import ndef
from threading import Thread

def beam(llc):
    snep_client = nfc.snep.SnepClient(llc)
    snep_client.put_records([ndef.UriRecord('http://nfcpy.org')])

def connected(llc):
    Thread(target=beam, args=(llc,)).start()
    return True

with nfc.ContactlessFrontend('usb') as clf:
    clf.connect(llcp={'on-connect': connected})

There are also a number of :doc:`examples/index` that can be used from the command line:

$ examples/beam.py send link http://nfcpy.org
.. toctree::
   :maxdepth: 2

   overview
   topics/get-started
   topics/ndef
   topics/llcp
   topics/snep
   examples/index
   testing/index
   modules/index