README.rst 2.68 KB
Newer Older
wavexx's avatar
wavexx committed
1 2 3 4 5 6 7 8
connman-notify: desktop notification integration for connman
============================================================

`connman-notify` generates desktop notifications for connman_ events, such as
interface connection/disconnection.

The generated notifications look like::

wavexx's avatar
wavexx committed
9
  ethernet: online [10.1.0.5]
wavexx's avatar
wavexx committed
10 11
  ethernet: disconnected
  wifi/SSID: configuring ...
wavexx's avatar
wavexx committed
12
  wifi/SSID: online [192.168.0.1]
wavexx's avatar
wavexx committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
  ...


Usage
-----

Simply run `connman-notify` at the start of your session:

  ./connman-notify &

Use `connman-notify -h` to see a minimal help. The command line flags `-n` and
`-l` can be used to customize the detail level of the notification (to hide
IPv4/6 addresses or show long `connman` interface names).

You'll need `connman` to be running of course, and you'll also need a
notification daemon such as dunst_.


Why connman
-----------

wavexx's avatar
wavexx committed
34 35 36 37 38 39 40
If you're interested in desktop-environment agnostic network managers,
`connman` is one of the few available along with WICD_, netctl_ if you're using
Arch linux, and dhcpcd_ (yes, `dhcpcd` can be also used as a *simple* network
manager using `dhcpcd-gtk`).

If you're looking for a zero-configuration solution though, just use WICD_.
`connman` is not "user friendly" yet.
wavexx's avatar
wavexx committed
41 42

connman_ however blows `WICD` out of the water in terms of speed. It can bring
wavexx's avatar
wavexx committed
43 44 45 46
an ethernet link up in 2 seconds (compared to ~10s of `WICD`) and perform an
ethernet<=>WiFi switch in generally less than 3 seconds (`WICD` normally just
fails to reconnect!). Not to mention minimal CPU/memory usage, built-in DHCP
client, and good support for IPv6.
wavexx's avatar
wavexx committed
47 48 49 50 51 52 53 54 55 56 57 58

`connman` has no graphical management interface yet. connman-ui_ runs in the
system tray (if you have one), but it's still far away to being complete.

connman_dmenu_ provides a simple dmenu-based WiFi network selector. For a tiled
window-manager setup, the combination of `connman-notify` and `connman_dmenu`
serves my current purposes nicely.


Dependencies
------------

wavexx's avatar
wavexx committed
59
The following software is currently required for `connman-notify`:
wavexx's avatar
wavexx committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79

- Python
- Pynotify (``python-notify``)
- Python DBUS (``python-dbus``)

On Debian/Ubuntu, you can install all the required dependencies with::

  sudo apt-get install python python-notify python-dbus


Authors and Copyright
---------------------

| `connman-notify` is distributed under GPL2 (see COPYING) WITHOUT ANY WARRANTY.
| Copyright(c) 2014 by wave++ "Yuri D'Elia" <wavexx@thregr.org>.

.. _connman: https://01.org/connman
.. _connman-ui: https://github.com/tbursztyka/connman-ui
.. _dunst: http://www.knopwob.org/dunst/
.. _connman_dmenu: https://github.com/taylorchu/connman_dmenu
wavexx's avatar
wavexx committed
80 81 82
.. _WICD: https://launchpad.net/wicd
.. _dhcpcd: http://roy.marples.name/projects/dhcpcd/
.. _netctl: https://wiki.archlinux.org/index.php/netctl