Sierra Video Yosemite - Manual (Page 93)

SPECIFICATIONS
87
not the administrator password. Any use of a password larger than 9999 also fails. In any of those
cases, the output lock status remains unchanged and an error response is generated. The “B”
command response will indicate that the output still has the same lock state as before.
In the “B” command response that is sent by the router, the “password” argument is the current
lock password for the output (1-9999), or is 0 if the output is not locked, and the “lock” argument
is 0 if the output is not locked, or 1 if it is locked.
When locking an unlocked output, the specified password is recorded by the router as the lock
password for that output. When unlocking a locked output, the specified password is compared
by the router to the lock password for the output. If they match, or if the specified password is the
administrator password, the output is unlocked, else it remains locked. Attempting to lock an
already-locked output, or unlock an already-unlocked output, has no effect on the lock state of
that output.
Whenever a take is done, the router checks to see if the specified output for the take has been
locked. If so, the current password of the control port that sent the take request (as set with the
“K” command) is compared to the output ís lock password. If they match, the take is allowed, but
if not, the take has no effect. The administrator password may NOT be used in lieu of the output
is lock password to do a take
, so if a controlling device sends the administrator password in a “K”
command, that will not permit the device to reroute locked outputs (but it can use the
administrator password to unlock locked outputs using the “B” command).
Output lockouts apply on all levels. On virtual-mapped routers, a level may be left out of a lockout
by making sure the level is unmapped for the destination being locked.
As with all router configuration parameters, the output lockout data is stored in non-volatile
storage and thus is retained across router power-ups. When a router is first initialized at the
factory, all outputs are set to be unlocked.
This command provides the same functionality as the “G OUTPUT_LOCK” command. This
command, which was added at router software version V5.06, is preferred over that command.
Note that the output lock version number is not present in this command. Since output lock status
changes frequently, it is not really useful to cache output lock status for outputs, so the output
lock version number is not really useful.
For example, to request whether or not output 21 is locked:
** B21,0,0 !!
The response might be:
** B21,0,0 OK !!
indicating that output 21 is NOT locked. Or, the response might be:
** B21,6741,1 OK !!
indicating that output 21 is locked with password 6741. To clear this lockout:
** B21,6741,0 !!
To lock output 96 using password 439:
** B96,439,1 !!
If successful, the response would be:
** B96,439,1 OK !!
If output 122 becomes locked using password 235, the following change report would be sent by
the router:
** B122,235,1 !!