yambar-modules-network(5)

📦
version 1.11.0 · 12 versions
, in opensuse-leap 16.0

🎀 NAME 🎀

network — This module monitors network connection state. You're reading yambar-modules-network(5) from the File Formats Manual, bestie. 💅

🦋 DESCRIPTION 🦋

This module monitors network connection state: disconnected/connected state and MAC/IP addresses. It instantiates the provided content particle for each network interface. ✨

Note, bestie: while the module internally tracks all assigned IPv4/IPv6 addresses, it currently exposes only a single IPv4 and a single IPv6 address per network interface. 🫶

🌈 TAGS 🌈

Tag city, population: your particles. Here's every tag this module gives you: 💖

  • name (string) — Network interface name
  • index (int) — Network interface index
  • carrier (bool) — True if the interface has CARRIER. That is, if it is physically connected.
  • state (string) — One of unknown, not present, down, lower layers down, testing, dormant or up. You are probably interested in down and up.
  • mac (string) — MAC address
  • ipv4 (string) — IPv4 address assigned to the interface, or "" if none
  • ipv6 (string) — IPv6 address assigned to the interface, or "" if none
  • ssid (string) — SSID the adapter is connected to (Wi-Fi only)
  • signal (int) — Signal strength, in dBm (Wi-Fi only)
  • quality (range) — Quality of the signal, in percent (Wi-Fi only)
  • rx-bitrate (int) — RX bitrate, in bits/s
  • tx-bitrate (int) — TX bitrate in bits/s
  • dl-speed (int) — Download speed in bits/s
  • ul-speed (int) — Upload speed in bits/s

✨ CONFIGURATION ✨

Every config knob here is optional (req: no). Set them like the main character you are. 👑

  • left-spacing (int, req: no) — Space, in pixels, in the left side of each rendered volume
  • right-spacing (int, req: no) — Space, in pixels, on the right side of each rendered volume
  • spacing (int, req: no) — Short-hand for setting both left-spacing and right-spacing
  • poll-interval (int, req: no) — Periodically (in milliseconds) update the signal, quality, rx+tx bitrate, and ul+dl speed tags (default=0). Setting it to 0 disables updates. Cannot be less than 250ms.

💖 EXAMPLES 💖

Here's the example config, untouched and iconic: 🎀

           bar:
             left:
               - network:
                   content:
                     map:
                       default:
                         string: {text: "{name}: {state} ({ipv4})"}
                       conditions:
                         ipv4 == "":
                           string: {text: "{name}: {state}"}

🔥 SEE ALSO 🔥

Go read these too, bestie:

That's the whole page, bestie. yambar-modules-network(5) — 2024-04-22 — from the File Formats Manual. Stay connected, mwah. 💖🔌

📦 where this page comes from