SoftProg

SoftProg Programming Utility for Access IS Programmable Keyboards

SoftProg keyboard programming utility

The Access IS developed SoftProg utility enables the rapid definition and configuration of the settings for Access programmable keyboards and keypads, including key programming, key colours and legends, and designing the keyboard layout to allow for the use of dual and quad keys.

 

Once designed, the keyboard settings are stored in a .SPF format file and can be downloaded to the keyboard's non-volatile memory via SoftProg.

 

Once a keypad has been configured it retains the settings; no special software or drivers are needed on the end user's PC for the keyboard to function.

 

SoftProg files can be created by the end-user or, more commonly, by Access staff. SPF files can be sent between users and Access staff to enhance or prove programming design.

 

Keyboards are typically programmed as the final stage immediately before a full functional test in production. Keyboards can be programmed and reprogrammed an unlimited number of times, even after deployment to customers.

 

SoftProg enables the following keypad configuration:

 

  • Assign programming to any key
  • Redefine the key layout with multiple space keys and blanking tiles
  • Define key legends
  • Define momentary and toggle layer shift keys
  • Assign the LEDs to any function
  • Enable or disable auto repeat
  • Disable Control + Alt + Delete key combination
  • Set the default Caps Lock and Num Lock states
  • Define MSR operation (where fitted)

 

Installation

 

Installation instructions are provided on this page below the user guide -

click here to jump to the instructions for installation.

 

User Guide

 
  1. Important notes
  2. Overview
  3. Programming a keyboard using an existing SPF file
  4. Creating a new SPF file
  5. Setting keyboard system parameters
  6. Editing the layout for single, multiple and blank keys
  7. Changing key colours
  8. Programming a key / editing key functionality
  9. Magnetic swipe card reader settings
  10. Importing programming files from previous versions
  11. Downloading programming files to a keyboard
  12. Revision history

 

1. Important Notes

 

 
  1. Microsoft Windows Operating Systems generally will not recognize a PS/2 keyboard unless one is connected when the computer is powered on. If you wish to program a PS/2 keyboard you must have a PS/2 keyboard connected when the PC is powered on.
  2. SoftProg requires that the user is logged in with administrator rights.
  3. Keyboards may need to be power cycled before new settings take effect.
  4. When installing SoftProg you are offered a choice of template (KPD) options. This determines which keyboard (and other device) templates (.KPD files) are installed. These are the templates, which will be offered when you create a new programming file (.SPF). If you are unsure which templates you will need, check all 3 boxes.
  5. SoftProg uses SoftProg Programming Files (.SPF) to record your keyboard (or other device) data, e.g. required key codes. Previous versions of SoftProg used .PRG files. If you have a .PRG file please see section 10 on how to import it.
  6. There are 2 types of Access USB keyboard: MK1 & MK2. MK1 keyboards can be identified by having a part number starting AKEOCU and MK2 keyboards, shipped since January 2010, have a part number starting AKENOV. MK2 keyboards are functionally identical to MK1 keyboards but cannot read SoftProg programming (SPF) files created for MK1 devices. For more information, click here to read the technical bulletin.

 

2. Overview

 

 

The SoftProg utility enables the rapid definition and configuration of the settings for ACCESS programmable keyboards. Settings are stored in the keyboard's non-volatile memory. Once a keypad has been configured it retains these settings and no special software or drivers are needed on the end user's PC.

 

SoftProg enables the following keypad configuration:

 

  • Assign scan codes to any key
  • Redefine the key layout with multiple space keys and blanking tiles
  • Define key legends
  • Define momentary and toggle layer shift keys
  • Assign the LED's to any function
  • Enable or disable auto repeat
  • Disable Control + Alt + Delete key combination
  • Set the default Caps Lock & Num Lock states
  • Define MSR operation (where fitted)

 

3. Programming a keyboard using an Existing SPF File

 

 

SoftProg works with SoftProg Program Files (SPF). These are the files which record the keyboard configuration. To program a keyboard from an existing file:

 

  • Open the file. [File > Open]
  • A representation of the keyboard will be shown
  • Download the file to the keyboard. [File > Program > Keypad]

 

4. Creating a New SPF File

 

 
  • Select new file [File > New]
  • Select the layout that matches your keyboard. Note that some layouts are available for a number of interfaces - please see the table below to help to determine the correct layout for your keyboard. If you are unsure please contact your nearest sales representative.

 

