yambar-modules-network - Man Page

This module monitors network connection state

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: 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

NameTypeDescription
namestringNetwork interface name
indexintNetwork interface index
carrierboolTrue if the interface has CARRIER. That is, if it is physically connected.
statestringOne of unknown, not present, down, lower layers down, testing, dormant or up. You are probably interested in down and up.
macstringMAC address
ipv4stringIPv4 address assigned to the interface, or "" if none
ipv6stringIPv6 address assigned to the interface, or "" if none
ssidstringSSID the adapter is connected to (Wi-Fi only)
signalintSignal strength, in dBm (Wi-Fi only)
qualityrangeQuality of the signal, in percent (Wi-Fi only)
rx-bitrateintRX bitrate, in bits/s
tx-bitrateintTX bitrate in bits/s
dl-speedintDownload speed in bits/s
ul-speedintUpload speed in bits/s

Configuration

NameTypeReqDescription
left-spacingintnoSpace, in pixels, in the left side of each rendered volume
right-spacingintnoSpace, in pixels, on the right side of each rendered volume
spacingintnoShort-hand for setting both left-spacing and right-spacing
poll-intervalintnoPeriodically (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

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

See Also

yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decorations(5)

Referenced By

yambar-modules(5).

2025-01-19