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.

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

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)
rx-bitrateintRX bitrate, in Mbit/s
tx-bitrateintTX bitrate in Mbit/s

Configuration

NameTypeReqDescription
namestringyesName of network interface to monitor
poll-intervalintnoPeriodically (in seconds) update the signal and rx+tx bitrate tags.

Examples

  bar:
    left:
      - network:
          name: wlp3s0
          content:
            string: {text: "{name}: {state} ({ipv4})"}

See Also

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

Referenced By

yambar-modules(5).

2022-08-26