Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefano-m/awesome-connman_widget
A widget for the Awesome Window Manager to monitor the network with Connman
https://github.com/stefano-m/awesome-connman_widget
List: awesome-connman_widget
awesomewm connman dbus widget
Last synced: 3 months ago
JSON representation
A widget for the Awesome Window Manager to monitor the network with Connman
- Host: GitHub
- URL: https://github.com/stefano-m/awesome-connman_widget
- Owner: stefano-m
- License: gpl-3.0
- Created: 2016-10-06T20:53:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-10T15:47:08.000Z (about 5 years ago)
- Last Synced: 2024-11-07T20:00:41.997Z (3 months ago)
- Topics: awesomewm, connman, dbus, widget
- Language: Lua
- Size: 33.2 KB
- Stars: 18
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-awesomewm-modules-widgets-and-libraries - awesome-connman_widget
- awesome-awesomewm-modules-widgets-and-libraries - awesome-connman_widget
README
# A widget for the Awesome Window Manager to monitor the network with Connman
This widget uses the
[`connman_dbus`](https://luarocks.org/modules/stefano-m/connman_dbus)
library.
# Requirements
In addition to the requirements listed in the `rockspec` file, you will need
the [Awesome Window Manager](https://awesomewm.org)
and Connman (for more information about this, see the
[`connman_dbus`](https://luarocks.org/modules/stefano-m/connman_dbus)
documentation).
# Installation
## Luarocks
Probably, the easiest way to install this widget is to use `luarocks`:
luarocks install connman_widget
You can use the `--local` option if you don't want or can't install
it system-wide
This will ensure that all its dependencies are installed.
Note that if you install with `--local` you will have to make sure that the
`LUA_PATH` environment variable includes the local luarocks path. This can be
achieved by `eval`ing the command `luarocks path --bin` **before** Awesome is
started.
For example, if you start Awesome from the Linux console (e.g. `xinit
awesome`) and you use `zsh`, you can add the following lines to your
`~/.zprofile`:
``` shell
if (( $+commands[luarocks] )); then
eval `luarocks path --bin`
fi
```
If you use `bash`, you can add the following lines to your `~/.bash_profile`:
``` shell
if [[ -n "`which luarocks 2>/dev/null`" ]]; then
eval `luarocks path --bin`
fi
```
If you use
an [X Display Manager](https://en.wikipedia.org/wiki/Display_manager) you will
need to do what explained above in your `~/.xprofile` or `~/.xinitrc`. See the
documentation of your display manager of choice for more information.
## NixOS
If you are on NixOS, you can install this package from
[nix-stefano-m-overlays](https://github.com/stefano-m/nix-stefano-m-nix-overlays).
# Configuration
The widget will display the network icons defined in your GTK+ theme and it
will resize them to fit in the available space. This means that you can switch
your icon theme, for example using `lxappearance`, and update the widget by
restarting AwesomeWM.
Depending on your network devices, you may need some or all of the icons
whose name starts with `network-`.
You can specify a GUI client to be launched when the widget is right-clicked.
This can be done by changing the `gui_client` field of the widget. A list of
[Desktop clients is also available on the Arch
wiki](https://wiki.archlinux.org/index.php/Connman).
# Mouse controls
When the widget is focused:
* Right button: launches GUI client (defined by the `gui_client` field)
# Tooltip
The tooltip shows the currently connected network, its status and - if
applicable - the signal strength.
# Usage
Add the following to your `~/.config/awesome/rc.lua`:
Require the module:
```lua
-- require *after* `beautiful.init` or the theme will be inconsistent!
local connman = require("connman_widget")
-- set the GUI client.
connman.gui_client = "wicd"
```
Add the widget to your layout:
- Awesome 4.x
``` lua
-- Add widgets to the wibox
s.mywibox:setup {
-- more setup
{ -- Right widgets
layout = wibox.layout.fixed.horizontal,
wibox.widget.systray(),
connman, -- <- connman widget
mytextclock,
s.mylayoutbox,
},
}
```
- Awesome 3.x
```lua
right_layout:add(connman)
```
# Limitations
Currently, only wired (ethernet) and WiFi connections are supported.
# Contributing
This project is developed in the author's spare time. Contributions in the form
of issues, patches and pull requests are welcome.