User's Manual

ManualsBrandsGrandstream Networks ManualsUniversal RemoteGrandstream Networks Grandstream Networks Universal Remote GXP-2000

XML Based Customizable Screen

www.grandstream.com

XML Based Customizable Screen

Rev 1.3

December 28, 2006

1. Introduction

Starting from release version 1.0.2.X, GXP-2000 supports the idle screen customization. The

designs of the displayed information and layout depend highly upon personal preferences and

requirements and have since been requested by various customers for an API to be able to

customize the screen.

This document specifies the Grandstream XML Customizable Screen API design that will be

used on GXP-2000.

2. How It Works and Configuration

A new set of configuration options will be introduced as following:

 Enable Idle Screen XML Download (P340): NO/YES-HTTP/YES-TFTP

(default NO). Possible values 0 (NO)/1 (HTTP)/2 (TFTP), other values

ignored.

 Idle Screen XML Server Path (P341): This is a string of up to 128 characters

that should contain a path to the XML file. It MUST be in the host/path

format. For example: “directory.grandstream.com/engineering”

The feature will be activated when “Enable Idle Screen XML Download” is set to YES

(HTTP or TFTP) AND a valid “Idle Screen XML Server Path” is set.

This feature does not automatically download the XML file in the path even when activated.

The following 2 options are added to the Preference LCD GUI submenu:

Download SCR XML

Erase Custom SCR

User shall select Download SCR XML under Preference Keypad menu to start the download

process. The phone will attempt to download the gs_screen.xml file specified in “Idle Screen

XML Server Path”. Once the XML is successfully downloaded it will be parsed and be

effective right away. The file should also be saved for future use. Please note that the Idle

Screen file name is fixed, so you can not alter the file name based on your preference.

Summary of content (8 pages)

PAGE 1
XML Based Customizable Screen XML Based Customizable Screen Rev 1.3 December 28, 2006 1. Introduction Starting from release version 1.0.2.X, GXP-2000 supports the idle screen customization. The designs of the displayed information and layout depend highly upon personal preferences and requirements and have since been requested by various customers for an API to be able to customize the screen. This document specifies the Grandstream XML Customizable Screen API design that will be used on GXP-2000. 2.
PAGE 2
XML Based Customizable Screen 3. XML Syntax The XSD file tells the user what the XML file should look like. User does not need to check the structure of the file manually as this process can be automated. One such websites that does this is: http://www.xmlme.com/Validator.aspx This paragraph will explain how to use the website mentioned above to do the syntax checking. 1. Clear the XML schema and XML document fields on the website. 2. Copy the lines below to the XSD file into the XML schema field. 3.
PAGE 3
XML Based Customizable Screen
PAGE 4
XML Based Customizable Screen Root Element “Screen” The XML document has root element called Screen; it contains exactly 1 sub-element called IdleScreen. Element “IdleScreenType” This element defines three components that are makes up the idle screen. These components are defined as elements.
PAGE 5
XML Based Customizable Screen Element DisplayBitmap This element carries the information on how a bitmap is to be rendered on screen. It has three mandatory elements and one optional attribute: Element Bitmap This element contains the bitmap encoded by base64 Note: We only accept Windows Bitmap (file header begins with 0x424D) that is monochrome (1-bit depth) and not exceeding 130x65 pixels (that’s our LCD resolution).
PAGE 6
XML Based Customizable Screen 2. 3. 4. 5. 6. $N: This variable is replaced with the configured Account 1 Display Name. $X: This variable is replaced with the configured Account 1 SIP User ID. $V: This variable is replaced with the configured Account 1 SIP Server. $I: This variable is replaced with the system IP address. $D: This variable is replaced with the current day of month with leading zero, possible values: 01, 02, …, 31 7.
PAGE 7
XML Based Customizable Screen When this attribute is present and the value is “false” then the string will be displayed only when SIP Account 1 is NOT in REGISTERED state. Note: When this attribute is absent then this bitmap is displayed regardless to the SIP Account 1 registration states. Attribute font This OPTIONAL attribute specifies the font we will use to render the string.
PAGE 8
XML Based Customizable Screen We will default to Top when this attribute is absent. Note: When using the Center alignment you will need to calculate the midpoint for the y-coordinate (4.5.3) for the width to be considered centered.