Help for Unlock Configuration Screen

Use this screen to set the unlock codes needed to execute protected commands in the controller.

There are 20 spaces available for unlock codes, number 0 through 19. Unlock 0 and unlock 1 are special and are referred to as "super unlock codes" in the controller documentation. Most commands can be executed after any of the unlock codes are recognized. A super unlock code is required before issuing commands which change the unlock codes, including the multibyte serial eeprom read and write commands and configuration restore commands. Unlock code 0 is required before issuing the command to set the unlock code #0 or to issue the command which resets the entire controller configuration (including unlock codes) to its defaults (C100). During normal operation of the controller, the super unlock codes should not be used over the air, so that nefarious individuals cannot capture them and then proceed to change the unlock codes.

Most of the built-in commands for the controller (starting with "C", or "S") require that an unlock code be sent to the controller first. Once an unlock code is sent, a series of commands can be sent without sending the unlock code again. The unlock state is reset if 5 minutes have elapsed since the last command was sent to the controller, if the controller is addressed from a different port than the one from which the unlock code was sent, if site normal or remote normal commands are sent, or if the controller is reset (C000 command, power cycle, or front panel rest button pressed). Unlock code #0 should never be used over the air, unless unlock code #1 has been compromised or is unknown.

Note that unlock codes MUST be unique. Any duplication will result in an error. Error messages appear in the log window.

Unlock Code Used by Configurator

Enter the unlock code used by this configuration program to unlock the controller. This should be the unlock 1 that is currently configured in the controller. Unlock 0 will also work, and is required to change unlock 0 itself.

Use the confirm button to verify that this unlock code does work. If it is recognized, the unlock code number will appear in the lower right corner of this box, and the controller column of the list of unlock codes will be updated to show the confirmed code. If the entered code is not recognized, then there will be an error message in the log window.

A default unlock code can be loaded into this box on program startup by defining it with a line starting with /password in the config.env file.

/password 138065 would load the default value.

Set unlock code 0

Use this block to change unlock code 0. The old code should have been entered in the Configurator Unlock block above. Press the Send w/ unlock to change unlock code 0. If this is successful, it will also update the unlock code used by the configurator, as the previously used code will no longer be valid. If you have lost unlock code #0, you can still set a new unlock code #0, if you are physically next to the controller. Pull all of the RCB cards from the controller, and press the Send w/o RCB button. This command does not require an unlock code to execute. If successful, it will also set the Configurator Unlock, as the previous one is no longer valid.

Unlock Codes

The rest of the unlock codes are listed in two columns. Press the Verify button to read the current unlock codes from the controller. These will be displayed in the first column. The values loaded into the configurator, with the intention of transferring them to the controller are displayed in the second column. The configurator values are editable by clicking in the small window in which each parameter is displayed.

Buttons

Help
Gets you to this help screen
Ok
Captures the edits made to the editable boxes (but does not send them to the controller) and exits this screen
Apply
Captures the edits made to the editable boxes (but does not send them to the controller).
Cancel
Forgets any edits made to the unlock codes since the last Ok, Apply, or Send and exits this screen
Read
Reads the unlock codes from the controller and updates the controller column. Note that unlock code 0 cannot be read from the controller; it can only be verified.
Send
Does an Apply, sends the values to the controller and then reads it back to update the controller column
Copy
Transfers the unlock codes from the controller column to the configure column. This is useful to get started editing based on the values that are already in the controller.