updated documentation for firmware messages

diff --git a/checkcard.pl b/checkcard.pl
index b948393..ade7c61 100755 (executable)
--- a/checkcard.pl
+++ b/checkcard.pl
@@ -53,36 +53,5 @@ while (sleep 1)
 #
 #
 ###############################################################
-# /dev/ttyUSB0: door key printer
-#
-#
-#   Ok
-#   Ok, closing now
-#   Already closed
-#   Already opened
-#   close forced manually\nOk
-#   open forced manually\nOk
-#   Error: .*
-#   .* be: unknown command
-#          Operation in progress
-#          open/close took too long!
-#          last open/close operation took to long!
-#
-# commands:
-#  c ... close
-#   response: "Ok", "Already closed", "Error: .*"
-#  o ... open
-#   response: "Ok", "Already opened", "Error: .*"
-#  s ... status
-#   response: "Status: closed|opened|<->, opening|waiting|closing|idle"
-#         or  "Error: .*"
-#  r ... reset
-#   "Ok, closing now" or "Error: .*"
-#
-# open/close  will only be accepted if Status: ..., idle
-# Reset overrules all other operations in progress
-# s will always be accepted
-#
-###############################################################
 #
 #

diff --git a/firmware-messages.txt b/firmware-messages.txt
new file mode 100644 (file)
index 0000000..e056a29
--- /dev/null
+++ b/firmware-messages.txt
@@ -0,0 +1,44 @@
+###############################################################
+/dev/ttyUSB0: door key printer
+
+
+ Messages:
+
+  manual open key pressed:
+   open forced manually
+
+  manual close key pressed:
+   close forced manually
+
+  closing or opening finished
+   Status: closed|opened, idle
+
+  closing or opening timeout:
+   Error: open/close took too long!
+
+ commands:
+  c ... close
+   response: "Ok", "Already closed", "Error: .*"
+  o ... open
+   response: "Ok", "Already opened", "Error: .*"
+  s ... status
+   response: "Status: closed|opened|<->, opening|waiting|closing|idle"
+         or  "Error: .*"
+  r ... reset
+   "Ok, closing now" or "Error: .*"
+  * ... everything else
+   Error: unknown command
+
+ open/close  will only be accepted if Status: ..., idle
+             otherwise response: Error: Operation in progress
+
+ unless error case s will always be accepted
+
+ Reset overrules all other operations in progress
+
+ if an error occured every command besides r gets ingnored and
+   Error: last open/close operation took too long!
+ is sent in response
+
+###############################################################
+