Awesome Widgets

A collection of minimalistic easily configurable Plasmoids written on C++/Qt, which look like widgets in Awesome WM. Also it provides additional system [DataEngine] (//techbase.kde.org/Development/Tutorials/Plasma/DataEngines “Developers tutorial”).

NOTE: LOOKING FOR TRANSLATORS!

PLASMA 5 COMPATIBLE!

Developers and contributors

• Evgeniy Alekseev
• Ernesto Avilés Vzqz (Spanish translation)
• Mermouy (French translation)
• underr (Brazillian Portuguese translation)
• Виктор Слободян (Ukrainian translation)
• Lemueler (Chinese translation)
• Heimen Stoffels (Dutch translation)
• Mariusz Kocoń (Polish translation)

Special thanks:

• 
• Yahoo! Finance
• Yahoo! Weather
• OpenWeatherMap

License

• GPLv3

Changelog

CHANGELOG

Installation

Instruction

• Download an archive with latest version of source files.

• Extract it and install:

    cd /where/is/applet/
    mkdir build && cd build
    cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr ../
    make
    sudo make install
  

  NOTE: on Plasma 5 it very likely requires -DKDE_INSTALL_USE_QT_SYS_PATHS=ON flag.

Dependencies

I want note that all were tested on latest version of dependencies.

• plasma-framework
• cmake (make)
• extra-cmake-modules (make)
• hddtemp or smartmontools (optional, for HDD temperature monitor)
• one of supported music player (optional, for music player monitor)
• proprietary video driver (optional, for GPU monitor)

How to use

Open your Plasma widgets and select Awesome Widget.

Tips & tricks

You may use different colours inside. Just put label text into html code. See issue for more details.

Configuration

DataEngine configuration

You may edit DataEngine configuration. It is /etc/xdg/plasma-dataengine-extsysmon.conf and $HOME/.config/plasma-dataengine-extsysmon.conf. Uncomment required line and edit it.

DataEngine options

Widget configuration

To edit output you need open Settings window and specify output format. HTML tags work normally.

Available flags are in the table below.

NOTE The numbering of all arrays in variables starts at 0.

Lambda and template functions

Since version 3.0.0 the main widget supports lambda functions, which are calculated at runtime. It may be declared by using ${{ }} construction:

${{
function three()
{
    return 1+2;
}
three()
}}

A functions inside will be interpreted as JavaScript ones, any variables from main body is supported, thus the following function:

${{
function colorCpu()
{
    if ($cpu > 90.0)
        return "<span style=\"color:#ff0000;\">$cpu</span>"
    else
        return "$cpu"
}
colorCpu()
}}

will show $cpu value in red if it is more than 90.0, otherwise it will be shown in default colour. Any calculations are also supported:

${{
$down - $up
}}

will show difference between download and upload speed. Another feature provided by lambda functions is $this value which returns the last value of the lambda function. Here is a little more complicated example which will show running line “Artist - Title” with length less or equal than 20 symbols:

${{
function runningLine() {
    var current = "$artist - $title";
    var index = current.indexOf("$this");
    if (("$this" == "") || ((index + 20 + 1) > current.length))
        return current.substring(0, 20);
    else
        return current.substring(index + 1, index + 20 + 1);
}
runningLine()
}}

Thus this feature may be used for example to show any custom values which will be calculated in runtime and to show different information depending on some conditions. But please keep in mind that such runtime calculation may increase CPU load.

Another feature which has been introduced with 3.1.0 is templates. It works in the same way as lambda functions, but they are calculated only once (at the start), e.g.:

$template{{
function three()
{
    return 1+2;
}
three()
}}

will always show 3 and will not be calculated each time.

Special functions

To allow some features with lambdas and templates several internal functions have been introduced with 3.1.0. They have the same syntax: $aw_function<args>{{body}}. where args may be optional. If there are several args they should be comma separated. If you want to pass comma as arg use $,. If you want to use double brackets inside body screen them by using $, e.g. ${. Functions will be called once and before any actions.

Advanced settings

Enable background: Uncheck to disable default background and set transparent one. Default is true.

Translate strings: Translate strings tags. Default is true.

Wrap new lines: Replace \n to <br>. Default is false.

Word wrap: Enable word wrap. Default is false.

Enable popup: Uncheck box if you do not want popup messages on system events. Default is true.

Check updates: Check updates on load. Default is true.

Optimize subscription: Optimize work with DataEngines. Probably you don’t want change this option despite the fact that one feature will not be available. Default is true.

Widget height: Disable automatic widget height definition and set it to this value. Default is 0 (auto).

Widget width: Disable automatic widget width definition and set it to this value. Default is 0 (auto).

Update interval: Widget update interval. Default is 1000.

Queue limit: Use thread pool with this maximum thread counts. 0 means CPU ideal thread count. Default is 0.

Temperature units: Select units for temperature. Available units are Celsius, Farenheit, Kelvin, Reaumur, cm^-1, kJ/mol, kcal/mol.

Custom time format:

Custom uptime format:

AC online tag: Line which will be shown when AC is online. Default is (*).

AC offline tag: Line which will be shown when AC is offline. Default is ( ).

Enable remote telemetry: Enable upload of your configuration to remote server.

History count: Total count of stored configurations localy.

Telemetry ID: Unique client ID used for remote telemetry.

Tooltips

Since version 1.7.0 CPU, CPU clock, memory, swap, network and battery support graphical tooltip. To enable them just select required fields. The number of stored values can be set in the tab. Colours of the graphs are configurable too.

DataEngine settings

ACPI path: Path to ACPI devices. The file /sys/class/power_supply/.

GPU device: Select one of supported GPU devices. auto will enable auto selection, disable will disable all GPU monitors. Default is auto.

HDD: Select one of HDDs for HDD temperature monitor. all will enable monitor for all devices, disable will disable HDD temperature monitor. Default is all.

hddtemp cmd: Type a command which will be run for hddtemp DataEngine. Default is sudo smartctl -a.

Player symbol count: Symbol count for dynamic player tags.

Music player: Select one of supported music players for player label.

MPRIS: Select MPRIS player name. auto will enable auto selection. Default is auto.

MPD address: Address of MPD server. Default is localhost.

MPD port: Port of MPD server. Default is 6600.

Desktop Panel

Since version 1.11.0 it provides a minimalistic panel to control destops. And yes, it looks like the same panel in Awesome.

Desktop panel configuration

Enable background: Uncheck to disable default background and set transparent one. Default is true.

Vertical layout: Use vertical layout instead of horizontal one. Default is false.

Widget height: Disable automatic widget height definition and set it to this value. Default is 0 (auto).

Widget width: Disable automatic widget width definition and set it to this value. Default is 0 (auto).

Mark: Type symbol (or string) which will be shown if this desktop is active now.

Tooltip type: Select tooltip type. Default is windows.

Tooltip width: Using tooltip width in px. Default is 200px.

Color of tooltip: Colour which is used in some tooltip types. Default is #ffffff.

Pattern tags

| | | |———|———| | $mark | Show mark if this desktop is active. Shows spaces in other way. | | $name | Name of the desktop. | | $number | Number of the desktop. | | $total | Total number of desktops. |

Graphical user interface

Screenshots

Widget (clickable)

Configuration window

Configuration window

Configuration window

Configuration window

Configuration window

Tooltips

Links

• GitHub repo
• Latest release
• Plasmoid page on kde-look.org
• DataEngine page on kde-look.org
• Archlinux AUR package
• openSUSE package (thanks to Kott)
• Ubuntu package
• Migration to version 2.0
• Extensions
• Formatters and macros