logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

network - This module monitors network connection state

Configuration

┌───────────────┬──────┬─────┬──────────────────────────────────────────────────────────────────────────┐ │ NameTypeReqDescription │ ├───────────────┼──────┼─────┼──────────────────────────────────────────────────────────────────────────┤ │ left-spacing │ int │ no │ Space, in pixels, in the left side of each rendered volume │ ├───────────────┼──────┼─────┼──────────────────────────────────────────────────────────────────────────┤ │ right-spacing │ int │ no │ Space, in pixels, on the right side of each rendered volume │ ├───────────────┼──────┼─────┼──────────────────────────────────────────────────────────────────────────┤ │ spacing │ int │ no │ Short-hand for setting both left-spacing and right-spacing │ ├───────────────┼──────┼─────┼──────────────────────────────────────────────────────────────────────────┤ │ poll-interval │ int │ 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. │ └───────────────┴──────┴─────┴──────────────────────────────────────────────────────────────────────────┘

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.

Examples

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

Name

network - This module monitors network connection state

See Also

yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decorations(5) 2024-04-20 yambar-modules-network(5)

Tags

┌────────────┬────────┬─────────────────────────────────────────────────────────────────────────────────┐ │ NameTypeDescription │ ├────────────┼────────┼─────────────────────────────────────────────────────────────────────────────────┤ │ 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, notpresent, down, lowerlayersdown, 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 │ └────────────┴────────┴─────────────────────────────────────────────────────────────────────────────────┘

See Also