Editing Queen BeeCon Widget

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

Warning: This page is 67 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

[[Category:Software]][[Category:Power users]][[Image:Qbw1.png|500px]]

[[Image:Queen-beecon.png‎|left|logo]]

[[Queen BeeCon Widget]]
([http://talk.maemo.org/showthread.php?t=45388 See Talk Thread]) is a highly customizable and flexible widget-based multi-instance monitoring, alerting and interactive tool for Maemo 5 (Fremantle) and the [[Nokia N900|N900]]. In 8 words ... '''''A Super Powerful and Customizable Widget Generation Engine'''''

The Widget is based on the execution of external Shell/OS Commands which can be either as simple as one-liner statements or as complex as articulated shell scripts, which, for example, fetch, parse and aggregate contents retreived from the system, other applications or the Internet.

There are two basic Widget types, '''Beecons''' and '''Snippets''':

Beecons are small hexagonal cells whose background color or associated image/icon changes according to the executed Command Exit Status.

Beecons can handle virtually unlimited Command Exit Status:

* <code><0</code> Normally notifying '''system errors''' in esecuting the script/command
* <code>0</code> Returned when script/command '''successfully completes'''
* <code>1</code> Used to report a '''warning condition'''
* <code>2</code> If script/command needs to notify some '''application error conditions'''
* <code><=126</code> Other exit status which can be handled for displaying '''user defined icons/images'''

Snippets are normal text/graphic boxes with fixed background color and images which is not influenced by the executed Command Exit Status.

== Current Status in Maemo Repositories ==

[http://maemo.org/packages/view/queen-beecon/ v1.3.3(18/1/2011) extras-devel / v1.3.3(02/09/2011) extras-testing / v1.3.3(07/10/2011) EXTRAs]

== Features List ==

* Widget can be '''multi-instantiated''', '''disabled''' and '''minimized''' on desktop (click on minimized icon on desktop will wakeup and maximize instance)
* Possibility to define multiple commands and command labels to be displayed inside the Widget
* Different types of Widget '''layouts''' and '''behaviours''' (currently Beecons and Snippets)
* Possibility to sense Phone Orientation and execute scripts accordingly
* Possibility to sense GPS/Location information/FIX from the phone and execute scripts accordingly
* Possibility to hide the background Canvas both for Beecons and Snippets 
* Possibility to use icons or images instead of text, both for Beecons/Snippets command '''title''' and '''output'' (with highly versatile positioning, zooming/scaling 5%-200%-FitToWidget)
* Possibility to use '''custom progress animations''' for each instance of the widget (with up to 30 frames, configurable frame period in msec and highly versatile positioning
* It is possible to independently show or hide both snippet's images/texts and beecon images/texts. This way you can have two images and two text placeholders on widget, for more flexibility in graphic layout
* Independent images/icons for Command Exit Statuses can also been specified. Useful, for example, for displaying different icons according to percentages values returned by command.
* Widget can be clicked on 9 different '''Hot Spots''' with a 3x3 grid layout or at specific position with ability to forward the click position to the script
* '''Multi Click''' support on widget
* Nice "button-press"-like visual feedback using Gradient fill 
* Widget relies also on private general purpose directories "<code>~/.queen_beecon_dir/</code>" and "<code>..../MyDocs/.images/queen_beecon_dir/</code>" as images/icons immediate storage. For easier population via USB of BLUETOOTH File Services. 
* Widget texts can be formatted through [http://maemo.org/api_refs/5.0/5.0-final/pango/PangoMarkupFormat.html Pango Markup Language]
* Widget Size can be customized (Width: 10-800, Height: 10-420 with pixel precision) and position can be fine tuned (X,Y +/- 5pix); Tweaking "<code>/usr/share/hildon-desktop/transitions.ini</code>" may also help. (<code>snap_grid_size = 1 & snap_to_grid_while_move = 1</code>)
* Background color for Beecons can be customized for each 4 Command Exit Statuses (with graphical preview)
* Background color for Snippets can be customized (with graphical preview)
* Font Color of both command label and results can be configured (with graphical preview)
* Position and visibility of both command label and results can be configured (Hidden, Top L, Top C, Top R, Center L, Center, Center R, Bottom L, Bottom C, Bottom R) Also, rotation of lables can be changed (0, 90, 180, 270 degrees)
* Font Face, Style and Size of both command label and results can be configured with preview
* Text Justification of both command label and results can be configured (Left, Center, Right, Fill)
* Text Wrapping of results can be enabled
* Command execution can be triggered optionally on widget startup, by manual pressing on Widget, by desktop switching, by periodic updates (0=Manual, 30 s, 1 m, 5 m, 30 m, 1 h, 6 h, 12 h, 1 d, Custom Seconds Interval), by specific DBUS Events on System or Session Bus.which can be filtered through custom rules, by orientation changes, by GPS
* Command execution can be subject to network connection status and widget visibility on current desktop
* Tool includes a powerful Advanced Maintenance Dialog Box for command development and testing (TestDrive mode to display raw output of predefined or user-defined commands)
* A wide set of Parameter Substitution Variables can be passed to executed scripts; variables include: Instance ID, Pressed Hot Spot, Visibility of Widget, Execution Triggering Event, content of Output text, verbose DBUS messages, persistent information stored in widget specific parameter, Proxy related information
* Advanced Maintenance Dialog Box includes extended functionalities like:
** instance export/import with checksum
** command export/import with checksum
** command update with current Test Drive buffer
** clipboard operations
** export/import to/from files for instance data and commands.
* A set of basic Images/Icons for Snippets and Beecon Statuses is included inside the distribution package and installed inside canonical hildon hicolor 48x48 directory
* Inter Process Communication mechanism among QBW instances and with other Applications has been implemented through DBUS methods and signals handling
* It is integrated into the N900 system backup/restore features according to standard specifications as better described in the [[Documentation/Maemo 5 Developer Guide/Generic Platform Components/Using Backup Application#Custom back-up locations|SDK documentation]]
* Powerful Application Logging Subsystem
* For Web and Proxy related information and issues please have a look at the [[#Parameter_Substitution_at_Command.2FScript_Runtime|parameter substitution documentation]] and [http://talk.maemo.org/showpost.php?p=544591&postcount=12 THIS] post.

== Donate ==

[https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QTSK26NUKNXFC Queen BeeCon Widget is free software, but if you feel like donating for supporting further developments or just to let me know that you like it, you can donate via Paypal]

== Icons in Package ==

[[Image:Snap039.png|600px]]

[[Image:DTl8W.png|600px]]

== Settings and Tools ==

=== Standard Settings and Configuration File ===

Global and per-instance QBW parameters are stored in this file:

/home/user/.queen_beecon

==== Configuration Parameters, Types & Reference ====

These are the parameters and settings which can be changed for each QBW instance. They are stored independently, for each Instance, inside the configuration file.

Their reference is also useful for [[#Interaction with QBW over DBUS|Interaction with QBW over DBUS]] and in particular for parameters amendments/fetching methods:

=====Widget Type, Visibility, Status and Associated Command=====

[[Image:Snap193.jpg|350px]]

{|class="wikitable"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
|1||<code>0.0.1</code>||<code>widgetType</code>||<code>int32</code>||<code>0=Beecon<nowiki>|</nowiki>1=Snippet</code>||Specify the type of the instantiated widget
|-
|2||<code>0.1.7</code>||<code>widgetVisible</code>||<code>int32</code>||<code>0=Hidden<nowiki>|</nowiki>1=Visible</code>||Specify if widget components should be visible or not
|-
|3||<code>0.1.4</code>||<code>operationalStatus</code>||<code>int32</code>||<code>0=Enabled<nowiki>|</nowiki>1=Disabled</code>||If disabled, the widget will not be subject to update policies and will be iconified on desktop, a subsequent tap on it will revert its status to Enabled
|-
|4||<code>0.0.1</code>||<code>instanceTitle</code>||<code>string</code>||-||Holds the title of the command/script to be executed. If this field is blank, it means that command is still present in the widget instance but not present any more in the list of possible commands. Can still be adited via "Edit Cmd" button and added again to the list.
|}

====Widget Size & Position Tuning====

[[Image:Snap030.png|350px]]

{|class="wikitable"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
|1||<code>0.0.1</code>||<code>widWidth</code>||<code>double</code>||-||This is the Width of the widget
|-
|2||<code>0.0.1</code>||<code>widHeight</code>||<code>double</code>||-||This is the Height of the widget
|-
|3||<code>1.3</code>||<code>-</code>||<code>-</code>||-||This is the X coordinate of the widget, can be dynamically changed
|-
|4||<code>1.3</code>||<code>-</code>||<code>-</code>||-||This is the Y coordinate of the widget, can be dynamically changed
|}

=====Status Background Colors & Images=====

[[Image:Snap031.png|350px]]

{|class="wikitable"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
|1||<code>0.1.0</code>||<code>hideCanvas</code>||<code>boolean</code>||<code>true<nowiki>|</nowiki>false</code>||If set to true, the geometric canvas of the widget will not be shown
|-
|2||<code>1.0.4</code>||<code>hideClickCanvas</code>||<code>boolean</code>||<code>true<nowiki>|</nowiki>false</code>||If set to true, the geometric canvas of the widget will not be shown on click
|-
|3||<code>0.1.9.1</code>||<code>snippetExtBgRGB</code>||<code>string</code>||<code>#<rrrr><gggg><bbbb></code>||Background color of Snippets
|-
| ||<code>0.1.0</code>||<code>snippetBgRGB</code>||<code>int32</code>||-||Obsoleted as of release >=0.1.9.1
|}

=====Beecon Statuses: Images, Scale, Background Color=====

[[Image:Snap201.jpg|350px]]

{|class="wikitable"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
|1||<code>0.1.0</code>||<code>beecon_lt0_ImgFilename</code>||<code>string</code>||-||Applies to Beecons; it's the filename of the image to be displayed if script/command returns an Exit Status less than zero
|-
|2||<code>0.1.4</code>||<code>beecon_lt0_ImgZoom</code>||<code>int32</code>||<code>0=1:1</code> <code>1=Fit to widget dimensions</code> <code>2=5%</code> <code>3=10%</code> <code>4=15%</code> <code>... till 200%</code>||This is the zoom/scale of the previous parameter's image (1:1, Fit, 5%-200%)
|-
|3||<code>0.1.9.1</code>||<code>beecon_lt0_ExtBgRGB</code>||<code>string</code>||<code>#<rrrr><gggg><bbbb></code>||Applies to Beecons; it's the Background color to be displayed if script/command returns and Exit Status less than zero
|-
|4||<code>0.1.0</code>||<code>beecon_eq0_ImgFilename</code>||<code>string</code>||-||Applies to Beecons; it's the filename of the image to be displayed if script/command returns an Exit Status equals to zero
|-
|5||<code>0.1.4</code>||<code>beecon_eq0_ImgZoom</code>||<code>int32</code>||<code>0=1:1</code> <code>1=Fit to widget dimensions</code> <code>2=5%</code> <code>3=10%</code> <code>4=15%</code> <code>... till 200%</code>||This is the zoom/scale of the previous parameter's image (1:1, Fit, 5%-200%)
|-
|6||<code>0.1.9.1</code>||<code>beecon_eq0_ExtBgRGB</code>||<code>string</code>||<code>#<rrrr><gggg><bbbb></code>||Applies to Beecons; it's the Background color to be displayed if script/command returns and Exit Status equals to zero
|-
|7||<code>0.1.0</code>||<code>beecon_eq1_ImgFilename</code>||<code>string</code>||-||Applies to Beecons; it's the filename of the image to be displayed if script/command returns an Exit Status equals to 1
|-
|8||<code>0.1.4</code>||<code>beecon_eq1_ImgZoom</code>||<code>int32</code>||<code>0=1:1</code> <code>1=Fit to widget dimensions</code> <code>2=5%</code> <code>3=10%</code> <code>4=15%</code> <code>... till 200%</code>||This is the zoom/scale of the previous parameter's image (1:1, Fit, 5%-200%)
|-
|9||<code>0.1.9.1</code>||<code>beecon_eq1_ExtBgRGB</code>||<code>string</code>||<code>#<rrrr><gggg><bbbb></code>||Applies to Beecons; it's the Background color to be displayed if script/command returns and Exit Status equals to 1
|-
|10||<code>0.1.0</code>||<code>beecon_ge2_ImgFilename</code>||<code>string</code>||-||Applies to Beecons; it's the filename of the image to be displayed if script/command returns an Exit Status equals to 2
|-
|11||<code>0.1.4</code>||<code>beecon_ge2_ImgZoom</code>||<code>int32</code>||<code>0=1:1</code> <code>1=Fit to widget dimensions</code> <code>2=5%</code> <code>3=10%</code> <code>4=15%</code> <code>... till 200%</code>||This is the zoom/scale of the previous parameter's image (1:1, Fit, 5%-200%)
|-
|12||<code>0.1.9.1</code>||<code>beecon_ge2_ExtBgRGB</code>||<code>string</code>||<code>#<rrrr><gggg><bbbb></code>||Applies to Beecons; it's the Background color to be displayed if script/command returns and Exit Status equals to 2
|-
|13||<code>0.1.0</code>||<code>beecon_idxge2_ImgFilename</code>||<code>string</code>||-||Applies to Beecons; it's the basename of the image to be displayed if script/command returns an Exit Status greater than or equal to 3; Final image filename will be built as <code><basename>.png.<exit code></code> (Ex.dice.png.3, dice.png.4 ...)
|-
|14||<code>0.1.4</code>||<code>beecon_idxge2_ImgZoom</code>||<code>int32</code>||<code>0=1:1</code> <code>1=Fit to widget dimensions</code> <code>2=5%</code> <code>3=10%</code> <code>4=15%</code> <code>... till 200%</code>||This is the zoom/scale of the previous parameter's image (1:1, Fit, 5%-200%)
|-
|15||<code>0.1.9.1</code>||<code>beecon_idxge2_ExtBgRGB</code>||<code>string</code>||<code>#<rrrr><gggg><bbbb></code>||Applies to Beecons; it's the Background color to be displayed if script/command returns and Exit Status is greater than or equal to 3
|-
| ||<code>0.1.0</code>||<code>beecon_lt0_BgRGB</code>||<code>int32</code>||-||Obsoleted as of release >=0.1.9.1
|-
| ||<code>0.1.0</code>||<code>beecon_eq0_BgRGB</code>||<code>int32</code>||-||Obsoleted as of release >=0.1.9.1
|-
| ||<code>0.1.0</code>||<code>beecon_eq1_BgRGB</code>||<code>int32</code>||-||Obsoleted as of release >=0.1.9.1
|-
| ||<code>0.1.0</code>||<code>beecon_ge2_BgRGB</code>||<code>int32</code>||-||Obsoleted as of release >=0.1.9.1
|-
| ||<code>0.1.0</code>||<code>beecon_idxge2_BgRGB</code>||<code>int32</code>||-||Obsoleted as of release >=0.1.9.1
|}

=====Command Title Settings=====

[[Image:Snap203.jpg|350px]]

{|class="wikitable" border="2"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
|1||<code>0.1.0</code>||<code>cmdImgFilename</code>||<code>string</code>||-||Applies both to Beecons and to Snippets; it's the filename of the image to be displayed as complementary to the Command Title label. Can be used to provide a customized image-based background to the widget.
|-
|2||<code>1.0.3</code>||<code>cmdImgAngle</code>||<code>uint32</code>||<code>0=0 Degrees</code> <code>1=90 Degrees</code> <code>2=180 Degrees</code> <code>3=270 Degrees</code>||It's the rotation of the Image associated to the Command Title (0, 90, 180, 270 degrees)
|-
|3||<code>0.1.4</code>||<code>cmdImgZoom</code>||<code>int32</code>||<code>0=1:1</code> <code>1=Fit to widget dimensions</code> <code>2=5%</code> <code>3=10%</code> <code>4=15%</code> <code>... till 200%</code>||This is the zoom/scale of the previous parameter's image (1:1, Fit, 5%-200%)
|-
|4||<code>0.1.3</code>||<code>cmdImgVisibilityPosition</code>||<code>int32</code>||<code>0=Hidden 1=Top Left 2=Top Center 3=Top Right 4=Center Left 5=Center 6=Center Right 7=Bottom Left 8=Bottom Center 9=Bottom Right</code>||Sets the Visibility and Position of the image associated to Command Title (Both for Snippets and for Beecons)
|-
|5||<code>0.1.9</code>||<code>cmdExtFont</code>||<code>string</code>||<code>[<family>] [italic] [bold] [<size>]</code>||Font string specification for Command label (Ex. Nokia Sans Italic Bold 12)
|-
|6||<code>0.1.9.1</code>||<code>cmdExtFgRGB</code>||<code>string</code>||<code>#<rrrr><gggg><bbbb></code>||It's the Foreground color to be used with Command Title label
|-
|7||<code>0.1.3</code>||<code>cmdVisibilityPosition</code>||<code>int32</code>||<code>0=Hidden 1=Top Left 2=Top Center 3=Top Right 4=Center Left 5=Center 6=Center Right 7=Bottom Left 8=Bottom Center 9=Bottom Right</code>||Sets the Visibility and Position of the Command Title label
|-
|8||<code>0.1.9.1</code>||<code>cmdTextAngle</code>||<code>uint32</code>||<code>0=0 Degrees</code> <code>1=90 Degrees</code> <code>2=180 Degrees</code> <code>3=270 Degrees</code>||It's the rotation of the Command Title Label (0, 90, 180, 270 degrees)
|-
|9||<code>0.1.0</code>||<code>cmdJustify</code>||<code>int32</code>||<code>0=Left</code> <code>1=Right</code> <code>2=Center</code> <code>3=Fill</code>||It's the justification to be used with Command Title label
|-
| ||<code>0.1.0</code>||<code>cmdFgRGB</code>||<code>int32</code>||-||Obsoleted as of release >=0.1.9.1
|-
| ||<code>0.1.0</code>||<code>cmdFontName</code>||<code>int32</code>||-||Obsoleted as of release >=0.1.9
|-
| ||<code>0.1.0</code>||<code>cmdFontSize</code>||<code>double</code>||-||Obsoleted as of release >=0.1.9
|}

=====Command Results Settings=====

[[Image:Snap032.png|350px]]

{|class="wikitable" border="2"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
|1||<code>0.1.0</code>||<code>resImgFilename</code>||<code>string</code>||-||Applies both to Snippets; it's the filename of the image to be displayed as complementary to the Command Results label.
|-
|2||<code>1.0.3</code>||<code>resImgAngle</code>||<code>uint32</code>||<code>0=0 Degrees</code> <code>1=90 Degrees</code> <code>2=180 Degrees</code> <code>3=270 Degrees</code>||It's the rotation of the Image associated to the Command Results (0, 90, 180, 270 degrees)
|-
|3||<code>0.1.4</code>||<code>resImgZoom</code>||<code>int32</code>||<code>0=1:1</code> <code>1=Fit to widget dimensions</code> <code>2=5%</code> <code>3=10%</code> <code>4=15%</code> <code>... till 200%</code>||This is the zoom/scale of the previous parameter's image (1:1, Fit, 5%-200%)
|-
|4||<code>0.1.3</code>||<code>resImgVisibilityPosition</code>||<code>int32</code>||<code>0=Hidden 1=Top Left 2=Top Center 3=Top Right 4=Center Left 5=Center 6=Center Right 7=Bottom Left 8=Bottom Center 9=Bottom Right</code>||Sets the Visibility and Position of the image associated to Command Results (For Snippets)
|-
|5||<code>0.1.9</code>||<code>resExtFont</code>||<code>string</code>||<code>[<family>] [italic] [bold] [<size>]</code>||Font string specification for Results label (Ex. Nokia Sans Italic Bold 12)
|-
|6||<code>0.1.9.1</code>||<code>resExtFgRGB</code>||<code>string</code>||<code>#<rrrr><gggg><bbbb></code>||It's the Foreground color to be used with Command Results label
|-
|7||<code>0.1.3</code>||<code>resVisibilityPosition</code>||<code>int32</code>||<code>0=Hidden 1=Top Left 2=Top Center 3=Top Right 4=Center Left 5=Center 6=Center Right 7=Bottom Left 8=Bottom Center 9=Bottom Right</code>||Sets the Visibility and Position of the Command Results label
|-
|8||<code>0.1.9.1</code>||<code>resTextAngle</code>||<code>uint32</code>||<code>0=0 Degrees</code> <code>1=90 Degrees</code> <code>2=180 Degrees</code> <code>3=270 Degrees</code>||It's the rotation of the Command Results Label (0, 90, 180, 270 degrees)
|-
|9||<code>0.1.0</code>||<code>resJustify</code>||<code>int32</code>||<code>0=Left</code> <code>1=Right</code> <code>2=Center</code> <code>3=Fill</code>||It's the justification to be used with Command Results label
|-
|10||<code>1.3</code>||<code>resWrapLongLines</code>||<code>boolean</code>||<code>false=disabled</code> <code>true=enabled</code>||Enables the text wrapping on long lines with Command Results label
|-
| ||<code>0.1.0</code>||<code>resFgRGB</code>||<code>int32</code>||-||Obsoleted as of release >=0.1.9.1
|-
| ||<code>0.1.0</code>||<code>resFontName</code>||<code>int32</code>||-||Obsoleted as of release >=0.1.9.1
|-
| ||<code>0.1.0</code>||<code>resFontSize</code>||<code>double</code>||-||Obsoleted as of release >=0.1.9.1
|}

=====Progress Animation=====

[[Image:Snap033.png|350px]]

{|class="wikitable"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
|1||<code>0.1.9.8</code>||<code>progressAnimationFrames</code>||<code>uint32</code>||<code>[0-30]</code>||Holds the number of frames to display for the animation; 0 if animations should be hidden MAX 30
|-
|2||<code>0.1.9.8</code>||<code>progressAnimationTimer</code>||<code>uint32</code>||<code>[0-20]</code>||Holds the number of milliseconds/50 to wait before drawing next frame (<=4secs)
|-
|3||<code>0.1.9.8</code>||<code>progressAnimationPos</code>||<code>uint32</code>||<code>0=Top Left</code> <code>1=Top Center</code> <code>2=Top Right</code> <code>3=Center Left</code> <code>4=Center</code> <code>5=Center Right</code> <code>6=Bottom Left</code> <code>7=Bottom Center</code> <code>8=Bottom Right</code> <code>9=Top Left & Hide Widget</code> <code>10=Top Center & Hide Widget</code> <code>11=Top Right & Hide Widget</code> <code>12=Center Left & Hide Widget</code> <code>13=Center & Hide Widget</code> <code>14=Center Right & Hide Widget</code> <code>15=Bottom Left & Hide Widget</code> <code>16=Bottom Center & Hide Widget</code> <code>17=Bottom Right & Hide Widget</code>||Holds the default position index of the animation in the widget and/or hide the widget itself during progress animation
|-
|4||<code>1.0.4</code>||<code>progressAnimationAtClickXY</code>||<code>boolean</code>||<code>true<nowiki>|</nowiki>false</code>||If checked, progress animation is displayed at X,Y position where widget is clicked.
|-
|5||<code>0.1.9.8</code>||<code>progressAnimationBasename</code>||<code>string</code>||-||Holds the basename of the files to load as frames from the relevant directory. Final frame filename will be built as <code><basename><frame number>.png</code>
|}

=====Update Policy=====

[[Image:Snap034.png|350px]]

{|class="wikitable"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
|1||<code>0.1.0</code>||<code>updOnStartup</code>||<code>boolean</code>||<code>true<nowiki>|</nowiki>false</code>||Update policy which defines if widget must be updated on system Startup or on widget Wakeup
|-
|2||<code>0.0.1</code>||<code>updOnDesktop</code>||<code>boolean</code>||<code>true<nowiki>|</nowiki>false</code>||Update policy which defines if widget must be updated when desktop, on which the widget resides, gets displayed either by being dragged or after resume from standby.
|-
|3||<code>0.1.9.9</code>||<code>updOnSight</code>||<code>uint32</code>||<code>true<nowiki>|</nowiki>false</code>||If set to <code>true</code>, widget content is only updated if on current desktop and visible (if screen locked no update will take place)
|-
|4||<code>0.0.1</code>||<code>updOnClick</code>||<code>boolean</code>||<code>true<nowiki>|</nowiki>false</code>||Update policy which defines if widget must be updated when it is clicked
|-
|5||<code>1.2.10</code>||<code>multiClick</code>||<code>boolean</code>||<code>true<nowiki>|</nowiki>false</code>||Enable/Disable support for multi click on widget (quicker click response if disabled)
|-
|6||<code>1.3</code>||<code>updOnOrientation</code>||<code>boolean</code>||<code>true<nowiki>|</nowiki>false</code>||Enable/Disable support for Phone Orientation
|-
|7||<code>0.0.1</code>||<code>delayIndex</code>||<code>uint32</code>||<code>0=Timer Disabled</code> <code>1=30 Secs</code> <code>2=1 Min</code> <code>3=5 Mins</code> <code>4=30 Mins</code> <code>5=1 Hour</code> <code>6=6 Hours</code> <code>7=12 Hours</code> <code>8=1 Day</code> <code>9=Custom (")</code>||Sets and index of values to use as intervals/periods for command/scripts executions
|-
|8||<code>0.1.9.2</code>||<code>customIntervalSecs</code>||<code>uint32</code>||<code><seconds></code>||Sets the number of seconds to use for Custom Update Intervals
|-
|9||<code>0.0.1</code>||<code>updNeworkPolicy</code>||<code>uint32</code>||<code>0=Irrelevant</code> <code>1=When Connected</code> <code>2=When Disconnected</code> <code>3=PassThrough (>= v1.0.6)</code>||Update policy which defines if widget update must be Network dependent and what network condition must trigger the update
|-
|10||<code>1.3</code>||<code>GPSsettings</code>||<code>uint32</code>||<code>(GPSsettings >> 8) 0=GPS Disabled, 1=GPS Enabled</code> <code>(GPSsettings >> 4 & 0xF) 0=USER_SELECTED, 1=CWP, 2=ACWP, 3=GNSS, 4=AGNSS</code> <code>(GPSsettings & 0xF) 0=DEFAULT, 1=1sec, 2=2sec, 3=5sec, 4=10sec, 5=20sec, 6=30sec, 7=60sec, 8=120sec</code>||See [[Documentation/Maemo 5 Developer Guide/Using Connectivity Components/Using Location API#LocationGPSDevice and LocationGPSDeviceFix|the location API reference]]
|}

=====DBUS Event Monitoring=====

[[Image:Snap035.png|350px]]

{|class="wikitable"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
|1||<code>0.1.9.4</code>||<code>updOnDBUS</code>||<code>uint32</code>||<code>0=Disabled<nowiki>|</nowiki>1=Enabled</code>||Enables DBUS Event Monitor and Update policy which defines if widget must be updated by any DBUS Event
|-
|2||<code>0.1.9.4</code>||<code>updOnDBUSBus</code>||<code>uint32</code>||<code>0=SYSTEM<nowiki>|</nowiki>1=SESSION</code>||Sets which DBUS bus to monitor (System/Session)
|-
|3||<code>0.1.9.4</code>||<code>updOnDBUSMatchRule</code>||<code>string</code>||[http://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-routing See Specifications]||Specifies the rule to be matched in order for command/script to be executed (Ex.type='signal',path='/com/nokia/mce/signal',interface='com.nokia.mce.signal',member='tklock_mode_ind')
|}

=====Remember Me Value=====
[[Image:Snap094.jpg|350px]]

{|class="wikitable"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
|1||<code>0.1.9.6</code>||<code>rememberMe</code>||<code>string</code>||-||Holds status or persistency information across subsequent command executions. - Can be fetched/changed via DBUS method call <code>set/get_param_string string:"rememberMe" string:<remember_this_string></code> - Can be transferred to command/scrips execution via <code>$QBW_REMEMBER_ME</code> Parameter Substitution - As of release >=1.0.5 Can be also be affected by executed command output. Just echo the following string (which will not be displayed) as output of your command <code>QBW_REMEMBER_ME(<content to be remembered>)</code> no angle brackets; escape "close round bracket" like this "\)" to store it as ")" See examples [http://talk.maemo.org/showthread.php?p=823123#post823123 HERE]
|}

=====Not Present in Settings Dialog Box=====

{|class="wikitable"
!Ref #!!Release!!Parameter!!Type!!Possible Values!!Description
|-
| ||<code>0.0.1</code>||<code>instanceCmd</code>||<code>string</code>||-||Holds the command/script to be executed
|}

=== Advanced Settings and Tools ===

Dialog can be reached via QBW Settings:

[[image:169rlh2.png]]

[[image:29q0575.png]]

[[image:Snap037.png|350px]]

====Section A: (Command TestDrive)====

# This button opens up the About dialog box
# This selector allows to dynamically change the [[#Application Logging Subsystem|QBW Logging Subsystem Verbosity]]
# This is the list of Stored Commands that you can Test Drive; upon entering the dialog box, [3] & [8] are initialized with current Instance command.
# Use this button to Test Drive the command currently typed in [6]
# This button will update current instance command with the content of [8] (use it when command is working and thoroughly tested)
# Will copy to clipboard the command currently in [8]
# Will paste the clipboard into [8]
# Read-Write text field; this is the "command input buffer", it is used as extended Test Drive tool for troubleshooting commands with issues
# Read-Only text field; will display the '''Exit Status & Raw Output''' of the command in [8] executed by pressing button [4]

[[image:Snap038.png|350px]]

====Section B: (Commands/Beecons Import/Export processing)====

# Button will export the command currently in [A8]. Result of the export will be stored into [9] text buffer
# Button will import the command currently in [9].
# Will paste the clipboard into [9]
# Will copy to clipboard the [9] text buffer
# Will read from a file into [9]
# Will write to a file the [9] text buffer
# Button will import the Beecon/Snippet Instance Data currently in []; useful for restoring Beecons of for importing Beecons created by others.
# Button will export the Beecon/Snippet Instance Data for the current instance. Result of the export will be stored into [9] text buffer; useful for backup of Beecons of for exporting Beecons to others.
# Read-Write text field; used for temporarily processing export/import of commands and Beecon/Snippet Instance Data

==== Parameter Substitution at Command/Script Runtime ====

QBW can provide a set of specific parameters to the executing script/command. The script will have to identify the placeholders for this extra parameters as better specified in the following table:

{|class="wikitable"
!Release!!Placeholder!!Substituted!!Description
|-
|<code>0.1.9.1</code>||<code>$QBW_ID</code>||<code><QBW Instance ID></code>||Retreives the [[#QBW Instance ID|QBW Instance ID]] and substitutes it into the run script
|-
|<code>0.1.9.6</code>||<code>$QBW_HOTSPOT_PRESS</code>||<code><Hot Spot Press/Click Position Index></code>||[[Image:QBW Hot Spot Press.gif|right]]Retreives the <code>POSITION INDEX</code> where the widget was pressed/clicked and substitutes it into the run script <code>0 = Not Pressed (Other update policy) 1 = Top Left 2 = Top Center 3 = Top Right 4 = Center Left 5 = Center 6 = Center Right 7 = Bottom Left 8 = Bottom Center 9 = Bottom Right</code>
|-
|<code>1.0.3</code>||<code>$QBW_CLICKS_COUNT</code>||<code><Number></code>||Holds the number of times a QBW was pressed/clicked and substitutes it into the run script; useful for handling single/double/triple... clicks and behave accordingly (Tested up to 12 ... :) )
|-
|<s><code>1.0.4</code></s>||<s><code>$QBW_IS_FINGER_TAP</code></s>||<s><code>true<nowiki>|</nowiki>false</code></s>||<s>Holds the type of click issued on the Touch Screen <code>true</code>=Touch Screen was tapped with a finger <code>false</code>=Touch Screen was clicked with stylus</s>
|-
|<code>1.0.3</code>||<code>$QBW_CLICK_X</code> <code>$QBW_CLICK_Y</code>||<code><X Coordinate></code> <code><Y Coordinate></code>||Hold exact X and Y coordinates respectively where a QBW was pressed/clicked (Useful for handling different arbitrary/dynamic hotspots on widgets via launched shell scripts; virtually unlimited as handling is left to launched script/program) Ex. <code>x=$QBW_CLICK_X; y=$QBW_CLICK_Y; if [ $x -ge 100 -a $x -le 200 -a $y -ge 100 -a $y -le 200 ]; then echo "HOT SPOT HIT"; else echo "HOT SPOT NOT HIT"; fi;</code> will echo "HOT SPOT HIT" if widget is clicked in rectangle delimited by p1(x=100,y=100) and p2(x=200,y=200) or "HOT SPOT NOT HIT" otherwise
|-
|<code>1.0.53</code>||<code>$QBW_WIDTH</code>||<code><Number></code>||Holds the current Width of QBW widget; useful for dynamic recalculation of click hotspots
|-
|<code>1.0.53</code>||<code>$QBW_HEIGHT</code>||<code><Number></code>||Holds the current Height of QBW widget; useful for dynamic recalculation of click hotspots
|-
|<code>1.3</code>||<code>$QBW_POSITION_X</code> <code>$QBW_POSITION_Y</code>||<code><X Coordinate></code> <code><Y Coordinate></code>||Hold the current X,Y Position of QBW widget
|-
|<code>1.3</code>||<code>$QBW_ORIENTATION_MODE</code>||<code><mode></code>||Holds the current Orientation Mode of QBW widget = <code>landscape</code>, <code>portrait</code>, <code>unknown</code>, <code>landscape (inverted)</code>, <code>portrait (inverted)</code>
|-
|<code>1.3</code>||<code>$QBW_ORIENTATION_STAND</code>||<code><stand></code>||Holds the current Orientation Stand of QBW widget = <code>off_stand</code>, <code>on_stand</code>
|-
|<code>1.3</code>||<code>$QBW_ORIENTATION_FACE</code>||<code><face></code>||Holds the current Orientation Face of QBW widget = <code>face_up</code>, <code>face_down</code>
|-
|<code>1.3</code>||<code>$QBW_ORIENTATION_X</code>||<code><X axis value></code>||Holds the current Orientation X axis of QBW widget = <code>-1</code><-><code>+1</code>
|-
|<code>1.3</code>||<code>$QBW_ORIENTATION_Y</code>||<code><Y axis value></code>||Holds the current Orientation Y axis of QBW widget = <code>-1</code><-><code>+1</code>
|-
|<code>1.3</code>||<code>$QBW_ORIENTATION_Z</code>||<code><Z axis value></code>||Holds the current Orientation Z axis of QBW widget = <code>-1</code><-><code>+1</code>
|-
|<code>1.3</code>||<code>$QBW_LOCATION_FIX</code>||<code><string></code>||Holds the current GPS Position FIX in colon separated string form: <code>status : time : ept : latitude : longitude : eph : altitude : epv : track : epd : speed : eps : climb : epc : gsm_cell_info.mcc : wcdma_cell_info.mcc : satellites_in_view : satellites_in_use</code> If information is not available then <code>nan</code> is shown. See [[Documentation/Maemo_5_Developer_Guide/Using_Connectivity_Components/Using_Location_API#LocationGPSDevice_and_LocationGPSDeviceFix|HERE]] for reference. Ex. 1 : 1288031860 : 0 : 45,999999 : 9,999999 : 4026 : 157 : 20 : 210,490 : 359,990 : 0,11 : 4,43 : 0,00 : 0,03 : 0 : 0 : 10 : 5
|-
|<code>0.1.9.9</code>||<code>$QBW_ON_SIGHT</code>||<code>true<nowiki>|</nowiki>false</code>||<code>true</code>=QBW Instance is "ON SIGHT", that is widget is on current desktop and display is not locked or on stand by. <code>false</code>=QBW Instance is not on current desktop and visible or display is off or on stand by
|-
|<code>1.0.2</code>||<code>$QBW_IS_CONNECTED</code>||<code>true<nowiki>|</nowiki>false</code>||<code>true</code>=QBW Instance is connected to the network (either WLAN or GPRS) <code>false</code>=QBW Instance is not connected to the network (either WLAN or GPRS)
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_TIMER_UPDATE</code>||Script is run due to a Timer event
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_STARTUP_UPDATE</code>||QBW instance is starting up and script run
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_SETTINGS_SAVE_RUN</code>||Save and Run is pressed in Settings Dialog Box and script run
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_TEST_DRIVE</code>||Script is run via Test Drive advanced dialog box
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_WAKEUP_CLICK</code>||A disabled instance is waken up by a click on icon and script is run
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_CLICK</code>||An instance is clicked and script is run
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_DESKTOP_SWITCH</code>||The desktop, on which and instance is displayed, is switched/scrolled and script is run
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_CONNECTION_EVENT</code>||A connection event takes place and script is run
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_DBUS_SET_PARAM_UPDATE</code>||A set_param DBUS method is called and "update content" (script run) is explicitly required
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_DBUS_WAKEUP</code>||A wakeup DBUS method is called and script is run
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_DBUS_UPDATE_CONTENT</code>||"update content" DBUS method is called and script run is explicitly required
|-
|<code>0.1.9.1</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_DBUS_EXEC</code>||"exec" DBUS method is called and external script run is explicitly required
|-
|<code>0.1.9.4</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_DBUS_MONITOR</code>||Execution of script was triggered by DBUS Match Rules in DBUS Event Monitoring
|-
|<code>1.3</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_ORIENTATION_MONITOR</code>||Execution of script was triggered by phone Orientation Change if enabled in QBW instance configuration
|-
|<code>1.3</code>||<code>$QBW_EXEC_REASON</code>||<code>QBW_LOCATION_MONITOR_FIX</code>||Execution of script was triggered by FIX change in GPS Location subsystem if enabled in QBW instance configuration
|-
|<code>0.1.9.4</code>||<code>$QBW_DBUS_VERBOSE_OUTPUT</code>||<code>signal<nowiki>|</nowiki>method call<nowiki>|</nowiki>method return<nowiki>|</nowiki>error<nowiki>|</nowiki>unknown sender=<sender> -> dest=<destination> path=<path> interface=<interface> member=<member>\n</code> <code><type1> <param1>\n</code> <code><type2> <param2>\n</code> <code><typeX> <paramX></code>||Extended values returned by DBUS Monitor for Matched Rule. Example: <code>signal sender=:1.31 -> dest=(null destination) path=/com/example/app/Signal; interface=com.example.app.Signal; member=Test string "192.168.47.100" boolean true</code>
|-
|<code>1.0.6</code>||<code>$QBW_PREVIOUS_EXIT_STATUS</code>||<code><last executed command's Exit Code></code>||Exit status of the last previous executed command
|-
|<code>0.1.9.5</code>||<code>$QBW_CURRENT_RESULTS_TEXT</code>||<code><current content of results text></code>||Current content of results text even if label is hidden. Useful for holding and processing previous state conditions across command executions
|-
|<code>0.1.9.6</code>||<code>$QBW_HTTP_PROXY</code>||<code><host>:<port></code>||Returns the current HTTP Proxy as entered into parameters for current active Internet Connection
|-
|<code>0.1.9.6</code>||<code>$QBW_HTTPS_PROXY</code>||<code><host>:<port></code>||Returns the current HTTPS Proxy as set into parameters for current active Internet Connection
|-
|<code>0.1.9.6</code>||<code>$QBW_FTP_PROXY</code>||<code><host>:<port></code>||Returns the current FTP Proxy as set into parameters for current active Internet Connection
|-
|<code>0.1.9.6</code>||<code>$QBW_SOCKS_PROXY</code>||<code><host>:<port></code>||Returns the current SOCKS Proxy as entered into parameters for current active Internet Connection
|-
|<code>0.1.9.6</code>||<code>$QBW_RTSP_PROXY</code>||<code><host>:<port></code>||Returns the current RTSP Proxy as set into parameters for current active Internet Connection
|-
|<code>0.1.9.6</code>||<code>$QBW_IGNORE_HOSTS_PROXY</code>||<code><host1>;<host2>;<host...></code>||Returns the current list of host which do not require a proxy as set into parameters for current active Internet Connection
|-
|<code>0.1.9.6</code>||<code>$QBW_AUTO_CONFIG_PROXY_URL</code>||<code><URL></code>||Returns the current Proxy configuration URL as set into parameters for current active Internet Connection
|-
|<code>0.1.9.6</code>||<code>$QBW_REMEMBER_ME</code>||<code><string></code>||Holds status or persistency information stored in configuration via Settings Dialog, DBUS method call or Command Output - Can be fetched/changed via DBUS method call <code>set/get_param_string string:"rememberMe" string:<remember_this_string></code> - Can be transferred to command/scrips execution via <code>$QBW_REMEMBER_ME</code> Parameter Substitution - As of release >=1.0.5 Can be also affected by executed command output. Just echo the following string (which will not be displayed) as output of your command <code>QBW_REMEMBER_ME(<content to be remembered>)</code> no angle brackets; escape "close round bracket" like this "\)" to store it as ")" See examples [http://talk.maemo.org/showthread.php?p=823123#post823123 HERE]
|}

=== QBW Instance Timer Logic ===

The Timer logic for each instance for actions to be run periodically is programmed as follows:

* The timer of each instance is reset and re-armed every time the widget is Startup (System Boot or QBW release upgrade)
* The timer of each instance is reset and re-armed every time it is changed in the Settings dialog box and it is different from its previous value
* If a widget is disabled, either by changing is "Status" in the Settings dialog box or via DBUS method <code>sleep</code>, its timer is disabled
* If a widget is re-enabled, either by changing is "Status" in the Settings dialog box or via DBUS method <code>wakeup</code>, its timer is reset and re-armed
* If Settings Parameter <code>delayIndex</code> has been changed via DBUS set_param_uint32 method, the relevant timer must be explicitly reset and rearmed via DBUS methos <code>reset_rearm_timer</code>
* The timer is reset and re-armed every time a new QBW instance is imported via Advanced dialog box and relevant parameter is set

=== System Backup/Restore Integration ===

As of release >=0.1.8 QBW is integrated into the N900 system backup/restore features according to standard specifications as better described in the SDK [[Documentation/Maemo 5 Developer Guide/Generic Platform Components/Using Backup Application#Custom back-up locations|Using Backup Application]]

<code>/etc/osso-backup/applications/queen-beecon.conf</code> file is:
<source lang="xml">
<backup-configuration>
 <locations>
 <location type="file"
 category="settings">$HOME/.queen-beecon</location>
 <location type="dir"
 category="documents">$HOME/MyDocs/.images/queen_beecon_dir</location>
 <location type="dir"
 category="documents">$HOME/.queen_beecon_dir</location>
 </locations>
</backup-configuration>
</source>

=== Application Logging Subsystem ===

As of release >=1.0.2, QBW employs a powerful Application Logging subsystem.

Log file is:
 ~/.queen_beecon_dir/queen_beecon.log

Time in logfile is ISO 8601 encoded string, relative to the Coordinated Universal Time (UTC)

Logging is disabled by default.

==== Enabling Logging ====

Logging can be enabled in different ways:

* Dynamically via QBW DBUS method call
 <code>run-standalone.sh dbus-send --session --print-reply --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbw<idX> oh.no.more.qbw.logger_action string:<vX></code>
: <code><idX></code> is the [[#QBW Instance ID|QBW Instance ID]] of and existing QBW instance (no matter which one as logging is global)
: <code><vX></code> is the required verbosity (Allowed values are: <code>v0 v1 v2 v3 v4</code> from minimum verbosity to maximum)
: Example:
 run-standalone.sh dbus-send --session --print-reply --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbwid0 oh.no.more.qbw.logger_action string:v4
: '''WARNING!''' Due to performance reasons, v0 v1 v2 v3 logging verbosity is asynchronous, meaning that the log file will not be instantly updated as soon as a new information is logged.
:If you specifically need an up to date log file condition, you need to specifically issue a:
 <code>run-standalone.sh dbus-send --session --print-reply --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbw<idX> oh.no.more.qbw.logger_action string:flush</code>
:<code>v4</code> logging verbosity is synchronous by design and logs a lot of information thus causing system slow down side effects at time and <code>~/.queen_beecon_dir/</code> directory/file system filling quite quickly. Keep file system space monitored if you need this level of verbosity!

* Statically via condition file presence
: If you need to setup permanent verbosity to a specified level, also to monitor QBW startup, just go to directory:
 ~/.queen_beecon_dir/
: and issue command:
 touch queen_beecon.log.<vX>
: where <code><vX></code> is the required verbosity (Allowed values are: <code>v0 v1 v2 v3 v4</code> from minimum verbosity to maximum)
: Example:
 touch queen_beecon.log.v4
: Static Logging is activated every time the Phone/Widget is restarted

==== Changing Logging Verbosity ====

Logging verbosity can be dynamically changed by calling the following DBUS method call:
 run-standalone.sh dbus-send --session --print-reply --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbw<idX> oh.no.more.qbw.logger_action string:<vX>
: <code><idX></code> is the [[#QBW Instance ID|QBW Instance ID]] of an existing QBW instance (no matter which one as logging is global)
: <code><vX></code> is the required verbosity (Allowed values are: <code>v0 v1 v2 v3 v4</code> from minimum verbosity to maximum)

==== Disabling Logging ====

Logging can be dynamically disabled by calling the following DBUS method call
 run-standalone.sh dbus-send --session --print-reply --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbw<idX> oh.no.more.qbw.logger_action string:disable
: <code><idX></code> is the [[#QBW Instance ID|QBW Instance ID]] of an existing QBW instance (no matter which one as logging is global)

==== Resetting Log File ====

Log file can be dynamically reset to empty status by calling the following DBUS method call
 run-standalone.sh dbus-send --session --print-reply --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbw<idX> oh.no.more.qbw.logger_action string:reset
: <code><idX></code> is the [[#QBW Instance ID|QBW Instance ID]] of an existing QBW instance (no matter which one as logging is global)

== Interaction with QBW over DBUS ==

===Overview===

As of releases newer than 0.1.7, a new Inter Process Communication mechanism among QBW instances and with other Applications has been implemented.

Through the standard DBUS interface, both at the OS-shell and at different programming environments level, QBW instances can be controlled and accessed and mutual interaction can be guaranteed, thus allowing a set of extended functionalities like:

* Give impulse to other Beecons for content update
* Give impulse to other Beecons for layout update
* Give other Beecons one-shot alternative scripts to execute
* Remotely change QBW settings
* Retrieve other beecon's last executed commands exit status
* Provide to non graphical programs and daemons a suitable interface for displaying information on precustomized beecons on screen (for example Dbus Scripts for displaying events on the system/session DBUS like cell IDs changes, available WLANs and the like)

I encourage you to suggest possible enhancements or wishlists in this area and [http://talk.maemo.org/showthread.php?t=45388 report them in the main TALK thread]

===QBW Instance ID===

Queen Beecon Widget's Instance Id, needed for every reference in DBUS method calls, can be found at the very top of the Settings dialog box:

[[Image:Snap017.png|300px]]

===DBUS Specifications===

QBW_DBUS_SERVICE ="oh.no.more.qbw" [Name of D-Bus service]
 QBW_DBUS_PATH ="/oh/no/more/qbw<idX>" [Name of Object Path]
 QBW_DBUS_IFACE ="oh.no.more.qbw" [Name of D-Bus interface]

* <idX> is the [[#QBW_Instance_ID|QBW Instance ID]]

===DBUS Methods & Parameters===
QBW implements the following list of methods to trigger specific actions:

WARNING!!! Methods' Parameters are case-sensitive
{|class="wikitable"
!Method!!Input Params!!Returns!!Description
|-
|<code>logger_action</code>||<code>string:'disable<nowiki> | </nowiki>v0<nowiki> | </nowiki>v1<nowiki> | </nowiki>v2<nowiki> | </nowiki>v3<nowiki> | </nowiki>v4<nowiki> | </nowiki>reset<nowiki> | </nowiki>flush'</code>||||Performs the following actions on the qbw logger subsystem: <code>disable</code> Disables logging <code>v0-4</code> Sets Logger Verbosity to specified depth level <code>reset</code> Resets the logfile <code>queen_beecon.log</code> in directory <code>/home/user/.queen_beecon_dir</code> to empty <code>flush</code> Flushes content of logfile <code>queen_beecon.log</code>
|-
|<code>dbus_method_monitor</code>||<code>string:'on<nowiki> | </nowiki>off'</code>||||Toggle on-screen yellow notification message of incoming DBUS method requests for destination Instance (for debug purposes). Default=OFF
|-
|<code>reset_rearm_timer</code>||||||Reset and rearm timer for periodically auto-updating QBW, needed to be explicitly called if parameter <code>delayIndex</code> has been changed via DBUS <code>set_param_uint32</code> method
|-
|<code>reset_rearm_connection</code>||||||Reset and rearm the network connection subsystem, needed to be explicitly called if parameter <code>updNeworkPolicy</code> has been changed via DBUS method
|-
|<code>reset_rearm_location</code>||||||Reset and rearm the GPS location subsystem, needed to be explicitly called if parameter <code>GPSsettings</code> has been changed via DBUS method
|-
|<code>reset_rearm_orientation</code>||||||Reset and rearm the Phone Orientation subsystem, needed to be explicitly called if parameter <code>updOnOrientation</code> has been changed via DBUS method
|-
|<code>reset_rearm_dbus_monitor</code>||||||Reset and rearm the DBUS Monitor subsystem, needed to be explicitly called if parameters <code>updOnDBUS</code>, <code>updOnDBUSBus</code> and <code>updOnDBUSMatchRule</code> have been changed via DBUS method
|-
|<code>show</code>||||||Give show impulse to a QBW
|-
|<code>hide</code>||||||Give hide impulse to a QBW
|-
|<code>wakeup</code>||||||Give wake up impulse to a QBW and update content and layout
|-
|<code>sleep</code>||||||Give sleep/disable/minimize impulse to a QBW
|-
|<code>update_content</code>||||||Give impulse to a QBW for content update
|-
|<code>update_layout</code>||||||Give impulse to a QBW for layout update
|-
|<code>exec</code>||<code>string:'<command<nowiki>|</nowiki>script>'</code>||||Give other QBWs one-shot alternative scripts/commands to execute and update content accordingly
|-
|<code>set_param_string</code>||<code>string:'<param name>'</code> <code>string:'<new value>'</code> <code>string:<nowiki>'' | </nowiki>'update_content'<nowiki> | </nowiki>'update_layout'</code>|||||Change and store QBW settings [[#Configuration_Parameters.2C_Types_.26_Reference|parameter]] of type string
|-
|<code>set_param_int32</code>||<code>string:'<param name>'</code> <code>int32:'<new value>'</code> <code>string:<nowiki>'' | </nowiki>'update_content'<nowiki> | </nowiki>'update_layout'</code>||||Change and store QBW settings [[#Configuration_Parameters.2C_Types_.26_Reference|parameter]] of type int
|-
|<code>set_param_uint32</code>||<code>string:'<param name>'</code> <code>uint32:'<new value>'</code> <code>string:<nowiki>'' | </nowiki>'update_content'<nowiki> | </nowiki>'update_layout'</code>||||Change and store QBW settings [[#Configuration_Parameters.2C_Types_.26_Reference|parameter]] of type uint
|-
|<code>set_param_double</code>||<code>string:'<param name>'</code> <code>double:'<new value>'</code> <code>string:<nowiki>'' | </nowiki>'update_content'<nowiki> | </nowiki>'update_layout'</code>||||Change and store QBW settings [[#Configuration_Parameters.2C_Types_.26_Reference|parameter]] of type double
|-
|<code>set_param_boolean</code>||<code>string:'<param name>'</code> <code>boolean:'<new value>'</code> <code>string:<nowiki>'' | </nowiki>'update_content'<nowiki> | </nowiki>'update_layout'</code>||||Change and store QBW settings [[#Configuration_Parameters.2C_Types_.26_Reference|parameter]] of type boolean
|-
|<code>get_param</code>||<code>string:'<param name>'</code>||<code>string:'value'</code>||Get QBW settings [[#Configuration_Parameters.2C_Types_.26_Reference|parameter]]
|-
|<code>is_on_sight</code>||||<code>string:'value'</code>||Get current widget On Sight status '''<code>true</code>'''=QBW Instance is "ON SIGHT", that is widget is on current desktop and display is not locked or on stand by. <code>false</code>=QBW Instance is not on current desktop and visible or display is off or on stand by
|-
|<code>get_current_results_text</code>||||<code>string:'value'</code>||Get current content of results text
|-
|<code>set_position</code>||<code>int32:'<X-coord>'</code> <code>int32:'<Y-coord>'</code>||||Set QBW position on desktop
|-
|<code>get_position</code>||||<code>int32:'<X-coord>'</code> <code>int32:'<Y-coord>'</code>||Get QBW position on desktop
|-
|<code>get_exit_status</code>||||<code>int32:'<ExitStatus>'</code>||Retrieve other QBW's last executed commands exit status
|}

===DBUS Signals & Parameters===

QBW issues the following list of signals to notify the "world" about predefined conditions and events. They will be emitted on the bus according to the following specifications:

PATH ="/oh/no/more/qbw<idX>"
 INTERFACE ="oh.no.more.qbw"
 MEMBER ="<signal name>" [Signal column in below list]
 PARAMETERS ="<parameter>" [Broadcast column in below list]

* <idX> is the [[#QBW_Instance_ID|QBW Instance ID]]

{|class="wikitable"
!Signal!!Broadcasts!!Description
|-
|<code>signal_content_update</code>||<code>int32:'<ExitStatus>'</code>||Issued when [[#QBW_Instance_ID|QBW Instance <idX>]] executes and returns an exit status
|}

===Interacting with QBW from the Shell===

This is the template to use for calling the QBW instance methods:

* For methods which DO return values:
 run-standalone.sh dbus-send --session --print-reply --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbw<idX> oh.no.more.qbw.<method> <type1>:"<param1>" <type2>:"<param2>" ... <typeN>:"<paramN>"
<s>'''WARNING!!!''' Hildon-home is quite sensitive to long running commands inside Queen Beecon Widget. If you believe that the dbus-send command is going to take much time (say >2/3 secs) it is better if you add the <code>--reply-timeout=<milliseconds></code> to the dbus-send list of parameters.</s> As of >=0.1.9.3 release, asynchronous execution of commands/scripts obsoletes previous statement.

* For methods which DO NOT return values:
 run-standalone.sh dbus-send --session --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbw<idX> oh.no.more.qbw.<method> <type1>:"<param1>" <type2>:"<param2>" ... <typeN>:"<paramN>"

Where:

* <code><idX></code> is the [[#QBW Instance ID|QBW Instance ID]]
* <code><method></code> is the [[#DBUS Methods|Method]] to be called for the specific QBW Instance
* <code><typeX></code> and <code><paramX></code> are the parameter type and value as per the specific [[#DBUS Methods|Method Synopsis]]

For example:
 run-standalone.sh dbus-send --session --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbwid0 oh.no.more.qbw.set_param_string string:"cmdImgFilename" string:"new_image_filename.png" string:"update_layout"

or
 run-standalone.sh dbus-send --session --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbwid0 oh.no.more.qbw.dbus_method_monitor string:'on'

or
 run-standalone.sh dbus-send --session --print-reply --type=method_call --dest=oh.no.more.qbw /oh/no/more/qbwid0 oh.no.more.qbw.get_position

== QBW DBUS Events Monitor and Interceptor ==

===Overview===

As of releases newer than 0.1.9.3 QBW is now able to monitor and intercept DBUS events (like signals, methods, errors) issued by the system or other applications. For example:
* Keyboard lock/unlock
* Slide open/close
* Bluetooth connections
* GSM cells change
* WIFI networks
* Battery & Charging status
* Changes in device orientation
* Incoming Calls
* Incoming SMS/IM

These events will then trigger the execution of a script which can be programmed to analyze and parse the intercepted event and perform actions accordingly.

The configuration is performed via the DBUS Event Monitoring section in Settings Dialog Box:

[[Image:Qbwdbusm.jpg||400px]]

# States if DBUS Monitoring is enabled or disabled for this QBW
# Specify whether to monitor SYSTEM or SESSION BUS
# Is the Match Rule as per [http://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-routing this DBUS specifications]

I encourage you to suggest possible enhancements or wishlists in this area and report them in the main [http://talk.maemo.org/showthread.php?t=45388 TALK thread]

==== Example ====

We will monitor the SYSTEM BUS with the following Match Rule:
 type='signal',interface='com.example.app.Signal'

The cmd/script which will be executed when the event is intercepted is the following:
 echo "$QBW_ID $QBW_EXEC_REASON"; echo '$QBW_DBUS_VERBOSE_OUTPUT'; exit 2

This is a simulation of the following sample DBUS command:
 run-standalone.sh dbus-send --system --type=signal /com/example/app/Signal com.example.app.Signal.Test string:'Oh' string:'No!!!' string:'More QBWs!!!' boolean:true uint32:10000

And here's the output:

[[Image:qbwmonw.jpg||400px]]

== Known Issues ==

TBD

== Bug Tracker/Reports ==

[https://garage.maemo.org/tracker/?atid=4848&group_id=1295&func=browse Tracker/Report See HERE]

== Feature Requests ==

[https://garage.maemo.org/tracker/?atid=4851&group_id=1295&func=browse Apply HERE]

== Now-Brewing ==

Nothing

== Change Log ==

== TODO list ==

*Bugfixing and Improving Stability
*Instance Import/Export optimization and simplification

== HOW-TOs & FAQs ==

=== Create a new Basic Instance of QBW ===

After you have installed QBW package, these are the steps to create and start customizing a new Instance of the widget.

* Tap on an empty area of the Desktop and gear icon for configuration will pop up in the upper right area of the screen
:[[Image:Qbwinst1.png]]
* Click on the "Add widget" button
:[[Image:Qbwinst2.png]]
* Scroll selector till you find "Queen Beecon Widget" and click on it
:[[Image:Qbwinst3.png]]
* A new instance of the widget will be created with very basic default configuration
:[[Image:Qbwinst4.png]]
* Now if you click on the Settings Wrench Icon you'll reach the Settings Dialog for customization

=== How and Where to store Icons and Images for your Beecons ===

If no PATH is specified in the Settings for Icons and Images, QBW will look in directories on the phone's internal memories in the following order:

* First, the directory accessible via Bluetooth/PC Suite/OVI Suite or USB (Storage Mode).

/home/user/MyDocs/.images/queen_beecon_dir/

:[[Image:Qbwwtsi.png]]

:'''WARNING!!! When phone is connected via USB in Storage Mode this directory is not available to the Widget'''; so if you plan to use QBW when in Storage Mode use directory in '''"Second"''' point.

* '''Second''', the directory:
 /home/user/.queen_beecon_dir

* '''Third''', the directory where QBW's '''[[#Icons_in_Package|Package Icons]]''' are stored:
 /usr/share/icons/hicolor/48x48/hildon/

If you want to replace a partial/complete set of QBW's [[#Icons in Package|Package Icons]] just create Icons/Images with same name in directories "First" or "Second"

If the specified image is not found, the following icon will appear:

[[Image:Queen-beecon-noimg.png]]

=== Create an Exit Status driven Multi Images Beecon ===

[http://talk.maemo.org/showthread.php?p=576408#post576408 Naive Dice Roller] is a good place to start looking for such implementation.

=== Scripts/Commands with long output ===

Some scripts/commands may create multiple lines which are too long to be displayed on a single line. The widget will not wrap these. In order to wrap them you can use the fold command:
 
 command-that-produces-long-lines | fold -s -w 80

The 80 in that instance is the maximum length of the line, which you can change. The -s option makes fold word wrap with spaces. More information is available from the [http://unixhelp.ed.ac.uk/CGI/man-cgi?fold fold man page].

=== Backup all Widget Instances ===
Apply [[#Export.2FSave.2FBackup Procedure for Beecon Instance Data|Export/Save/Backup Procedure for Beecon Instance Data]] for every Widget Instance you want to Backup

Save content (Beecons' Images) of directories:
 /home/user/.queen_beecon_dir
 /home/user/MyDocs/.images/queen_beecon_dir/

=== Restore all Widget Instances ===
Apply [[#Import.2FLoad.2FRestore Procedure for Beecon Exported Instance Data|Import/Load/Restore Procedure for Beecon Exported Instance Data]] for every Widget Instance you want to Restore

Restore content (Beecons' Images) of directories:
 /home/user/.queen_beecon_dir
 /home/user/MyDocs/.images/queen_beecon_dir/

=== Import/Load/Restore Procedure for Beecon Exported Instance Data ===

[http://talk.maemo.org/showthread.php?p=572028#post572028 See HERE]

=== Export/Save/Backup Procedure for Beecon Instance Data ===

[http://talk.maemo.org/showthread.php?p=613152#post613152 See HERE]

=== Copy Exported Instance Data from Browser to Phone's Clipboard ===

[http://talk.maemo.org/showthread.php?p=575685&post575685 See HERE]

=== Reset QBW to Default Configuration/Commands ===

Open up [[terminal|X Terminal]] (or SSH/Putty into N900) and issue the following command:
 sudo gainroot (only if you are not already root)
 rm /home/user/.queen_beecon
 killall hildon-home

=== Completely remove QBW from your N900 ===

Open up [[terminal|X-Terminal]] (or SSH/Putty into N900) and issue the following command
 sudo gainroot
(only if you are not already root)
 dpkg -P queen-beecon
 rm /home/user/.queen_beecon
 rm -r /home/user/.queen_beecon_dir
 rm -r /home/user/MyDocs/.images/queen_beecon_dir/

=== Run every Desktop Application with different Icons/Sizes buttons ===

You can run every desktop application with a script like this and just change the image and size of the Beecon to one of your choice:

dbus-send --type=method_call --dest=com.nokia.HildonDesktop.AppMgr /com/nokia/HildonDesktop/AppMgr com.nokia.HildonDesktop.AppMgr.LaunchApplication string:"<application name here>"

where <code><application name here></code> is application name that you can find in <code>/usr/share/applications/hildon</code> directory without the trailing <code>.desktop</code>

Example for launching the image viewer:

/usr/bin/dbus-send --dest=com.nokia.HildonDesktop.AppMgr /com/nokia/HildonDesktop/AppMgr com.nokia.HildonDesktop.AppMgr.LaunchApplication string:image-viewer

[http://talk.maemo.org/showthread.php?p=741381#post741381 See EXAMPLE Here]

=== Run Application in xterm with different Icons/Sizes buttons ===

You can run every application in xterm and customize a button on Desktop to launch it.

[http://talk.maemo.org/showthread.php?p=741436&post=741436 See THIS post for a Tutorial]

=== Create invisible clickable Hot Spots on your Desktop Background Image to launch Applications or perform Actions ===

[http://talk.maemo.org/showthread.php?p=786923#post786923 See Here] and follow-up posts.

=== Relocate/Rotate a QBW widget on a Keyboard slide event ===

[http://talk.maemo.org/showthread.php?p=823118#post823118 See Here] and follow-up posts.

=== FAQs ===

====Could you make an easy way to install new beecons/scripts please?====

... perhaps define a standard folder structure inside a compressed file, perhaps some install directions file inside to guide installation, and use a custom extension; kinda like how Firefox does with XPIs, and add some GUI to install/uninstall them

This is a good question and I still haven't figured out a good answer.

Here are a few issues I mused about.

# QBW is not a standalone application; it is a Hildon-Desktop/Home plugin (a library) with plenty of constraints and with a certain fixed integration with the whole system. Messing with it it's a pain in the a**
# I tried to find a simple operational way to achieve what you are asking for, here, but to my knowledge and due to the nature of HD-HH I couldn't find any better, faster, simpler, cuter or leanier way.
# QBWs, which get shared by the community or myself, are just mockups or proof of concepts which are meant to be "abused", "mishandled" and further customized to match each one's expectations and visual/functional taste
# The complexity of some QBWs requires manual intervention to adapt to each and everyone's environment (Ex. the QBW Instance ID used for inter-widget communication varies on each machine). To my knowledge, the automation of this adaptation process is very time consuming and far from being error-proof. I preferred to focus my effort in the most interesting area of functionalities
# QBW is a very powerful tool and can do a lot of good and nasty things... so: the more you expose its behaviour and the more "open" the code and effects will be
# Maemo ain't for doubleclickers

I know there is no proper answer here...

== Easter Eggs ==

=== Magic Word for bypassing Export/Import Instance Data CheckSum protection ===

[[Image:Qbwlsowk.jpg]]

Use the Source ... Luke! ;) or ask politely!

== Troubleshooting ==

=== Startup ===

If you are having issues at widget startup because of improper "Update on Widget/System Startup" settings:

* Open up [[terminal|X Terminal]] (or SSH/Putty into N900) and issue the following commands:
 sudo gainroot
(only if you are not already root)
 vi /home/user/.queen_beecon
* find <code>updOnStartup=true</code> (all instances supposed to be culprits)
* Set it to false:
 updOnStartup=false
* Save file
* Immediately issue:
 killall hildon-home
* hildon-home will automatically restart and widgets won't run any more at startup

More generally just open <code>/home/user/.queen_beecon</code> and change the Update Policies of your offending instance as per [[#Update Policy|THIS section's specifications]]

=== Running ===

==== QBW Warning! Possible Pango Markup Language inconsistent/unterminated Tag! ====

If you are using [http://maemo.org/api_refs/5.0/5.0-final/pango/PangoMarkupFormat.html Pango Markup Language] tags as output from your scripts, make sure all Tags are correctly written/spelled and terminated. Make also sure that there is an explicit newline at the very end of your output.

If you need to display the following special characters:

These NEED to be escaped:

*The less-than character (<) starts element markup (the first character of a start-tag or an end-tag). Escape: <code>&amp;lt;</code>
*The greater-than character (>) ends a start-tag or an end-tag. Escape: <code>&amp;gt;</code>

These MIGHT NEED to be escaped:

*The ampersand character (&) starts entity markup (the first character of a character entity reference). Escape: <code>&amp;amp;</code>
*The double-quote character (") can be symbolised with this character entity reference when you need to embed a double-quote inside a string which is already double-quoted. Escape: <code>&amp;quot;</code>
*The apostrophe or single-quote character (') can be symbolised with this character entity reference when you need to embed a single-quote or apostrophe inside a string which is already single-quoted. Escape: <code>&amp;apos;</code>

==== Beecon seems to hang when fetching data or accessing the Internet/Network ====

Please have a look at the thread of [http://talk.maemo.org/showthread.php?p=544591#post544591 Timeout and Proxy related issues].

You can also have a look at [[#Parameter Substitution at Command.2FScript Runtime|THIS section]] of the WIKI for proxy related information

=== Advanced Settings and Tools Dialog Box ===

==== QBW Warning! Expected/Shown Command Output mismatch. Possible charset different from UTF-8! ====

If you press '''TestDrive''' for a command and the '''Exit Status and Command RAW Output Buffer''' still displays '''''"Exit Status & Command RAW Output will be displayed HERE"''''' then maybe your output contains a charset different from UTF-8.

[[image:Snap091.jpg|250px]]

To have the Command Output properly displayed, try to append "<code.| iconv --from-code=ISO-8859-1 --to-code=UTF-8</code>". For example:

... command1 | iconv --from-code=ISO-8859-1 --to-code=UTF-8

[[image:Snap090.jpg|250px]]

==== WARNING! Bad Checksum! Possibly corrupt Import Instance/Command Data! ====

Every exported QBW Instance/Command Data is protected by a checksum value which is stored in the header part of the export.

There are a few reason why I chose to do that:

* To preserve integrity of what the author of the QBW created (and supposedly assumed "working")
* To prevent unwanted changes to the data due to clipboard copy/paste operations
* To ease the QBW exported data import process, and avoid some extra effort in coding import/export routines, by using the <code>g_key_file_*</code> APIs

Exported data is not "pure" configuration text; it is "meta-text" with some extra '''escape characters''' (Newline, tab, carriage return, backslash, blank which are escaped as \n, \t, \r, \\, \s respectively)

This is why directly changing the data inside the import/export buffer or in a text editor before importing is strictly discouraged (unless, of course, you know what you are doing and side effects)

== Published Beecons, Scripts & Commands ==

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Templates used on this page:

Template:Main (view source) (protected)

Retrieved from "https://wiki.maemo.org/Queen_BeeCon_Widget"

Personal tools

Navigation

Views

Editing Queen BeeCon Widget

@@ Line 550: / Line 550: @@
 As of releases newer than 0.1.7, a new Inter Process Communication mechanism among QBW instances and with other Applications has been implemented.
-Through the standard DBUS interface, both at the OS-shell and at different programming environments level, QBW instances can be controlled/accessed and mutual interaction can be guaranteed, thus allowing a set of extended functionalities like:
+Through the standard DBUS interface, both at the OS-shell and at different programming environments level, QBW instances can be controlled and accessed and mutual interaction can be guaranteed, thus allowing a set of extended functionalities like:
 * Give impulse to other Beecons for content update