diff --git a/README.md b/README.md index 6f3d01a640f4542bacdd6de73dd16b749c00fe46..f45c4d98541b86bb9b70985712b4d985b3b731aa 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,20 @@ Usage virtualcoke.py Via the network: - FIXME + When run, virtualcoke attempt to bind to port 502 (Modbus standard port) + If this fails, it will bind to port 1502 + To bind to the lower port, you may need to be a privileged user Via the console: - Keypad numbers (0-6) mimic front buttons of coke machine - FIXME - + Keypad numbers (0-6) mimic front buttons of the coke machine + Keypad numbers (7-9, M) mimic the interior buttons of the coke machine + ^Q exits the simulator cleanly Requirements ------------- -* npyscreen 4.6.1 or later +* npyscreen 4.8.5 or later +* Twisted Known Issues ------------- diff --git a/TODO b/TODO index c7dbebc2d469d14b98ff7d79335101dcad75ccf2..4f37ebc3d860dd6a4e2806f27175b004aab693fa 100644 --- a/TODO +++ b/TODO @@ -7,6 +7,6 @@ DONE Hidden other buttons DONE Hook up modbus DONE Test against dispense DONE Modbus alternative port +DONE Write up documentation Coin Return Button - Write up documentation