Text wraps if
necessary:
No
Receives
selection:
Yes
Hide on phone
lock:
No
Class
ID:
{05E393E9-1712-41ac-B9D3-533B52F10A36}
This plug-in adds new
attribute “selectable” which allows
the user to define whether the plug-in is indeed selectable (“true”) or not (“false”). The default value is “true”. An example of this feature is
shown below:
<plugin clsid="{05E393E9-1712-41ac-B9D3-533B52F10A36}"
height="40" selectable=”false”>
The representation of
the monitor can be controlled by using three main elements , and .
Table
1. Supported attributes
of the
element
|
Attribute |
Description |
|
bgcolor |
Background
color for the plug-in. Default is transparent. |
|
bgimage |
Background
image for the plug-in, drawn over top of the background color. Default is
system foreground color. |
|
transparent-color |
The color
within the background image that should be used as transparent. This
parameter is optional. |
|
Halign |
Horizontal
alignment of the background image within the plug-in's rectangular region. Default is
left. |
|
Valign |
Vertical
alignment of the background image within the plug-in's rectangular region. Default is
top. |
|
l-border-width
t-border-width
r-border-width
b-border-width |
Specifies the
width of the left/top/right/bottom border in pixels. Default value is no
width (i.e. no border). |
|
l-border-color
t-border-color
r-border-color
b-border-color |
Specifies the
color of the left/top/right/bottom border. Default value is
black. |
Table
2. Supported attributes
of the
element
|
Attribute |
Description |
|
state |
The plug-in
state to which the formatting applies. Default is 'unselected'. Supported states
are 'selected' and 'unselected'. |
|
bgcolor |
The background
color for the element. The background image is drawn over-top of the
background color. Default value is the system background color. 'transparent' is also accepted as a value. Does not
apply to text backgrounds. |
|
bgtext |
Background
color for text. Default value is 'transparent'. |
|
font-face |
Font face used
to display the element's text. Default value is the system
font. |
|
font-size |
Size, in
pixels, of the font used to display the element's text. Default value is
the system size. |
|
font-style |
Whether the
font is italics or normal. Default value is
normal. |
|
font-weight |
Controls the
weight of the font display. Standard values are between 100 and 900,
increasing in 100-weight increments. The values 'bold' (equals 700) and 'normal' (equals 400) are also
accepted. Default value is 400. |
|
font-quality |
Decides what
sort of quality the font should use. Valid values are 'normal', 'cleartype' and 'draft'. |
|
padding-left |
Specifies the
distance between the contents of the plug-in and the left border of the
plug-in. Default value 0px. |
|
padding-right |
Specifies the
distance between the contents of the plug-in and the right border of the
plug-in. Default value is 0px. |
|
padding-top |
Specifies the
distance between the contents of the plug-in and the top border of the
plug-in. Default value is 0px. |
|
padding-bottom |
Specifies the
distance between the contents of the plug-in and the bottom border of the
plug-in. Default value is 0px. |
Colors are specified
using the HTML/CSS format, #RRGGBB, where RR,
GG, and
BB are the hex amounts
for the red, green, and blue
Table
3. Supported attributes
of the
element
|
Attribute |
Description |
|
state |
The plug-in
state to which the formatting applies. Default is 'unselected'. Supported states
are 'selected' and 'unselected'. |
|
refresh |
The number of
seconds between refreshes of data. The default value is “60”. To deactivate the Automatic
Refresh feature, simply enter a value of “0”. WARNING: Using a
small interval will impact in the battery life of your
phone! |
The
element can contain a number of sub-elements to display information according to
the user preferences. These sub-elements are ,
,
,
,
,
,
,
,
<meterbar/>
and .
Each of these elements has a number of attributes that allow SmartMonitor to determine the information that the user
wishes to display. The following tables list the attributes pertaining to each
sub-element.
Table
4. Supported attributes
of the >
,
, and
sub-elements
|
Attribute |
Description |
|
x |
The
x-coordinate (horizontal) in pixel units within the plug-in’s rectangular region where the text is to be
placed. The range is from 0 to (width – 1) |
|
y |
The
y-coordinate (vertical) in pixel units within the plug-in’s rectangular region where the text is to be
placed. The range is from 0 to (height – 1) |
|
color |
Specifies the
color of the text. Default value is
black. |
Table
5. Supported attributes
of the
sub-element
|
Attribute |
Description |
|
x |
The
x-coordinate (horizontal) in pixel units within the plug-in’s rectangular region where the text is to be
placed. The range is from 0 to (width – 1) |
|
y |
The
y-coordinate (vertical) in pixel units within the plug-in’s rectangular region where the text is to be
placed. The range is from 0 to (height – 1) |
|
color |
Specifies the
color of the text. Default value is black. |
|
units |
The units in
which the temperature is to be displayed. Possible values are “Centigrade” or “C” and “Fahrenheit” or “F”. |
|
offset |
Offset to be
added (or subtracted) to the actual temperature value. This allows the
user to bring the phone temperature in line with room temperature. Please
note that this will be an approximation to the discretion of the user, and
no accuracy should be expected from this method. Default value is “0”. |
|
scale |
Scale that
multiplies the system temperature to magnify it or reduce it. This is
primarily used to correct defective implementations of the standard by
different manufacturers/models. Phones such as the MPx 220 and the SPV E200 seem to require a value of “10” whereas the SPV C500 does
not need scaling. Default value is “1”. |
|
decimal |
When set to “false” tells the plugin not to use a decimal point to represent the
temperature value. The default value is “true”. |
Table
6. Supported attributes
of the
sub-element
|
Attribute |
Description |
|
x |
The
x-coordinate (horizontal) in pixel units within the plug-in’s rectangular region where the text is to be
placed. The range is from 0 to (width – 1) |
|
y |
The
y-coordinate (vertical) in pixel units within the plug-in’s rectangular region where the text is to be
placed. The range is from 0 to (height – 1) |
|
color |
Specifies the
color of the text. Default value is black. |
|
units |
The units in
which the amount of storage space is to be displayed. Possible values are
“Byte” or “B”, “Kilobyte” or “Kb” and “Megabyte” or “Mb”. |
|
path |
The path of the
folder that needs to be analyzed. Examples of this are “\Storage” for the user storage
area or “\Storage Card” for
the user’s memory card. |
Table
7. Supported attributes
of the
sub-element
|
Attribute |
Description |
|
x |
The
x-coordinate (horizontal) in pixel units within the plug-in’s rectangular region where the text is to be
placed. The range is from 0 to (width – 1) |
|
y |
The
y-coordinate (vertical) in pixel units within the plug-in’s rectangular region where the text is to be
placed. The range is from 0 to (height – 1) |
|
color |
Specifies the
color of the text. Default value is black. |
|
units |
The units in
which the amount of memory is to be displayed. Possible values are “Byte” or “B”, “Kilobyte” or “Kb” and “Megabyte” or “Mb”. |
Table
8. Supported attributes
of the
sub-element
|
Attribute |
Description |
|
x |
The
x-coordinate (horizontal) in pixel units within the plug-in’s rectangular region where the icon is to be
placed. The range is from 0 to (width – 1) |
|
y |
The
y-coordinate (vertical) in pixel units within the plug-in’s rectangular region where the icon is to be
placed. The range is from 0 to (height – 1) |
|
transparent-color |
Specifies the
color within the icon that should be used as transparent. This attribute
is optional, and if not present, the icon will be draw
as-is. |
|
file |
The file name
(including full path) to the image to be drawn. An example of this would
be “\Storage\Application
Data\Home\Monitor\battery.bmp” |
Table
9. Supported attributes
of the
sub-element
|
Attribute |
Description |
|
x |
The
x-coordinate (horizontal) in pixel units within the plug-in’s rectangular region where the icon is to be
placed. The range is from 0 to (width – 1) |
|
y |
The
y-coordinate (vertical) in pixel units within the plug-in’s rectangular region where the icon is to be
placed. The range is from 0 to (height – 1) |
|
transparent-color |
Specifies the
color within the icon that should be used as transparent. This attribute
is optional, and if not present, the icon will be draw
as-is. |
|
icon-high |
The file name
(including full path) of the image representing the battery when in high
charge. An example of this would be “\Storage\Application
Data\Home\Monitor\battery_high.bmp” |
|
icon-low |
The file name
(including full path) of the image representing the battery when in low
charge. An example of this would be “\Storage\Application
Data\Home\Monitor\battery_low.bmp” |
|
icon-critical |
The file name
(including full path) of the image representing the battery when about to
disconnect due to low charge. An example of this would be “\Storage\Application
Data\Home\Monitor\battery_critical.bmp” |
|
icon-charging |
The file name
(including full path) of the image representing the battery when charging.
An example of this would be “\Storage\Application
Data\Home\Monitor\battery_charging.bmp” |
|
icon-nobattery |
The file name
(including full path) of the image representing the case when there is no
battery installed. An example of this would be “\Storage\Application
Data\Home\Monitor\battery_missing.bmp” |
Table
10. Supported attributes
of the <meterbar/>
sub-element
|
Attribute |
Description |
|
x |
The
x-coordinate (horizontal) in pixel units within the plug-in’s rectangular region where the meter-bar is to be
placed. The range is from 0 to (width – 1) |
|
y |
The
y-coordinate (vertical) in pixel units within the plug-in’s rectangular region where the meter-bar is to be
placed. The range is from 0 to (height – 1) |
|
transparent-color |
Specifies the
color within the meter-bar that should be used as transparent. This
attribute is optional, and if not present, the meter-bar will be draw
as-is. |
|
image-empty |
The file name
(including full path) to the image representing the empty meter-bar. An
example of this would be “\Storage\Application
Data\Home\Monitor\bar_empty.bmp” |
|
image-full |
The file name
(including full path) to the image representing the full meter-bar. An
example of this would be “\Storage\Application
Data\Home\Monitor\bar_full.bmp” |
|
bar-direction |
Specifies the
direction in which the meter-bar is filled as the percentage shown grows.
The possible values are “left-right”, “right-left”, “top-bottom”, “bottom-top”. The default is “left-right”. |
|
type |
The type of
data that is represented by the meter-bar. Available values are “battery”, “memory-free”, “memory-used”, “memory-load”, “storage-free”, “storage-used”
and “signal-strength”. The
default value is “battery”.
The way in which the type of battery, memory or storage that is
represented is selected is by using the “details” attribute (see
below). |
|
details |
This attribute
complements the “type” attribute by specifying the data source so that
there are no ambiguities. The following table explains its
use:
|
type |
details |
|
battery |
This
attribute could be “backup” to specify the backup battery, or not
used to represent the main battery. The default is the main
battery. |
|
memory-* |
The
possible values are “physical”, “virtual” and “pagefile”. The default is “physical” (i.e. System
RAM) |
|
memory-load |
This
attribute is not used. |
|
storage-* |
The value
of this attribute represents the “path” attribute that would
be used if using a
sub-element. |
|
signal-strength |
This
attribute is not used. |
|
Table
11. Supported attributes
of the
sub-element
|
Attribute |
Description |
|
x |
The
x-coordinate (horizontal) in pixel units within the plug-in’s rectangular region where the meter-bar is to be
placed. The range is from 0 to (width – 1) |
|
y |
The
y-coordinate (vertical) in pixel units within the plug-in’s rectangular region where the meter-bar is to be
placed. The range is from 0 to (height – 1) |
|
transparent-color |
Specifies the
color within the meter-bar that should be used as transparent. This
attribute is optional, and if not present, the meter-bar will be draw
as-is. |
|
image-min |
The file name
(including full path) to the image representing the thermometer when
indicating its minimum temperature. An example of this would be “\Storage\Application
Data\Home\Monitor\thermometer_min.bmp” |
|
image-max |
The file name
(including full path) to the image representing the thermometer when
indicating its maximum temperature. An example of this would be “\Storage\Application
Data\Home\Monitor\thermometer_max.bmp” |
|
bar-direction |
Specifies the
direction in which the meter-bar is filled as the percentage shown grows.
The possible values are “left-right”, “right-left”, “top-bottom”, “bottom-top”. The default is “left-right”. |
|
temperature-min |
The equivalent
temperature of the edge of the image representing the minimum value of the
thermometer. |
|
temperature-max |
The equivalent
temperature of the edge of the image representing the maximum value of the
thermometer. |
|
offset |
Offset to be
added (or subtracted) to the actual temperature value. This allows the
user to bring the phone temperature in line with room temperature. Please
note that this will be an approximation to the discretion of the user, and
no accuracy should be expected from this method. Default value is
“0”. |
|
scale |
Scale that
multiplies the system temperature to magnify it or reduce it. This is
primarily used to correct defective implementations of the standard by
different manufacturers/models. Phones such as the MPx 220 and the SPV E200 seem to require a value of “10” whereas the SPV C500 does
not need scaling. Default value is “1”. |
The above parameters
would not be of much use if we couldn’t customize the type of information
displayed by each of the sub-elements above. In order to do this, tags can be
introduced within the text surrounded by the sub-element delimiters to inform
SmartMonitor of the type of information the user
wishes to display. Tags are always surrounded by curly-braces like so {tagname}. The following
tables show the tags that are available for each of the
sub-elements.
Table
12. Supported tags of
the
sub-element
|
Tag |
Description |
|
{life-percentage} |
Battery Life
Percentage |
|
{life-in-seconds} |
Battery Life in
Seconds. Will display "???" if not supported by
your phone |
|
{life-in-minutes} |
Battery Life in
Minutes. Will display "???" if not supported by
your phone |
|
{life-in-hours} |
Battery Life in Hours.
Will display "???" if not supported by
your phone |
|
{life-in-days} |
Battery Life in Days.
Will display "???" if not supported by
your phone |
|
{full-life-in-seconds} |
Battery Full Life in
Seconds. Will display "???" if not supported by
your phone |
|
{full-life-in-minutes} |
Battery Full Life in
Minutes. Will display "???" if not supported by
your phone |
|
{full-life-in-hours} |
Battery Full Life in
Hours. Will display "???" if not supported by
your phone |
|
{full-life-in-days}
|
Battery Full Life in
Days. Will display "???" if not supported by
your phone |
|
{backup-life-percentage} |
Backup
Battery Life
Percentage |
|
{backup-life-in-seconds} |
Backup
Battery Life in Seconds. Will display
"???" if not
supported by your phone |
|
{backup-life-in-minutes} |
Backup
Battery Life in Minutes. Will display
"???" if not
supported by your phone |
|
{backup-life-in-hours} |
Backup
Battery Life in Hours. Will display
"???" if not
supported by your phone |
|
{backup-life-in-days} |
Backup
Battery Life in Days. Will display
"???" if not
supported by your phone |
|
{backup-full-life-in-seconds} |
Backup
Battery Full Life in Seconds. Will
display "???"
if not supported by your phone |
|
{backup-full-life-in-minutes} |
Backup
Battery Full Life in Minutes. Will
display "???"
if not supported by your phone |
|
{backup-full-life-in-hours} |
Backup
Battery Full Life in Hours. Will display
"???" if not
supported by your phone |
|
{backup-full-life-in-days} |
Backup
Battery Full Life in Days. Will display
"???" if not
supported by your phone |
|
{voltage-in-volts} |
Battery Voltage in
Volts |
|
{voltage-in-millivolts} |
Battery Voltage
in mVolts |
|
{current-in-amps} |
Battery Current in
Amps |
|
{current-in-milliamps} |
Battery Current
in mAmps |
|
{consumption-in-amph} |
Battery Consumption in
AH |
|
{consumption-in-milliamph} |
Battery
Consumption in mAH |
|
{backup-voltage-in-volts} |
Backup
Battery Voltage in
Volts |
|
{backup-voltage-in-millivolts} |
Backup Battery
Voltage in milliVolts |
|
{chemistry} |
Battery
Chemistry (e.g. “Alkaline”, “Nickel Cadmium”…) |
|
{chemistry-short} |
Battery
Chemistry Short version (e.g. “Alk”, “NiCd”…) |
|
{ac-line-status} |
AC Line Status
(e.g “Online”,
“Offline”…) |
|
{ac-line-status-short} |
AC Line Status
Short version (e.g “On”,
“Off”…) |
|
{flag} |
Battery Flag
(e.g. “High”, “Low”, “Charging”…) |
|
{flag-short} |
Battery Flag
Short version (e.g. “Hi”, “Lo”,
“Chg”…) |
Table
13. Supported tags of
the
sub-element
|
Tag |
Description |
|
{long-name} |
Long name of
the Operator the phone is currently registered with. Will display
"???" if the
phone is not registered with an Operator |
|
{short-name} |
Short name of
the Operator the phone is currently registered with. Will display
"???" if the
phone is not registered with an Operator |
Table
14. Supported tags of
the
sub-element
|
Tag |
Description |
|
{strength-percentage} |
Percentage of
signal strength in the phone (0% mean no signal, 100% means excellent
signal) |
Table
15. Supported tags of
the
sub-element
|
Tag |
Description |
|
{temperature} |
Temperature of
the phone as measured by battery sensor in the units given by the "units"
attribute (either in C or F) |
|
{temp} |
Same as above
but in abbreviated form |
Table
16. Supported tags of
the
sub-element
|
Tag |
Description |
|
{free} |
Free storage
available in the "path" in the units given by the "units" attribute (either B, Kb or Mb). Will display
"???" if path
does not exist |
|
{free-percentage} |
Percentage of
free storage available in the "path". Will display "???" if path does not
exist |
|
{used} |
Storage used in
the "path" in the units given by the "units" attribute (either B, Kb or Mb). Will display
"???" if path
does not exist |
|
{used-percentage} |
Percentage of
used storage in the "path". Will display "???" if path does not
exist |
|
{total} |
Total storage
space available in the "path" in the units given by the "units" attribute
(either B, Kb or Mb) . Will display "???" if path does not
exist |
|
{free-user} |
Free storage
available to the user in the "path" in the units given by the "units"
attribute (either B, Kb or Mb) . Will display
"???" if path
does not exist |
Table
17. Supported tags of
the
sub-element
|
Tag |
Description |
|
{free} |
Free physical
memory available in the system in the units given by the "units" attribute
(either b, kb or Mb) |
|
{free-percentage} |
Percentage of
free physical memory available in the system |
|
{used} |
Used physical
memory in the system in the units given by the "units" attribute (either
b, kb or Mb) |
|
{used-percentage} |
Percentage of
used physical memory in the system |
|
{total} |
Total physical
memory available in the system in the units given by the "units" attribute
(either b, kb or Mb) |
|
{free-virtual} |
Free virtual
memory available in the system in the units given by the "units" attribute
(either b, kb or Mb) |
|
{free-virtual-percentage} |
Percentage of
free virtual memory available in the system |
|
{used-virtual
} |
Used virtual
memory in the system in the units given by the "units" attribute (either
b, kb or Mb) |
|
{used-virtual-percentage} |
Percentage of
used virtual memory in the system |
|
{total-virtual} |
Total virtual
memory available in the system in the units given by the "units" attribute
(either b, kb or Mb) |
|
{free-page} |
Free page file
memory available in the system in the units given by the "units" attribute
(either b, kb or Mb) |
|
{free-page-percentage} |
Percentage of
free page file memory available in the system |
|
{used-page
} |
Used page file
memory in the system in the units given by the "units" attribute (either
b, kb or Mb) |
|
{used-page-percentage} |
Percentage of
used page file memory in the system |
|
{total-page} |
Total page file
memory available in the system in the units given by the "units" attribute
(either b, kb or Mb) |
|
{memory-load} |
Percentage of
memory currently in use (0 to
100) |