
XML Based Customizable Screen
www.grandstream.com
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
<xsd:element name="Bitmap" type="xsd:base64Binary" minOccurs="1" maxOccurs="1"/>
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). 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.
<xsd:element name="X" type="xsd:integer" minOccurs="1" maxOccurs="1" default="0"/>
<xsd:element name="Y" type="xsd:integer" minOccurs="1" maxOccurs="1" default="0"/>
Attribute a1reg
This OPTIONAL attribute specifies the conditions when the bitmap will be displayed.
<xsd:attribute name="a1reg" type="xsd:boolean"/>
When this attribute is present and the value is “true” then the bitmap will be displayed
ONLY when SIP Account 1 is in REGISTERED state.
When this attribute is present and the value is “false” then the bitmap 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.
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
<xsd:element name="DisplayStr" type="xsd:string" minOccurs="1" maxOccurs="1"/>
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