nfc-emulate-tag: improve documentation, add a man page.

This commit is contained in:
Romuald Conty 2010-10-08 14:45:48 +00:00
parent 993a16f17c
commit fd211d53f8
3 changed files with 47 additions and 4 deletions

View file

@ -79,6 +79,7 @@ pn53x_tamashell_LDFLAGS = @READLINE_LIBS@
dist_man_MANS = \
nfc-anticol.1 \
nfc-emulate-tag.1 \
nfc-emulate-uid.1 \
nfc-list.1 \
nfc-mfclassic.1 \

View file

@ -0,0 +1,43 @@
.TH NFC-EMULATE-TAG 1 "October 8, 2010"
.SH NAME
nfc-emulate-tag \- Simple tag emulation command line demonstration tool
.SH SYNOPSIS
.B nfc-emulate-tag
.SH DESCRIPTION
.B nfc-emulate-tag
is an simple tag emulation tool that demonstrate how emulation can be done
using libnfc.
Currently, this tool partialy emulates a Mifare Mini: its shown as Mifare Mini
but internal MIFARE proprietary commands are not yet implemented.
To be able to emulate a target, there are two main parts:
- communication: handle modulation, anticollision, etc.
- computation: process commands (input) and produce results (output).
This demonstration tool purpose a logical structure to handle communication and
a simple function to deal with computation.
To improve the target capabilities, we can now implement more allowed commands
in a single function: target_io()
Please note that, due to timing issues is quiet impossible to implement a
ISO14443-4 tag this way: RATS request expect a quick ATS answer. By the way,
even you implements another kind of tag, timing issues are often the source of
problems like CRC or parity errors.
.SH BUGS
Please report any bugs on the
.B libnfc
forum at
.BR http://www.libnfc.org/community/ "."
.SH LICENCE
.B libnfc
and
.B libnfc-examples
are covered by the GNU Lesser General Public License (LGPL), version 3.
.SH AUTHORS
Romuald Conty <romuald@libnfc.org>
.PP
This manual page was written by Romuald Conty <romuald@libnfc.org>.
It is licensed under the terms of the GNU GPL (version 2 or later).

View file

@ -19,11 +19,11 @@
/**
* @file nfc-emulate-tag.c
* @brief Emulate a tag
* @brief Emulate a simple tag
*/
// Note that depending on the reader you'll use against this emulator
// it might work or not. Some readers are very strict on responses
// Note that depending on the device (initiator) you'll use against this
// emulator it might work or not. Some readers are very strict on responses
// timings, e.g. a Nokia NFC and will drop communication too soon for us.
#ifdef HAVE_CONFIG_H
@ -182,7 +182,6 @@ main (int argc, char *argv[])
printf ("NFC device (configured as target) is now emulating the tag, please touch it with a second NFC device (initiator)\n");
if (!nfc_target_emulate_tag (pnd, nt)) {
nfc_perror (pnd, "nfc_target_emulate_tag");
ERR("Could not come out of auto-emulation, no command was received");
return EXIT_FAILURE;
}