1yambar-modules-network(5)     File Formats Manual    yambar-modules-network(5)
2
3
4

NAME

6       network - This module monitors network connection state
7

DESCRIPTION

9       This module monitors network connection state; disconnected/connected
10       state and MAC/IP addresses.
11
12       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

TAGS

17       ┌───────────┬────────┬─────────────────────────────────────────────────┐
18Name       Type   Description                                     
19       ├───────────┼────────┼─────────────────────────────────────────────────┤
20       │name       │ string │ Network interface name                          │
21       ├───────────┼────────┼─────────────────────────────────────────────────┤
22       │index      │ int    │ Network interface index                         │
23       ├───────────┼────────┼─────────────────────────────────────────────────┤
24       │carrier    │ bool   │ True if the interface has CARRIER. That is, if  │
25       │           │        │ it is physically connected.                     │
26       ├───────────┼────────┼─────────────────────────────────────────────────┤
27       │state      │ string │ One of unknown, not present, down, lower layers 
28       │           │        │ down, testing, dormant or up. You are probably  │
29       │           │        │ interested in down and up.                      │
30       ├───────────┼────────┼─────────────────────────────────────────────────┤
31       │mac        │ string │ MAC address                                     │
32       ├───────────┼────────┼─────────────────────────────────────────────────┤
33       │ipv4       │ string │ IPv4 address assigned to the interface, or ""   
34       │           │        │ if none                                         │
35       ├───────────┼────────┼─────────────────────────────────────────────────┤
36       │ipv6       │ string │ IPv6 address assigned to the interface, or ""   
37       │           │        │ if none                                         │
38       ├───────────┼────────┼─────────────────────────────────────────────────┤
39       │ssid       │ string │ SSID the adapter is connected to (Wi-Fi only)   │
40       ├───────────┼────────┼─────────────────────────────────────────────────┤
41       │signal     │ int    │ Signal strength, in dBm (Wi-Fi only)            │
42       ├───────────┼────────┼─────────────────────────────────────────────────┤
43       │rx-bitrate │ int    │ RX bitrate, in bits/s                           │
44       ├───────────┼────────┼─────────────────────────────────────────────────┤
45       │tx-bitrate │ int    │ TX bitrate in bits/s                            │
46       ├───────────┼────────┼─────────────────────────────────────────────────┤
47       │dl-speed   │ int    │ Download speed in bits/s                        │
48       ├───────────┼────────┼─────────────────────────────────────────────────┤
49       │ul-speed   │ int    │ Upload speed in bits/s                          │
50       └───────────┴────────┴─────────────────────────────────────────────────┘
51

CONFIGURATION

53       ┌──────────────┬────────┬─────┬────────────────────────────────────────┐
54Name          Type   Req Description                            
55       ├──────────────┼────────┼─────┼────────────────────────────────────────┤
56       │name          │ string │ yes │ Name of network interface to monitor   │
57       ├──────────────┼────────┼─────┼────────────────────────────────────────┤
58       │poll-interval │ int    │ no  │ Periodically (in milliseconds) update  │
59       │              │        │     │ the signal, rx+tx bitrate, and ul+dl   │
60       │              │        │     │ speed tags. Setting it to 0 disables   │
61       │              │        │     │ updates. Cannot be less than 250ms.    │
62       └──────────────┴────────┴─────┴────────────────────────────────────────┘
63

EXAMPLES

65           bar:
66             left:
67               - network:
68                   name: wlp3s0
69                   content:
70                     string: {text: "{name}: {state} ({ipv4})"}
71

SEE ALSO

73       yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
74       tions(5)
75
76                                  2023-07-14         yambar-modules-network(5)
Impressum