summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 9 insertions, 0 deletions
diff --git a/README b/README
index 79f68c7..d04d661 100644
--- a/README
+++ b/README
@@ -71,3 +71,12 @@ As in, [digiline][junction box][dirt][junction box][digiline] will work to trans
How to use the I/O expander:
After setting a channel, send a table (same format as a Luacontroller's "port" table) to set the output states.
A table in this same format will be sent back whenever an input changes or you manually poll it by sending a "GET" message.
+
+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.