Grandstream Networks GXP-2000 User's Manual
Contents
1. lt X gt 65 lt X gt lt Yol2ap Y gt lt DisplayString gt lt DisplayString font fl3b halign Center alreg true lt DisplayStr gt N lt DisplayStr gt lt X gt 65 lt X gt Yol2 Ys lt DisplayString gt lt DisplayString font fl3h halign Center alreg false gt lt DisplayStr gt X lt DisplayStr gt 5 lt X gt lt Y gt 26 lt Y gt lt DisplayString gt lt DisplayString font fl3b halign Center alreg true gt isplayStr gt X lt DisplayStr gt lt X gt 65 lt X gt 26 lt Y gt lt DisplayString gt lt DisplayString halign Center valign Bottom gt lt DisplayStr gt l lt DisplayStr gt lt X gt 65 lt X gt lt gt 48 lt Y gt lt DisplayString gt lt dl eScreen gt lt Screen gt 5 XML Explanation www grandstream com eFuanistteam aM Based Customizabe Sereen Root Element Screen The XML document has root element called screen it contains exactly 1 sub element called dl eScreen lt xsd element name Screen gt lt xsd compl exType gt lt xsd sequence gt lt xsd element name IdleScreen type IdleScreenType minOccurs 1 maxOccurs 1 gt lt xsd sequence gt lt xsd compl exType gt lt xsd element gt Element IdleScreenType This element defines three components that are makes up the idle screen These components are defined as elements lt xsd complexType name I dl eScreenType2. Attribute halign This OPTIONAL attribute specifies the horizontal alignment method used to display the string lt xsd attribute name halign type Horizontal Alignment Type gt lt xsd simpleType name Hori zontal Ali gnmentType gt lt xsd restriction base xsd string gt lt xsd enumeration value Left gt lt xsd enumeration val ue Center gt lt xsd enumeration value Right gt lt xsd restriction gt lt xsd simpl eType gt We will default to Left when this attribute is absent Note When using the Center alignment you will need to calculate the midpoint for the x coordinate 4 5 2 for the width to be considered centered For instance element X must be set to 65 130 2 to display a string that is aligned to the center of the LCD Similarly you will need to specify the right most point to render if you are using the Right halign method Attribute valign This OPTIONAL attribute specifies the vertical alignment method used to display the string lt xsd attribute name valign type VerticalAlignmentType gt www grandstream com CAIN nar Based Customizable Sereen lt xsd simpleType name VerticalAlignmentType gt lt xsd restriction base xsd string gt lt xsd enumeration value Top gt lt xsd enumeration val ue Center gt lt xsd enumeration val ue Bottom gt lt xsd restriction gt lt xsd simpl eType gt We will default to Top when this attribute is absent Note When us
3. gt lt xsd sequence gt lt xsd element name ShowStatusLine type xsd boolean mi nOccurs 1 maxOccurs 1 default true gt lt xsd element name DisplayBitmap type DisplayBit mapType mi nOccurs 0 nillable true gt lt xsd element name DisplayString type DisplayStringType minOccurs 0 nillable true gt lt xsd sequence gt lt xsd compl exType gt Note By the above grammar ShowStatusLine must appear exactly once and any number of Disp ayBitmap and DisplayString instances Display Rules When both DisplayBitmap and DisplayString elements are present all bitmaps will be rendered before the strings are displayed When multiple instances of the same type bitmap string are present they are displayed in the order they appear in the XML and later objects bitmap string may overwrite corrupt previous objects Element ShowStatus Line This Boolean element decides if we will display the status bar on the top of the screen The Status Line includes the registration status icon volume icon time date on the right top corner and the horizontal separator line This element must appear exactly once in IdleScreenType and has a default value of true When set to false the origin x 0 y 0 refers to the absolute top left corner when set to true the origin refers to the reference origin below status line x 0 y 16 This means when ShowStatusLine is set to true all y offsets are shift down for 16 pixel
4. curs 1 de lt xsd element name Y typ sazi nt de integer minOccurs 1 maxOccurs 1 Attribute alreg This OPTIONAL attribute specifies the conditions when the string will be displayed lt xsd attribute name alreg type xsd boolean gt When this attribute is present and the value is true then the string will be displayed ONLY when SIP Account 1 is in REGISTERED state www grandstream com eFinistiean nat Basea Customizable Sereen When this attribute is present and the value is false then the string will be displayed only when SIP Account is NOT in REGISTERED state Note When this attribute is absent then this bitmap is displayed regardless to the SIP Account registration states Attribute font This OPTIONAL attribute specifies the font we will use to render the string lt xsd attribute name font type fontType gt lt xsd simpleType name font Type lt xsd restriction base xsd lt xsd enumeration value lt xsd enumeration value lt xsd enumeration value lt xsd enumeration value lt xsd enumeration value lt xsd enumeration value lt f18c is a 18 point C lt xsd enumeration value f lt i xsde restrict on gt lt xsd simpl eType gt es In this version we will support 1 system font and 7 additional fonts in various sizes as enumerated above Any fonts not recognize will default to the system font When this attribute is absent then we will also default to system font
5. e AURRI sez masen Customizable Seren 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 O 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
6. ember 9 o This variable is replaced with the current month in number with leading zero possible values 01 02 12 10 n This variable is replaced with the current month in number without leading zero possible values 1 2 12 11 Y This variable is replaced with the current year in 4 digit number for example 2006 2007 12 y This variable is replaced with the current year in 2 digit number for example 06 07 13 P This variable is replaced with the current AM PM status in upper case possible values AM PM 14 p This variable is replaced with the current AM PM status in lower case possible values am pm 15 H This variable is replaced with the current hour of day in 24 hour representation with leading zero possible values 00 02 23 16 h This variable is replaced with the current hour of day in 12 hour representation with leading zero possible values 01 02 12 17 m This variable is replaced with the current minute of hour with leading zero possible values 01 02 59 18 s This variable is replaced with the current second of minute with leading zero possible values 01 02 59 ON SL a E Note If you want to display the sign you will use escape sequence Elements X and Y This element contains X and Y offsets from the origin that we will use to render the string lt xsd element name X type xsd integer minOccurs 1 maxOc
7. ing the Center alignment you will need to calculate the midpoint for the y coordinate 4 5 3 for the width to be considered centered For instance element Y must be set to 32 to display a string that is aligned to the center of the LCD Similarly you will need to specify the right most point to render if you are using the Bottom valign method set to 64 www grandstream com
8. nteger minOccurs 1 maxOccurs 1 default 0 gt Sd integer minOccurs 1 maxOccurs 1 default 0 gt X g zS n An hh mno en ee een www grandstream com e fandstream ML Based Customizable Sereen lt xsd restriction base xsd string gt lt xsd enumeration value Left gt lt xsd enumeration value Center gt lt xsd enumeration value Right gt lt xsd restriction gt lt xsd simpl eType gt lt xsd attribute gt lt xsd attribute name valign gt lt xsd simpl eType gt lt xsd restriction base xsd string gt lt xsd enumeration value Top gt lt xsd enumeration value Center gt lt xsd enumeration value Bottom gt lt xsd restriction gt lt xsd si mpl eType gt lt xsd attri bute gt lt xsd compl exType gt lt xsd element gt lt xsd sequence gt lt xsd compl exType gt lt xsd el ement gt lt xsd Sequence gt lt xsd compl exType gt lt xsd el ement gt lt xsd schema gt 4 Example Idle Screen File lt xml version 1 0 gt lt This file creates identical result to GXP 2000 default behavior gt lt Screen gt lt I dl eScreen gt lt ShowStatusLine gt true lt ShowStatusLine gt lt DisplayString font f8 gt lt DisplayStr gt W M d lt DisplayStr gt lt X gt 0 lt X gt lt Y gt 0 lt Y gt lt DisplayString gt lt DisplayString font fl3h halign Center alreg false gt lt DisplayStr gt N lt DisplayStr gt
9. s so the status line will not be corrupted or over written www grandstream com CFuiisttean e Based Customizable Sereen 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 lt xsd element name Bitmap type xsd base64Bi nary minOccurs 1 maxOccurs 1 gt Note We only accept Windows Bitmap file header begins with 0x424D that is monochrome l bit depth and not exceeding 130x65 pixels that s our LCD resolution Anything not bound to the above restriction is dropped and ignored You may use Windows Paint to change an existing BMP file to 1 bit depth Elements X and Y This element contains X and Y offsets from the origin that we will use to render the bitmap lt xsd element name X teger minOccurs 1 maxOccurs 1 d lt xsd element name Y d type xsd in type xsd integer minOccurs 1 maxOccurs 1 Attribute alreg This OPTIONAL attribute specifies the conditions when the bitmap will be displayed lt xsd attribute name alreg type xsd boolean gt When this attribute is present and the value is true then the bitmap will be displayed ONLY when SIP Account is in REGISTERED state When this attribute is present and the value is false then the bitmap will be displayed only when SIP Account is NOT in REGISTERED s
10. t true gt lt xsd element name DisplayBitmap minOccurs 0 maxOccurs unbounded nillable true gt lt xsd compl exType gt lt xsd sequence gt lt We only accept Windows Monochrome Bitmap max 130x64 pixels encoded by base64 lt xsd element name Bitmap ty lt xsd element name X type lt xsd element name Y type lt xsd sequence gt lt xsd attribute name alreg type xsd boolean gt lt xsd compl exType gt lt xsd element gt lt xsd element name DisplayString minOccurs 0 maxOccurs unbounded nillable true gt lt xsd compl exType gt lt xsd Sequence gt lt xsd element name DisplayStr type xsd string minOccurs 1 maxOccurs 1 gt lt xsd element name X type xsd i nteger minOccurs 1 maxOccurs 1 default 0 gt lt xsd element name Y type xsd integer minOccurs 1 maxOccurs 1 default 0 gt lt xsd sequence gt lt xsd attribute name alreg type xsd boolean gt lt xsd attribute name font gt lt xsd simpl eType gt lt xsd restriction base xs lt xsd enumeration value lt xsd enumeration value lt xsd enumeration value lt xsd enumeration value lt xsd enumeration value lt xsd enumeration value lt f18c is a 18 point C lt xsd enumeration value f lt xsd restriction gt lt xsd simpl eType gt lt xsd attri bute gt lt xsd attribute name halign gt lt xsd simpl eType gt pe xsd base64Binary mi nOccurs 1 maxOccurs 1 gt sd i
11. tate Note When this attribute is absent then this bitmap is displayed regardless to the SIP Account registration states Element DisplayString This element carries the information on how a string is to be rendered on screen It has three mandatory elements and four optional attributes Element DisplayStr This element contains the string to be displayed lt xsd element name DisplayStr type xsd string minOccurs 1 maxOccurs 1 gt The string can contain dynamic contents As present we support the following 18 system variables that will be substituted with dynamic contents at run time 1 W This variable is replaced with the current day of week and has the following possible values Sunday Monday Tuesday Wednesday Thursday Friday Saturday www grandstream com e Funisttean Based Customizable Sereen 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 d This variable is replaced with the current day of month without leading zero possible values 1 2 31 8 M This variable is replaced with the current month in English possible values January February Dec
12. 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 www grandstream com e fandsteam nar Based Customizable Seren 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 Copy the user idle screen file into the XML document field on the website 4 click validate 5 Verify if the validation result is successful If not there is structure error in the user idle screen file XSD file lt xml version 1 0 gt lt xsd schema xmins xsd http www w3 org 2001 XMLSchema gt lt xsd element name Screen gt lt xsd compl exType gt lt xsd sequence gt lt xsd element name IdleScreen minOccurs 1 maxOccurs 1 gt lt xsd compl exType gt lt xsd sequence gt lt xsd element name ShowStatusLine type xsd boolean mi nOccurs 1 maxOccurs 1 defaul
Download Pdf Manuals
Related Search