PS/2

Connects to PC PS/2 port

USB:OCU

Connects to the PC as a normal USB keyboard (i.e. characters typed on the keyboard will appear in a text editor or word processor). The keyboard part number normally begins AKEOCU

USB:NOV

Connects to the PC as a normal USB keyboard (i.e. characters typed on the keyboard will appear in a text editor or word processor). The keyboard part number normally begins AKENOV

USB:HID

Connects to the PC as a custom USB HID device. This requires special firmware or drivers to read the output from the keyboard

 

  • You can now modify the programming file to your requirements as detailed in the following sections.

 

5. Setting Keyboard System Parameters

 

 

Open the Keyboard System Parameters dialogue Box [Settings > Keyboard]. The following parameters are available for setting.

 

LEDs

Each LED may be assigned to each of the standard keyboard LEDs (Caps/Num/Scroll) or Power, Layer (to show the state of a layer select key) or None.

 

Inter-character Delay

Varies the delay between characters transmitted from the keyboard buffer. This affects the rate of transmission of codes where a string is assigned to a key and of MSR and BCR data where applicable. If the Inter-character Delay is too short data may be lost on some systems.

 

Country

This sets which country keyboard driver the keyboard is to be used with. It determines how key presses are displayed in SoftProg. For keyboards with configurable language settings check Local Language Support so that the country setting is sent to the keyboard when you download.

 

Auto-repeat Enable

If this box is not checked none of the keyboard keys will auto-repeat. For PS/2 systems this does not affect the operation of the slave (wedge) keyboard. Also see notes on key programming.

 

Ctrl/Alt/Del Disable

If this box is checked then the Ctrl/Alt/Del combination cannot be typed on the keyboard. (If any two of these keys are pressed the third will not be sent to the PC.) It does not affect any slave keyboard connected to a PS/2 keyboard or any keyboard connected to a hub port of a USB keyboard.

 

Key Clicks

Sets audible key click on/off (where available).

 

AKPLUS Mode

Not available on standard products.

 

OPOS Defaults

Only apply when using the keyboard in an OPOS environment. Please note that not all products have OPOS support.

 

6. Editing the Layout for Single, Multiple and Blank Keys

 

 

Keyboards can have single keys, larger keys (such as double or quad keys) or keyboard positions where there is no key at all.

 

To create a multi-space key select the group of keys then [Edit > Change Style > Required Key Type].

 

To create a blank key (where a blanking tile is fitted in the keyboard) use [Edit > Change Style > Blank].

 

To revert a multi-space key to single keys then [Edit > Change Style > Single].

 

7. Changing Key Colours

 

 

Highlight the key, or a group of keys, and use [Edit > Key Colour]. Click on the required colour.

 

8. Programming a Key / Editing Key Functionality

 

 

To programme a key, or change an the existing key programming, use [Edit > Edit], or double click on the key. Select the Key Data tab.

 

Note: for any changes to take effect, [Apply] must be clicked before exiting the screen.

 

Encoding (Key Type)

 

   
IBM Keycodes

This is the normal setting. In this mode the output of the key is defined as a key press or combination of keys presses on a standard keyboard.

 

Layer Select

Key layering is useful where more keys are required than are physically on the keypad. One key is nominated as a Layer or Local Shift key (also sometimes referred to as symbol shift.) When active, a second set of key programs is assigned to each of the other keys on the keypad. This local Shift key may be 'Momentary' i.e. only active when depressed, or 'Toggle', i.e. each depression toggles the state of local shift. An LED (if fitted) can be programmed to display the state of local shift.

 

Hex codes

This is option is only available on PS/2 keyboards and USB HID devices, which use a custom interface. It cannot be implemented with standard USB keyboard functionality.

 

 

Setting Key Program

On the Key Data tab, first click on the required Layer tab (where more than one layer is used - see Layer Select above).

 

Click in the white box and type the keys in the sequence you want the key to be programmed in.

 

Please note that SoftProg will not trap some special function keys, for example print screen, and will not trap some ordinary keys when in Vista or Windows 7 - in this case, click [Manual] and enter key strokes which are normally intercepted by Windows. Please also note, that where modifier keys are used (such as Shift and Control), the key must be programmed to turn on and then off again. For example, to programme Control+C SoftProg should be manually programmed as [+-LControl], [c] and then [+-LControl].

 

