updated documentation for firmware messages
[svn42.git] / firmware-messages.txt
1 ###############################################################
2 /dev/ttyUSB0: door key printer
3
4
5  Messages:
6
7   manual open key pressed:
8    open forced manually
9
10   manual close key pressed:
11    close forced manually
12
13   closing or opening finished
14    Status: closed|opened, idle
15
16   closing or opening timeout:
17    Error: open/close took too long!
18
19  commands:
20   c ... close
21    response: "Ok", "Already closed", "Error: .*"
22   o ... open
23    response: "Ok", "Already opened", "Error: .*"
24   s ... status
25    response: "Status: closed|opened|<->, opening|waiting|closing|idle"
26          or  "Error: .*"
27   r ... reset
28    "Ok, closing now" or "Error: .*"
29   * ... everything else
30    Error: unknown command
31
32  open/close  will only be accepted if Status: ..., idle
33              otherwise response: Error: Operation in progress
34
35  unless error case s will always be accepted
36
37  Reset overrules all other operations in progress
38
39  if an error occured every command besides r gets ingnored and
40    Error: last open/close operation took too long!
41  is sent in response
42
43 ###############################################################
44