Revision as of 00:05, 8 December 2014

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>

Versions

Removed in r193 and replaced with 'show free'

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.