Module: `awful.widget.watch`

Watch widget.

Here is an example of simple temperature widget which will update each 15 seconds implemented in two different ways. The first, simpler one, will just display the return command output (so output is stripped by shell commands). In the other example sensors returns to the widget its full output and it's trimmed in the widget callback function:

211             mytextclock,
212             wibox.widget.textbox('  |  '),
213             -- one way to do that:
214             awful.widget.watch('bash -c "sensors | grep temp1"', 15),
215             -- another way:
216             awful.widget.watch('sensors', 15, function(widget, stdout)
217               for line in stdout:gmatch("[^\r\n]+") do
218                 if line:match("temp1") then
219                   widget:set_text(line)
220                   return
221                 end
222               end
223             end),
224             s.mylayoutbox,

Example screenshot

Here is the most basic usage:

DOCHIDE --DOCGEN_IMAGE

Usage example

awful.widget.watch('bash -c "echo Hello world! | grep Hello"', 15)

Info:

Copyright: 2015, 2016 Benjamin Petrenko, Yauheni Kirylau
Originally authored by: Benjamin Petrenko,Yauheni Kirylau
(Full contributors list available on our github project)

Constructors

awful.widget.watch (command[, timeout=5][, callback], base_widget)

Create a textbox that shows the output of a command and updates it at a given time interval.

Object properties

children	table	Get or set the children elements.	Inherited from wibox.widget
all_children	table	Get all direct and indirect children widgets.	Inherited from wibox.widget
forced_height	number or nil	Force a widget height.	Inherited from wibox.widget
forced_width	number or nil	Force a widget width.	Inherited from wibox.widget
opacity	number	The widget opacity (transparency).	Inherited from wibox.widget
visible	boolean	The widget visibility.	Inherited from wibox.widget
buttons	table	The widget buttons.	Inherited from wibox.widget

Object methods

:setup {[args]}	Set a declarative widget hierarchy description.	Inherited from wibox.widget
:add_button (button)	Add a new awful.button to this widget.	Inherited from wibox.widget
:emit_signal_recursive (signal_name, ...)	Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.	Inherited from wibox.widget
:emit_signal (name, ...)	Emit a signal.	Inherited from gears.object
:connect_signal (name, func)	Connect to a signal.	Inherited from gears.object
:weak_connect_signal (name, func)	Connect to a signal weakly.	Inherited from gears.object

Signals

widget::layout_changed	When the layout (size) change.	Inherited from wibox.widget
widget::redraw_needed	When the widget content changed.	Inherited from wibox.widget
button::press	When a mouse button is pressed over the widget.	Inherited from wibox.widget
button::release	When a mouse button is released over the widget.	Inherited from wibox.widget
mouse::enter	When the mouse enter a widget.	Inherited from wibox.widget
mouse::leave	When the mouse leave a widget.	Inherited from wibox.widget

Constructors

awful.widget.watch (command[, timeout=5][, callback], base_widget)

Create a textbox that shows the output of a command and updates it at a given time interval.

Parameters:

command string or table The command.
timeout integer The time interval at which the textbox will be updated. (default 5)
callback
The function that will be called after the command output will be received. it is shown in the textbox. Defaults to:
```
 function(widget, stdout, stderr, exitreason, exitcode)
     widget:set_text(stdout)
 end
```
- widget Base widget instance.
- stdout string Output on stdout.
- stderr string Output on stderr.
- exitreason string Exit Reason. The reason can be "exit" or "signal".
- exitcode integer Exit code. For "exit" reason it's the exit code. For "signal" reason — the signal causing process termination.
base_widget Base widget. (default wibox.widget.textbox())

Returns:

The widget used by this watch.
Its gears.timer.

Object properties

children table · Inherited from wibox.widget

Get or set the children elements.

Type constraints:

children table The children.

all_children table · Inherited from wibox.widget

Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow id the widget, or any of its children, contain (directly or indirectly) itself.

Type constraints:

children table The children.

forced_height number or nil · Inherited from wibox.widget

Force a widget height.

Type constraints:

height number or nil The height (nil for automatic)

forced_width number or nil · Inherited from wibox.widget

Force a widget width.

Type constraints:

width number or nil The width (nil for automatic)

opacity number · Inherited from wibox.widget

The widget opacity (transparency).

Type constraints:

opacity number The opacity (between 0 and 1) (default 1)

visible boolean · Inherited from wibox.widget

The widget visibility.

buttons table · Inherited from wibox.widget

The widget buttons.

The table contains a list of awful.button objects.

