The Keyboard

SV 9.0 ©Copyright 2009 - Reproduction prohibited

Keyboard configuration

About Keyboard Configuration

The action produced by many of the non QWERTY keyboard keys may be programmed by the developer. In this
ways keys may be allocated to perform commonly used operations such as scrolling a trend or displaying a par-
ticular window. This is particularly useful if, in run time, the host PC has to operate without a mouse.
The keyboard may be configured either using the Function Key option from the Action sub-menu or the program lan-
guage instruction KEY. This chapter covers configuring the keyboard using the Function Key option.
A key action may be one of three types.

l Standard action. An internal action such as to display the On-line help or show the Configuration Menu.
l Execute a function. A function from a SCADA BASIC program may be executed. The possibilities in this case
are endless, but a typical use would be to manipulate a trend display or open a window.
l Send an animation. Reproduce the action of an operator clicking on a send type animation in a window.

There are over 30 keys which are user configurable. Most of these keys can be given more than one action by using
them in conjunction with the shift and control keys. In addition an action may be triggered when a key is pressed
and when it is released. The function of some of the keys is pre-defined by the Supervisor when it starts. These are
known as Standard Actions.

Standard Key Actions

Key Direction Standard Action
F1 U On line help
F2 D Operation menu (logon and logoff)
F3 D Administration menu (user configuration)
F4 D About screen
F5
F6 D Display menu bar
F7 D Display trace window
F8 D Hide menu
F9 D Program management
F10 D Quit
F11 D Refresh screen
F12 D Report Replay Toolbox
Page Down Next window
Page Up Previous window
Right arrow Next zone
Down arrow Next zone
Left arrow Previous zone
Up arrow Previous zone
Home First zone
End Last zone
Insert
Delete
Cancel
Esc
Back space
F13
F14
F15
F16
Tab*
Enter*
Pause*
Space*
Numlock*
D - The action takes place as the key is pressed.
U - The action takes place as the key is released.
* - Use with caution.

The Function Key Management Dialog Box

The Function Key dialog box is displayed from the Action sub-menu and is used to display, delete, modify and
create Function Key actions.
Show picture
The dialog box contains a list of current Function Key actions and has command buttons to create, modify and
delete them. The operation of the dialog box is similar to that used to manage Event and Cyclic actions.

The Action List

Configured keyboard actions are displayed, one per line, in a scrollable list. Each entry in the list displays details of
a particular action including the name of the function key, the shift function and the type and description of the
action.
Also displayed is the status of the action. An action may be enabled (indicated by a star), disabled (no indication)
or temporary (indicated by a T). A temporary action is one that has been created under control of a SCADA BASIC
program or an action that is available by default.
An action may be selected by clicking on its entry in the list. A selected action is indicated by the characters <>
appearing at opposite ends of the line. Several actions may be selected at the same time. Clicking on a line again
will de-select it. Double clicking on an action will display its configuration in a dialog box.

Tab Options and Command Buttons

l Defined - Display all actions which are defined but not enabled.
l Enabled - Display all actions which are defined and enabled.
l Temporary - Display all temporary (created by a SCADA BASIC program) actions.
l All - Select all displayed actions.
l None - Deselect all displayed actions.
l Enable - Enable all selected actions.
l Disable - Disable all selected actions.
l Delete - Delete all selected actions. A confirmation box limits the risk of accidental deletion.
l Refresh - Refresh the display showing the current status of the actions.
l Save - Save any changes to hard disk. The changes will be remembered when the software is restarted.
l OK - Close the dialog box without saving the changes on disk. The changes will be operable but will be lost
when the software is restarted.
l Create - Create a new action. The Key Function Parameter dialog box is displayed.

Configuring the Function Keys

A new action is added to a function key by selecting the Create button in the management dialog box. If an action is
selected in the action list then the dialog box which is displayed will contain its configuration enabling a new action
to be created with similar characteristics.

Tab Options and Command Buttons

l Standard action - Operate one of the standard key actions such as the on-line help.
l Execute a function - Run a SCADA BASIC function.
l Send Animation - Run an operator action type animation, such as to send a command.
l Key - The name of the function key to which the action is attached.
l Down - Initiate the action when the key is pressed, else the action is initiated when it is released.
l Shift - Use shift plus the specified key.
l Control - Use control (Ctrl) plus the specified key .
l Enabling bit - The name of a database bit which, if specified, must be set to 1 to enable the action.

Configuring a key with a standard action

Show picture

l Action type - The name of the Standard Action to be attached to the function key.

Configuring a Key to Run a Program Function

Running a program function from a key gives the developer considerable flexibility in the operation of the Super-
visor. Some of the more common uses are to open windows, manipulate Trend and Alarm displays, send recipes,
and start sequences. Programs may be developed so that the key operation is context sensitive, that is the func-
tionality provided will depend on which window is displayed or some other condition.
When developing programs for operation from the keyboard the same considerations should be used as when
developing programs for Event and Cyclic actions.
Show picture
 l Program - The name of the SCADA BASIC program which contains the function to execute.
l Branch - The database branch to be used by the function. (Optional.)
l Function - The name of the function to be executed.
l Arguments - A list of arguments for the function. These may be retrieved using the GETARG instruction.

Configuring a Key to Emulate a Control Zone

Certain animation types, such as setting the value of a Register, allow the developer to provide control zones on
the screen which may be operated using the mouse. However, in an industrial environment, the use of a mouse is
not always practical, and so a keyboard key may be programmed to produce the same effect. A key programmed
in this way uses the window name and the animation's identifier to do this and so unless the a mechanism is
arranged to dynamically change the programming of the key it will only work for a specific window and animation.
Show picture
 l Window - The name of the window which contains the animation.
l Branch - The database branch which the window was opened with. Optional.
l Identifier - The identifier of the animation which is to operate.

Disabling the Standard Function Keys

Although it is possible to delete or disable the standard functions allocated to the Keys by the Supervisor, when the
Supervisor is restarted the functions will be restored. The solution is write a SCADA BASIC program which runs as
part of the start up procedure in which the KEY instruction is used to delete the required functions automatically.
If this procedure is adopted you must also develop a program which restores the standard functions, or you could
find yourself in the situation of not being able to access the configuration menus.
'-------- Example Program
Sub NoKey ()
Key("DEL","D",1);
Key("DEL","D",2);
Key("DEL","D",3);
Key("DEL","D",4);
Key("DEL","D",5);
Key("DEL","D",6);
Key("DEL","D",7);
Key("DEL","D",8);
End Sub

Sub RtnStd ()
Key("ADDSTD","D",1,1);
Key("ADDSTD","D",2,2);
 Key("ADDSTD","D",3,3);
Key("ADDSTD","D",4,4);
Key("ADDSTD","D",5,5);
Key("ADDSTD","D",6,6);
Key("ADDSTD","D",7,7);
Key("ADDSTD","D",8,8);
End Sub