Door Controller/Commands
From ESCTL
< Door Controller(Difference between revisions)
(Created page with "= Supported Commands = All commands must be followed by carriage return (\r) unless otherwise indicated. == ? == Syntax: ? Example: ? Returns: <About information> Returns...") |
m (Formatting) |
||
| Line 4: | Line 4: | ||
== ? == | == ? == | ||
| − | Syntax: ? | + | ; Syntax |
| + | : ? | ||
| − | Example: ? | + | ; Example |
| + | : ? | ||
| − | Returns: <About information> | + | ; Returns |
| + | : <About information> | ||
Returns the ‘About’ information for this door controller | Returns the ‘About’ information for this door controller | ||
| Line 14: | Line 17: | ||
== <ENTER> == | == <ENTER> == | ||
| − | Syntax: \r | + | ; Syntax |
| + | : \r | ||
| − | Example: \r | + | ; Example |
| + | : \r | ||
| − | Returns: OK:null: | + | ; Returns |
| + | : OK:null: | ||
Simple keepalive | Simple keepalive | ||
| Line 24: | Line 30: | ||
== U == | == U == | ||
| − | Syntax: U[<time>] | + | ; Syntax |
| + | : U[<time>] | ||
| − | Example: U3 | + | ; Example |
| + | : U3 | ||
| − | Returns: OK:unlock:<time> | + | ; Returns |
| + | : OK:unlock:<time> | ||
Unlocks the door for the specified number of seconds. If no time is specified, uses the default unlocktime stored in internal configuration | Unlocks the door for the specified number of seconds. If no time is specified, uses the default unlocktime stored in internal configuration | ||
| Line 34: | Line 43: | ||
== uptime == | == uptime == | ||
| − | Syntax: uptime | + | ; Syntax |
| + | : uptime | ||
| − | Example: uptime | + | ; Example |
| + | : uptime | ||
| − | Returns: INFO:uptime:<millis> | + | ; Returns |
| + | : INFO:uptime:<millis> | ||
Returns the length of time since the last board restart, in milliseconds | Returns the length of time since the last board restart, in milliseconds | ||
| Line 44: | Line 56: | ||
== debug == | == debug == | ||
| − | Syntax: debug [<level>|cmd|keypad|ibutton|wiegand|eeprom|local] | + | ; Syntax |
| + | : debug [<level> | cmd | keypad | ibutton | wiegand | eeprom | local] | ||
| − | Example: debug | + | ; Example |
| + | : debug | ||
| − | Returns: INFO:debug:<level> | + | ; Returns |
| + | : INFO:debug:<level> | ||
| − | Example: debug 4 | + | ; Example |
| + | : debug 4 | ||
| − | Returns: OK:debug:<level> | + | ; Returns |
| + | : OK:debug:<level> | ||
Shows the current debugging level, or sets a new one. If a value is specified, this overwrites the previous bitmask; otherwise debugging for the specified parameter is added to the existing bitmask. | Shows the current debugging level, or sets a new one. If a value is specified, this overwrites the previous bitmask; otherwise debugging for the specified parameter is added to the existing bitmask. | ||
| Line 58: | Line 75: | ||
== test == | == test == | ||
| − | Syntax: test [input|output] | + | ; Syntax |
| + | : test [input | output] | ||
| − | Example: test input | + | ; Example |
| + | : test input | ||
| − | Returns: <live test output> | + | ; Returns |
| + | : <live test output> | ||
This command is not suitable for automated use. It will exercise all inputs or outputs, and show the results continually until a further key is pressed. | This command is not suitable for automated use. It will exercise all inputs or outputs, and show the results continually until a further key is pressed. | ||
| Line 68: | Line 88: | ||
== free == | == free == | ||
| − | Syntax: free | + | ; Syntax |
| + | : free | ||
| − | Example: free | + | ; Example |
| + | : free | ||
| − | Returns: INFO:free:<bytes> | + | ; Returns |
| + | : INFO:free:<bytes> | ||
Returns the amount of available internal RAM, in bytes | Returns the amount of available internal RAM, in bytes | ||
| Line 78: | Line 101: | ||
== set == | == set == | ||
| − | Syntax: set [name|num|local<num>|unlocktime|lockinvert|mac <value>] | + | ; Syntax |
| + | : set [name | num | local<num> | unlocktime | lockinvert | mac <value>] | ||
| − | Example: set local0 WG:123456 | + | ; Example |
| + | : set local0 WG:123456 | ||
| − | Returns: <all | + | ; Returns |
| + | : <all values> (if no parameters given) | ||
| + | ; <nothing> (if a new value is set) | ||
Displays all current EEPROM settings, or changes a single setting. | Displays all current EEPROM settings, or changes a single setting. | ||
Revision as of 12:11, 6 November 2014
Contents |
Supported Commands
All commands must be followed by carriage return (\r) unless otherwise indicated.
?
- Syntax
- ?
- Example
- ?
- Returns
- <About information>
Returns the ‘About’ information for this door controller
<ENTER>
- Syntax
- \r
- Example
- \r
- Returns
- OK:null:
Simple keepalive
U
- Syntax
- U[<time>]
- Example
- U3
- Returns
- OK:unlock:<time>
Unlocks the door for the specified number of seconds. If no time is specified, uses the default unlocktime stored in internal configuration
uptime
- Syntax
- uptime
- Example
- uptime
- Returns
- INFO:uptime:<millis>
Returns the length of time since the last board restart, in milliseconds
debug
- Syntax
- debug [<level> | cmd | keypad | ibutton | wiegand | eeprom | local]
- Example
- debug
- Returns
- INFO:debug:<level>
- Example
- debug 4
- Returns
- OK:debug:<level>
Shows the current debugging level, or sets a new one. If a value is specified, this overwrites the previous bitmask; otherwise debugging for the specified parameter is added to the existing bitmask.
test
- Syntax
- test [input | output]
- Example
- test input
- Returns
- <live test output>
This command is not suitable for automated use. It will exercise all inputs or outputs, and show the results continually until a further key is pressed.
free
- Syntax
- free
- Example
- free
- Returns
- INFO:free:<bytes>
Returns the amount of available internal RAM, in bytes
set
- Syntax
- set [name | num | local<num> | unlocktime | lockinvert | mac <value>]
- Example
- set local0 WG:123456
- Returns
- <all values> (if no parameters given)
- <nothing> (if a new value is set)
Displays all current EEPROM settings, or changes a single setting.
