summaryrefslogtreecommitdiffhomepage
path: root/readme.md
diff options
context:
space:
mode:
authorPaul Fertser <fercerpav@gmail.com>2020-02-16 12:40:02 +0300
committerPaul Fertser <fercerpav@gmail.com>2020-02-25 13:07:44 +0300
commitf4555b51b778ae5e677ce63eccdfd9376d07dd5d (patch)
treef7a8f59022efc3396e602c78856958537ca6de4d /readme.md
parent3f11da6eed40b06044c705db9e3e81fd25abb391 (diff)
downloadxmobar-f4555b51b778ae5e677ce63eccdfd9376d07dd5d.tar.gz
xmobar-f4555b51b778ae5e677ce63eccdfd9376d07dd5d.tar.bz2
Wireless: support NL80211 userspace <-> kernelspace API
NL80211 was introduced in Linux 2.6.24 in 2007 as a new extensible universal API, replacing "wireless extensions" ioctls. It works on top of netlink, and allows direct communication to cfg80211 kernel subsystem. Since then it became a hard requirement for all upstream wireless drivers to hook into cfg80211 (SoftMAC drivers do it via the common mac80211 layer). There's still additional compatibility code that allows limited Wext functionality for cfg80211 drivers but it's buggy and can be disabled altogether when CONFIG_CFG80211_WEXT is not set. This patch makes use of "netlink" Haskell library which doesn't have any additional runtime dependencies (so neither iwlib nor libnl are required). The operation is the same as performed by "iw dev <devname> link" command. The signal level is transformed to "quality" by first clamping it to [-110; -40], then adding 110 and dividing by 70 (same meaningless formula as used by the cfg80211 Wext compatibility layer). "essid" template argument is replaced by more appropriate "ssid" (with the old variant still available for backwards compatibility)
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md31
1 files changed, 19 insertions, 12 deletions
diff --git a/readme.md b/readme.md
index eb14023..7afac44 100644
--- a/readme.md
+++ b/readme.md
@@ -117,11 +117,15 @@ Otherwise, you'll need to install them yourself.
option is needed for the MBox and Mail plugins to work. Requires the
[hinotify] package.
-- `with_iwlib` Support for wireless cards. Enables the Wireless
- plugin. No Haskell library is required, but you will need the
- [iwlib] C library and headers in your system (e.g., install
- `libiw-dev` in Debian-based systems or `wireless_tools` on Arch
- Linux).
+- `with_nl80211` Support for wireless cards on Linux via nl80211 (all
+ upstream drivers). Enables the Wireless plugin. Requires [netlink]
+ and [cereal] packages.
+
+- `with_iwlib` Support for wireless cards via Wext ioctls
+ (deprecated). Enables the Wireless plugin. No Haskell library is
+ required, but you will need the [iwlib] C library and headers in your
+ system (e.g., install `libiw-dev` in Debian-based systems or
+ `wireless_tools` on Arch Linux). Conflicts with `with_nl80211`.
- `with_alsa` Support for ALSA sound cards. Enables the Volume
plugin. Requires the [alsa-mixer] package. To install the latter,
@@ -820,18 +824,21 @@ specification, such as `("clear", "<icon=weather-clear.xbm/>")`.
### `Wireless Interface Args RefreshRate`
-- If set to "", the interface is looked up in /proc/net/wireless.
+- If set to "", first suitable wireless interface is used.
- Aliases to the interface name with the suffix "wi": thus, `Wireless
"wlan0" []` can be used as `%wlan0wi%`, and `Wireless "" []` as `%wi%`.
- Args: default monitor arguments, plus:
- `--quality-icon-pattern`: dynamic string for connection quality in `qualityipat`.
- Variables that can be used with the `-t`/`--template` argument:
- `essid`, `quality`, `qualitybar`, `qualityvbar`, `qualityipat`
-- Thresholds refer to link quality in a `[0, 100]` scale
-- Default template: `<essid> <quality>`
-- Requires the C library [iwlib] (part of the wireless tools suite)
- installed in your system. In addition, to activate this plugin you
- must pass `--flags="with_iwlib"` during compilation
+ `ssid`, `signal`, `quality`, `qualitybar`, `qualityvbar`, `qualityipat`
+- Thresholds refer to link quality on a `[0, 100]` scale. Note that
+ `quality` is calculated from `signal` (in dBm) by a possibly lossy
+ conversion. It is also not taking into account many factors such as
+ noise level, air busy time, transcievers' capabilities and the
+ others which can have drastic impact on the link performance.
+- Default template: `<ssid> <quality>`
+- To activate this plugin you must pass `--flags="with_nl80211"` or
+ `--flags="with_iwlib"` during compilation
### `Memory Args RefreshRate`