diff options
Diffstat (limited to 'api_control.txt')
-rw-r--r-- | api_control.txt | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/api_control.txt b/api_control.txt new file mode 100644 index 0000000..983ab85 --- /dev/null +++ b/api_control.txt @@ -0,0 +1,23 @@ +# NFCommander control API + +This interface provides a means for external applications to program tags compatible +with NFCommander, as well as to run commands for testing purposes. + +## Access + +This API can be accessed via a network/unix socket connection. +Commands are sent as newline-terminated (\r\n) UTF-8 strings. +Replies are prefixed with either `OK` or `FAIL`, optionally contain an explanatory message +and are terminated likewise. + +## Commands + +### Run a command + +``` +RUN <command> <bytes-static> <static> [<bytes-dynamic> <dynamic>] +``` + +### Get current tag info + +### Program tag with command |