From f0ce172302a02c854a52bae449e6dd4c4287f949 Mon Sep 17 00:00:00 2001 From: cheapie Date: Sun, 21 Feb 2021 03:50:59 -0600 Subject: Split documentation from README out into separate files --- docs/cardreader.txt | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/cardreader.txt (limited to 'docs/cardreader.txt') 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. -- cgit v1.2.3