.\" Generated by scdoc 1.11.5
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "yambar\-modules\-network" "5" "2026\-09\-18"
.PP
.SH NAME
network \- This module monitors network connection state
.PP
.SH DESCRIPTION
.PP
This module monitors network connection state; disconnected/connected
state and MAC/IP addresses.\& It instantiates the provided \fIcontent\fR
particle for each network interface.\&
.PP
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.\&
.PP
.SH TAGS
.PP
.TS
allbox;l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx
l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
name
T}	T{
string
T}	T{
Network interface name
T}
T{
index
T}	T{
int
T}	T{
Network interface index
T}
T{
carrier
T}	T{
bool
T}	T{
True if the interface has CARRIER.\& That is, if it is physically connected.\&
T}
T{
state
T}	T{
string
T}	T{
One of \fBunknown\fR, \fBnot present\fR, \fBdown\fR, \fBlower layers down\fR, \fBtesting\fR, \fBdormant\fR or \fBup\fR.\& You are probably interested in \fBdown\fR and \fBup\fR.\&
T}
T{
mac
T}	T{
string
T}	T{
MAC address
T}
T{
ipv4
T}	T{
string
T}	T{
IPv4 address assigned to the interface, or \fB""\fR if none
T}
T{
ipv6
T}	T{
string
T}	T{
IPv6 address assigned to the interface, or \fB""\fR if none
T}
T{
ssid
T}	T{
string
T}	T{
SSID the adapter is connected to (Wi\-Fi only)
T}
T{
signal
T}	T{
int
T}	T{
Signal strength, in dBm (Wi\-Fi only)
T}
T{
quality
T}	T{
range
T}	T{
Quality of the signal, in percent (Wi\-Fi only)
T}
T{
rx\-bitrate
T}	T{
int
T}	T{
RX bitrate, in bits/s
T}
T{
tx\-bitrate
T}	T{
int
T}	T{
TX bitrate in bits/s
T}
T{
dl\-speed
T}	T{
int
T}	T{
Download speed in bits/s
T}
T{
ul\-speed
T}	T{
int
T}	T{
Upload speed in bits/s
T}
.TE
.sp 1
.PP
.SH CONFIGURATION
.PP
.TS
allbox;l l l lx
l l l lx
l l l lx
l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
left\-spacing
T}	T{
int
T}	T{
no
T}	T{
Space, in pixels, in the left side of each rendered volume
T}
T{
right\-spacing
T}	T{
int
T}	T{
no
T}	T{
Space, in pixels, on the right side of each rendered volume
T}
T{
spacing
T}	T{
int
T}	T{
no
T}	T{
Short\-hand for setting both \fIleft\-spacing\fR and \fIright\-spacing\fR
T}
T{
poll\-interval
T}	T{
int
T}	T{
no
T}	T{
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.\&
T}
.TE
.sp 1
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
bar:
  left:
    \- network:
        content:
          map:
            default:
              string: {text: "{name}: {state} ({ipv4})"}
            conditions:
              ipv4 == "":
                string: {text: "{name}: {state}"}
.fi
.RE
.PP
.SH SEE ALSO
.PP
\fByambar\-modules\fR(5), \fByambar\-particles\fR(5), \fByambar\-tags\fR(5), \fByambar\-decorations\fR(5)
.PP