Object methods

:setup {[args]} · Inherited from wibox.widget

Set a declarative widget hierarchy description. See The declarative layout system

Parameters:

args An array containing the widgets disposition

:add_button (button) · Inherited from wibox.widget

Add a new awful.button to this widget.

Parameters:

button awful.button The button to add.

:emit_signal_recursive (signal_name, ...) · Inherited from wibox.widget

Emit a signal and ensure all parent widgets in the hierarchies also forward the signal. This is useful to track signals when there is a dynamic set of containers and layouts wrapping the widget.

Parameters:

signal_name string
... Other arguments

:emit_signal (name, ...) · Inherited from gears.object

Emit a signal.

Parameters:

name string The name of the signal.
... Extra arguments for the callback functions. Each connected function receives the object as first argument and then any extra arguments that are given to emit_signal().

:connect_signal (name, func) · Inherited from gears.object

Connect to a signal.

Parameters:

name string The name of the signal.
func function The callback to call when the signal is emitted.

:weak_connect_signal (name, func) · Inherited from gears.object

Connect to a signal weakly.

This allows the callback function to be garbage collected and automatically disconnects the signal when that happens.

Warning: Only use this function if you really, really, really know what you are doing.

Parameters:

name string The name of the signal.
func function The callback to call when the signal is emitted.

Signals

widget::layout_changed · Inherited from wibox.widget

When the layout (size) change. This signal is emitted when the previous results of :layout() and :fit() are no longer valid. Unless this signal is emitted, :layout() and :fit() must return the same result when called with the same arguments.

Arguments:

self table The current object instance itself.
lx number The horizontal position relative to the (0,0) position in the widget.
ly number The vertical position relative to the (0,0) position in the widget.
button number The button number.
mods table The modifiers (mod4, mod1 (alt), Control, Shift)
find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
- drawable wibox.drawable The drawable containing the widget.
- widget widget The widget being displayed.
- hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
- x number An approximation of the X position that the widget is visible at on the surface.
- y number An approximation of the Y position that the widget is visible at on the surface.
- width number An approximation of the width that the widget is visible at on the surface.
- height number An approximation of the height that the widget is visible at on the surface.
- widget_width number The exact width of the widget in its local coordinate system.
- widget_height number The exact height of the widget in its local coordinate system.

Arguments:

self table The current object instance itself.
lx number The horizontal position relative to the (0,0) position in the widget.
ly number The vertical position relative to the (0,0) position in the widget.
button number The button number.
mods table The modifiers (mod4, mod1 (alt), Control, Shift)
find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
- drawable wibox.drawable The drawable containing the widget.
- widget widget The widget being displayed.
- hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
- x number An approximation of the X position that the widget is visible at on the surface.
- y number An approximation of the Y position that the widget is visible at on the surface.
- width number An approximation of the width that the widget is visible at on the surface.
- height number An approximation of the height that the widget is visible at on the surface.
- widget_width number The exact width of the widget in its local coordinate system.
- widget_height number The exact height of the widget in its local coordinate system.

Arguments:

self table The current object instance itself.
find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
- drawable wibox.drawable The drawable containing the widget.
- widget widget The widget being displayed.
- hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
- x number An approximation of the X position that the widget is visible at on the surface.
- y number An approximation of the Y position that the widget is visible at on the surface.
- width number An approximation of the width that the widget is visible at on the surface.
- height number An approximation of the height that the widget is visible at on the surface.
- widget_width number The exact width of the widget in its local coordinate system.
- widget_height number The exact height of the widget in its local coordinate system.

Arguments:

self table The current object instance itself.
find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
- drawable wibox.drawable The drawable containing the widget.
- widget widget The widget being displayed.
- hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
- x number An approximation of the X position that the widget is visible at on the surface.
- y number An approximation of the Y position that the widget is visible at on the surface.
- width number An approximation of the width that the widget is visible at on the surface.
- height number An approximation of the height that the widget is visible at on the surface.
- widget_width number The exact width of the widget in its local coordinate system.
- widget_height number The exact height of the widget in its local coordinate system.

awesome

Contents

Widgets

Core components

Input handling

Declarative rules

Widget containers

Widget layouts

Popups and bars

Utility libraries

Theme related libraries

Client tiling

Libraries

Sample files

Classes

Documentation

Module: awful.widget.watch

Info:

Constructors

Object properties

Object methods

Signals

Constructors

Parameters:

Returns:

Object properties

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

See also:

Object methods

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Signals

See also:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Module: `awful.widget.watch`