X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=notes%2Fproto.txt;h=f82d27bd43fd772135c75c1711ec88e994664821;hb=15d5ac704abc63c3f11ac8743cbd2ffa1fb70c88;hp=c27ff06ccc98643ba060e4255797bc7380f33dce;hpb=6b194d420f1554ace61a251f2c416712d68ab633;p=tpg%2Fopendispense2.git diff --git a/notes/proto.txt b/notes/proto.txt index c27ff06..f82d27b 100644 --- a/notes/proto.txt +++ b/notes/proto.txt @@ -4,6 +4,19 @@ Client/Server Dispense Protocol The protocol is ASCII based, similar to the FTP protocol All server responses are on one line and are prefixed by a three digit response code. +== Paramaters === + is a textual username unless the user does not have a username, +in which case the username is of the form '#' where is a unique +account number assigned by the server. + is the hexadecimal byte stream representation of a MIFARE card. + is an item ID of the form ':', where is an +alpha-numeric diriver identifier, and is an non-negative integer assigned +by the driver. + is an integer number of cents representing the size of a transactio. +Individual commands may restrict the range of the ammount to non-negative +numbers. + + == Response Codes == 100 Information 200 Command succeeded, no extra information @@ -35,6 +48,10 @@ If the client is connecting from a trusted machine on a root port then automatic authentication is allowed c AUTOAUTH \n s 200 Auth OK\n or 404 Bad Username\n or 401 Untrusted\n +--- Alternate Method (MIFARE Authentication) +c MIFARE \n +s 200 Auth OK as \n or 404 Bad Card ID\n or 401 Untrusted\n + --- Set effective user (User in `dispense -u`) --- c SETEUSER \n s 200 User set\n or 403 Not in coke\n or 404 User not found\n @@ -79,3 +96,6 @@ s 200 User Added\n or 403 Not Wheel\n or 404 User Exists\n - to remove the flag) Valid values are: user,coke,wheel,meta,disabled,door c USER_FLAGS \n s 200 User Updated\n or 403 Not Wheel\n or 404 Bad User\n or 407 Unknown Flags\n +--- Add MIFARE ID --- +c ADD_CARD \n +s 200 User Updated\n or 405 Card already registered\n