1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
===================
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.
.. toctree::
:hidden:
:glob:
overview
topics/*
examples/*
:doc:`overview`
Hardware and software requirements, implementation status and references.
Tutorials
=========
:doc:`topics/get-started`
Get started with the nfcpy module and example programs.
:doc:`topics/ndef`
How to parse or generate NDEF records and messages.
:doc:`topics/test-tags`
Recipes to generate tags for testing tag readers.
Examples
========
:doc:`examples/helloworld`
A straightforward example of NDEF read and write.
:doc:`examples/tagtool`
Read or write or format tags for NDEF use.
:doc:`examples/ndeftool`
Generate or inspect or reorganize NDEF data.
:doc:`examples/handover-test`
A test tool for dynamic connection handover.
Reference
=========
.. toctree::
api/nfc
api/tag
api/ndef
api/llcp
api/snep
api/handover
Indices
=======
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|