Grandstream Networks GXP-2000 user manual

Summary of the content on the page No. 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

Summary of the content on the page No. 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 fil

Summary of the content on the page No. 3

XML Based Customizable Screen

Summary of the content on the page No. 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 scr

Summary of the content on the page No. 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’

Summary of the content on the page No. 6

XML Based Customizable Screen 2. $N: This variable is replaced with the configured Account 1 Display Name. 3. $X: This variable is replaced with the configured Account 1 SIP User ID. 4. $V: This variable is replaced with the configured Account 1 SIP Server. 5. $I: This variable is replaced with the system IP address. 6. $D: This variable is replaced with the current day of month with leading zero, possible values: 01, 02, …, 31 7. $d: This variable is replaced with the current da

Summary of the content on the page No. 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.

Summary of the content on the page No. 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 centere