Difference between revisions of "WPI Interface Enhancements"

Revision as of 07:46, 14 September 2010

These are the additions to the DLS protocol for V2R1 compared to V1R5 that are related to the new features. It is included what we did for step 2 (in) as well as what we've done in step 3 (). It is also included a description of "XML app on FPK".

The changes fall into five separate areas: XML application configuration, assign XML application shortcut to programmable key, message waiting options, send URL, and "fixed" key programming.

For detailed information see Configurable Keys on OpenStage.

XML application configuration

There are three new tags defined; these are:

XML-app-control-key 

to indicate which key if any the application is associated with

XML-app-auto-start 

to indicate whether the application is automatically started in the back-ground or only when first selected

XML-app-all-tabs-start 

to indicate whether all the tabs in an application start at once or only the first one

In protocol form they look like this:

<Item name="XML-app-control-key" index="NN">xx</Item>
<Item name="XML-app-auto-start" index="NN">yyyyy</Item> 
<Item name="XML-app-all-tabs-start" index="NN">yyyyy</Item>

The range of values for the index NN is the same as for all the existing XML application related items and is unchanged, i.e. from 1 to 20.

The xx value for the control key item represents an enumeration defined as follows:

• "0" = No mode key.
  This is the default and indicates that the application is run via the applications menu.
• "2" = Phonebook mode key.
  Application runs on the Phonebook mode key (like the existing XMLPhonebook option).
• "3" = CallLog mode key.
  Application runs on the CallLog mode key.
• "4" = Messages mode key.
  Application runs on the Messages mode key (like the existing Xpressions option).
• "6" = Help mode key.
  Application runs on the Help mode key.

The values 1 and 5 are reserved for future use.

To some extent, the existing special-instance tag overlaps with the new control-key tag. We want to deprecate the special-instance tag but we need to retain it for backwards compatibility. Ideally, all applications would be specified with a special instance of normal and the new control key tag used to indicate the key to be used if the application is to run on a mode key. However, if the configuration system is to be used to configure applications on both V1R5 and V2R1 phones, then the use of special instance mist be retained in which case the following constraints apply:

If special instance is set to indicate Xpressions then the control key item must indicate Messages (i.e. value 4). Also the application name must be Xpressions.

If special instance is set to indicate XMLPhonebook then the control key item must indicate Phone-book (i.e. value 2). Also the application name must be XMLPhonebook.

No more than one application can be configured to run on the same mode key.

The yyyyy value for the all-tabs-start item and the auto-start item represents a boolean flag so should be set to true or false.

The all-tabs-start item only has meaning for applications where the number of tabs is 2 or 3.

Assign XML application shortcut to programmable key

An application can be associated with a programmable key by setting its function key def value to 60. The key can then be associated with an application by using the new tag FPK-app-name. The value associated with FPK-app-name is the application's display name (not the application name).

<Item index="1" name="function-key-def">60</Item> 
<Item index="1" name="FPK-app-name">MyApp</Item>
<Item index="1" name="key-label-unicode">MyApp</Item>

Message waiting options

The display options for Message Waiting Indication are based on the following 7 new attributes:

• New count label
• New urgent count label
• Old count label
• Old urgent count label
• New urgent count show/hide flag
• Old count show/hide flag
• Old urgent count show/hide flag

These attributes specify alternative labels for the phone to use in place of the built-in labels for any (or all) of the existing four messages counts and whether for the new urgent, old and old urgent counts the count should be displayed or hidden (the new count does not have a show/hide flag because it is always shown). The items have the format:

<Item name="MWI-new-label">xxxx</Item>
<Item name="MWI-new-urgent-label">xxxx</Item>
<Item name="MWI-old-label">xxxx</Item>
<Item name="MWI-old-urgent-label">xxxx</Item>

<Item name="MWI-new-urgent-show">true</Item>
<Item name="MWI-old-show">true</Item>
<Item name="MWI-old-urgent-show">true</Item>

Where in the case of the label tags xxxx is a string of up to 17 unicode characters and in the case of the show/hide flags, the alternative value (meaning to hide the count) is "false". An empty (zero length) label indicates that the phone should use its built-in (default) label; an empty label would typically be sent to remove any previously configured alternative label.

All items are optional in that sending one item does not require the sending of any of the other items if the current settings of those other items do not need to be changed, but there is no harm in re-sending items with values identical to the values already store in the phone.

Default values for these tags should be empty strings for the label tags and true for the show tags.