Change Key Legend

Highlight the key and use [Edit>Edit] or double click on the key. Select the Legend tab. For each required legend click [Add], select the position where the text should appear on the key (for example, top, left). Then select the font, size, weight and colour. Type the required characters. (They may also be added by double clicking in the scroll down list on the right).

 

9. Magnetic Swipe Card Reader Settings

 

 

Note

On USB keyboards the MSR reader is a separate USB device and is programmed separately from the keyboard functionality. Use template ACR75.

 

Track Settings

Each Track is enabled/disabled by clicking in its Enable check box.
Note: Some products do not support all tracks.
If the Required check box for a track is ticked then data will only be sent if there is a good read on that track.
If the 'if all tracks OK' check box is set then data will only be sent if there is a good read on all the enabled tracks, e.g. a Track 2 only card will not be read if Track 1 is enabled.

 

Control Characters

The Start Code, End Code and LRC tick boxes control whether these control characters are sent to the PC.

 

Header and Terminator

The header is a character or string, which is sent before the MSR data.
The terminator is a character or string, which is sent after the MSR data.
The header & terminator are programmed in the same way as a key. See Editing Key Functionality.

 

MSR Sounder

For products, which have a sounder you can set the sounds for good and bad, reads.

 

End Sentinel / LRC Check

This option is not available on all products. These should normally be checked. If you have an application where they should be disabled please contact Access IS.

 

10. Importing Programming Files from Previous Versions

 

 

Note

When installing SoftProg check all boxes, when asked to select templates.

 

Procedure

To use a .PRG file created by an earlier version of SoftProg32 you may be able to simply open it. Try this first.

 

When opening the file you may get the following message: "The correct template cannot be found". Please use FILE->NEW to select the correct layout and then use FILE->OPEN to open this file.

 

If this happens:

 

  • Use FILE->NEW and select the layout that matches your keyboard. Note that some layouts are available for a number of interfaces - please see Table 1 to check you have the right one for your keyboard. If you are unsure please contact Access IS.
  • Open your programming file.
  • Your programming data will be read in to the template.
  • Use File>Save As. When specifying the file name, put in a name without an extension (e.g. 'myfile' not 'myfile.prg'). SoftProg will automatically save it in the current SoftProg format.

 

11. Downloading Programming Files to a Keyboard

 

 

Once a new programme has been finished and saved, ensure the keyboard is connected and then select File>Program>Keypad.

 

Alternatively, type CTRL+K or click on the 'Download to Keyboard' shortcut.

 

12. Revision History

 

 

Rev 1.0 - June 2007 - original.

Rev 1.1 - August 2007 - Added details on setting keyboard parameters.

Rev 1.3 - September 2008 - Application of new company branding to document.

Rev 1.4 - November 2008 - Added notes on file types to section 1.

Rev 1.5 - March 2010 - Some instructions modified to make them more explicit.

 

All rights reserved. Whilst every precaution has been taken in the preparation of this manual, Access Ltd assumes no responsibility for errors or omissions. Neither is any liability assumed for damages resulting from the use of the information contained herein. We reserve the right to change the specifications, functions and circuitry of the product without notice. All trademarks mentioned in this manual are acknowledged to be the property of the respective trademark owners.

 

 

Installation and Layout Templates

 
 

1. To install SoftProg, click the blue 'Download SoftProg' button (above) and follow the on-screen instructions. If you already have the latest version of SoftProg but want the latest set of templates, please click here.

 

 

2. During the installation process you will
see the 'Template (KPD) Option' screen.

 

Select:

 

  • 'Classic Keyboards' for all keyboards with part numbers beginning 'AKEKPD';
  • 'USB Compact' for all other USB keyboards;
  • 'PS/2 Compact' for all other PS/2 keyboards.

 

The installation will default to install USB
and PS/2 keyboards only.

 

 

 

3. To open SoftProg in Windows click on the Start menu>All Programs>Access IS>SoftProg 32>SoftProg 32.

 

To begin using SoftProg, refer to the User Guide at the top of this page.

 

 

 

Layout Template Updates

 

From time to time we make available new base layouts for SoftProg. To download the latest templates, click on the link below and follow the on-screen instructions.

 

SoftProg templates
This file was last updated February 2011