diff options
| author | cheapie <no-email-for-you@example.com> | 2021-02-21 03:50:59 -0600 |
|---|---|---|
| committer | cheapie <no-email-for-you@example.com> | 2021-02-21 03:50:59 -0600 |
| commit | f0ce172302a02c854a52bae449e6dd4c4287f949 (patch) | |
| tree | 393a106ed0feba7403018519d28ae004b265a56c /docs/cardreader.txt | |
| parent | 39a7904f07b943c8ce464ec4486f208ff78ec109 (diff) | |
| download | digistuff-f0ce172302a02c854a52bae449e6dd4c4287f949.tar digistuff-f0ce172302a02c854a52bae449e6dd4c4287f949.tar.gz digistuff-f0ce172302a02c854a52bae449e6dd4c4287f949.tar.bz2 digistuff-f0ce172302a02c854a52bae449e6dd4c4287f949.tar.xz digistuff-f0ce172302a02c854a52bae449e6dd4c4287f949.zip | |
Split documentation from README out into separate files
Diffstat (limited to 'docs/cardreader.txt')
| -rw-r--r-- | docs/cardreader.txt | 8 |
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. |