1yambar-modules-network(5) File Formats Manual yambar-modules-network(5)
2
6 network - This module monitors network connection state
7
9 This module monitors network connection state; disconnected/connected
10 state and MAC/IP addresses.
11 Note: while the module internally tracks all assigned IPv4/IPv6 ad‐
13 dresses, it currently exposes only a single IPv4 and a single IPv6 ad‐
14 dress.
15
17 ┌───────────┬────────┬─────────────────────┐
18 │Name │ Type │ Description │
19 ├───────────┼────────┼─────────────────────┤
20 │name │ string │ Network interface │
21 │ │ │ name │
22 ├───────────┼────────┼─────────────────────┤
23 │index │ int │ Network interface │
24 │ │ │ index │
25 ├───────────┼────────┼─────────────────────┤
26 │carrier │ bool │ True if the inter‐ │
27 │ │ │ face has CARRIER. │
28 │ │ │ That is, if it is │
29 │ │ │ physically con‐ │
30 │ │ │ nected. │
31 ├───────────┼────────┼─────────────────────┤
32 │state │ string │ One of unknown, not │
33 │ │ │ present, down, │
34 │ │ │ lower layers down, │
35 │ │ │ testing, dormant or │
36 │ │ │ up. You are proba‐ │
37 │ │ │ bly interested in │
38 │ │ │ down and up. │
39 ├───────────┼────────┼─────────────────────┤
40 │mac │ string │ MAC address │
41 ├───────────┼────────┼─────────────────────┤
42 │ipv4 │ string │ IPv4 address as‐ │
43 │ │ │ signed to the in‐ │
44 │ │ │ terface, or "" if │
45 │ │ │ none │
46 ├───────────┼────────┼─────────────────────┤
47 │ipv6 │ string │ IPv6 address as‐ │
48 │ │ │ signed to the in‐ │
49 │ │ │ terface, or "" if │
50 │ │ │ none │
51 ├───────────┼────────┼─────────────────────┤
52 │ssid │ string │ SSID the adapter is │
53 │ │ │ connected to (Wi-Fi │
54 │ │ │ only) │
55 ├───────────┼────────┼─────────────────────┤
56 │signal │ int │ Signal strength, in │
57 │ │ │ dBm (Wi-Fi only) │
58 ├───────────┼────────┼─────────────────────┤
59 │rx-bitrate │ int │ RX bitrate, in │
60 │ │ │ Mbit/s │
61 ├───────────┼────────┼─────────────────────┤
62 │tx-bitrate │ int │ TX bitrate in │
63 │ │ │ Mbit/s │
64 └───────────┴────────┴─────────────────────┘
65
67 ┌──────────────┬────────┬─────┬──────────────────┐
68 │Name │ Type │ Req │ Description │
69 ├──────────────┼────────┼─────┼──────────────────┤
70 │name │ string │ yes │ Name of network │
71 │ │ │ │ interface to │
72 │ │ │ │ monitor │
73 ├──────────────┼────────┼─────┼──────────────────┤
74 │poll-interval │ int │ no │ Periodically (in │
75 │ │ │ │ seconds) update │
76 │ │ │ │ the signal and │
77 │ │ │ │ rx+tx bitrate │
78 │ │ │ │ tags. │
79 └──────────────┴────────┴─────┴──────────────────┘
80
82 bar:
83 left:
84 - network:
85 name: wlp3s0
86 content:
87 string: {text: "{name}: {state} ({ipv4})"}
88
90 yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
91 tions(5)
92 2022-08-26 yambar-modules-network(5)