nfcpy documentation

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 API for Python applications.

Note

The documentation is work in progress and still incomplete. Bear with me that this changes.

Overview

Hardware and software requirements, implementation status and references.

Tutorials

Contactless Frontend

Find and use NFC contactless readers.

Contactless Tag Types

Supported tag types and how to use them.

NFC Data Exchange Format

How to parse or generate NDEF records and messages.

Generate Test Tags

Recipes to generate tags for testing tag readers.

Examples

helloworld.py

A straightforward example of NDEF read and write.

tagtool.py

Read or write or format tags for NDEF use.

ndeftool.py

Generate or inspect or reorganize NDEF data.

Handover Test Tool

A test tool for dynamic connection handover.

Reference

• nfc module
  • Contactless Frontend
  • Tag Base Class
  • Type 1 Tag
  • Type 2 Tag
  • Type 3 Tag
  • Type 4 Tag
  • Data Exchange Protocol
    • Base Class
    • Initiator
    • Target
• nfc.ndef module
  • Message
  • Record
  • TextRecord
  • UriRecord
  • SmartPosterRecord
  • Connection Handover
    • HandoverRequestMessage
    • HandoverSelectMessage
    • HandoverCarrierRecord
    • Data Structures
    • BluetoothConfigRecord
    • WifiConfigRecord
    • WifiPasswordRecord
• nfc.llcp module
• nfc.snep module
  • SNEP Server
  • SNEP Client
• nfc.handover module
  • Handover Server

Indices

• Index
• Module Index
• Search Page