summaryrefslogtreecommitdiff
path: root/docs/cardreader.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cardreader.txt')
-rw-r--r--docs/cardreader.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/cardreader.txt b/docs/cardreader.txt
new file mode 100644
index 0000000..3450856
--- /dev/null
+++ b/docs/cardreader.txt
@@ -0,0 +1,8 @@
+How to use the card reader:
+After setting a channel, swiping a card (punch the reader with the card to swipe) will send a message in the following format:
+ {event = "read",data = "The data that was on the card"}
+To write a card, send a command in the following format:
+ {command = "write",data = "The data to put on the card",description = "A description of what the card is for"}
+After sending the write command, swipe the card to be written and the reader will send back the following message:
+ {event = "write"}
+Both blank and previously written cards can be written to. If the card was not blank, it will be overwritten.