1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
//! Network information
//!
//! This block uses `sysfs` and `netlink` and thus does not require any external dependencies.
//!
//! # Configuration
//!
//! Key | Values | Default
//! ----|--------|--------
//! `device` | Network interface to monitor (as specified in `/sys/class/net/`). Supports regex. | If not set, device will be automatically selected every `interval`
//! `interval` | Update interval in seconds | `2`
//! `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon ^icon_net_down $speed_down.eng(prefix:K) ^icon_net_up $speed_up.eng(prefix:K) "`
//! `format_alt` | If set, block will switch between `format` and `format_alt` on every click | `None`
//! `inactive_format` | Same as `format` but for when the interface is inactive | `" $icon Down "`
//! `missing_format` | Same as `format` but for when the device is missing | `" × "`
//!
//! Action | Description | Default button
//! ----------------|-------------------------------------------|---------------
//! `toggle_format` | Toggles between `format` and `format_alt` | Left
//!
//! Placeholder | Value | Type | Unit
//! ------------------|-----------------------------|--------|---------------
//! `icon` | Icon based on device's type | Icon | -
//! `speed_down` | Download speed | Number | Bytes per second
//! `speed_up` | Upload speed | Number | Bytes per second
//! `graph_down` | Download speed graph | Text | -
//! `graph_up` | Upload speed graph | Text | -
//! `device` | The name of device | Text | -
//! `ssid` | Netfork SSID (WiFi only) | Text | -
//! `frequency` | WiFi frequency | Number | Hz
//! `signal_strength` | WiFi signal | Number | %
//! `bitrate` | WiFi connection bitrate | Number | Bits per second
//! `ip` | IPv4 address of the iface | Text | -
//! `ipv6` | IPv6 address of the iface | Text | -
//! `nameserver` | Nameserver | Text | -
//!
//! # Example
//!
//! Display WiFi info if available
//!
//! ```toml
//! [[block]]
//! block = "net"
//! format = " $icon {$signal_strength $ssid $frequency|Wired connection} via $device "
//! ```
//!
//! Display exact device
//!
//! ```toml
//! [[block]]
//! block = "net"
//! device = "^wlo0$"
//! ```
//!
//! # Icons Used
//! - `net_loopback`
//! - `net_vpn`
//! - `net_wired`
//! - `net_wireless` (as a progression)
//! - `net_up`
//! - `net_down`
use super::prelude::*;
use crate::netlink::NetDevice;
use crate::util;
use itertools::Itertools;
use regex::Regex;
use std::time::Instant;
#[derive(Deserialize, Debug, SmartDefault)]
#[serde(deny_unknown_fields, default)]
pub struct Config {
pub device: Option<String>,
#[default(2.into())]
pub interval: Seconds,
pub format: FormatConfig,
pub format_alt: Option<FormatConfig>,
pub inactive_format: FormatConfig,
pub missing_format: FormatConfig,
}
pub async fn run(config: &Config, api: &CommonApi) -> Result<()> {
let mut actions = api.get_actions()?;
api.set_default_actions(&[(MouseButton::Left, None, "toggle_format")])?;
let mut format = config.format.with_default(
" $icon ^icon_net_down $speed_down.eng(prefix:K) ^icon_net_up $speed_up.eng(prefix:K) ",
)?;
let missing_format = config.missing_format.with_default(" × ")?;
let inactive_format = config.inactive_format.with_default(" $icon Down ")?;
let mut format_alt = match &config.format_alt {
Some(f) => Some(f.with_default("")?),
None => None,
};
let mut timer = config.interval.timer();
let device_re = config
.device
.as_deref()
.map(Regex::new)
.transpose()
.error("Failed to parse device regex")?;
// Stats
let mut stats = None;
let mut stats_timer = Instant::now();
let mut tx_hist = [0f64; 8];
let mut rx_hist = [0f64; 8];
loop {
match NetDevice::new(device_re.as_ref()).await? {
None => {
api.set_widget(Widget::new().with_format(missing_format.clone()))?;
}
Some(device) => {
let mut widget = Widget::new();
if device.is_up() {
widget.set_format(format.clone());
} else {
widget.set_format(inactive_format.clone());
}
let mut speed_down: f64 = 0.0;
let mut speed_up: f64 = 0.0;
// Calculate speed
match (stats, device.iface.stats) {
// No previous stats available
(None, new_stats) => stats = new_stats,
// No new stats available
(Some(_), None) => stats = None,
// All stats available
(Some(old_stats), Some(new_stats)) => {
let diff = new_stats - old_stats;
let elapsed = stats_timer.elapsed().as_secs_f64();
stats_timer = Instant::now();
speed_down = diff.rx_bytes as f64 / elapsed;
speed_up = diff.tx_bytes as f64 / elapsed;
stats = Some(new_stats);
}
}
push_to_hist(&mut rx_hist, speed_down);
push_to_hist(&mut tx_hist, speed_up);
let icon = if let Some(signal) = device.signal() {
Value::icon_progression(device.icon, signal / 100.0)
} else {
Value::icon(device.icon)
};
widget.set_values(map! {
"icon" => icon,
"speed_down" => Value::bytes(speed_down),
"speed_up" => Value::bytes(speed_up),
"graph_down" => Value::text(util::format_bar_graph(&rx_hist)),
"graph_up" => Value::text(util::format_bar_graph(&tx_hist)),
[if let Some(v) = device.ip] "ip" => Value::text(v.to_string()),
[if let Some(v) = device.ipv6] "ipv6" => Value::text(v.to_string()),
[if let Some(v) = device.ssid()] "ssid" => Value::text(v),
[if let Some(v) = device.frequency()] "frequency" => Value::hertz(v),
[if let Some(v) = device.bitrate()] "bitrate" => Value::bits(v),
[if let Some(v) = device.signal()] "signal_strength" => Value::percents(v),
[if !device.nameservers.is_empty()] "nameserver" => Value::text(
device
.nameservers
.into_iter()
.map(|s| s.to_string())
.join(" "),
),
"device" => Value::text(device.iface.name),
});
api.set_widget(widget)?;
}
}
loop {
select! {
_ = timer.tick() => break,
_ = api.wait_for_update_request() => break,
Some(action) = actions.recv() => match action.as_ref() {
"toggle_format" => {
if let Some(format_alt) = &mut format_alt {
std::mem::swap(format_alt, &mut format);
break;
}
}
_ => ()
}
}
}
}
}
fn push_to_hist<T>(hist: &mut [T], elem: T) {
hist[0] = elem;
hist.rotate_left(1);
}
#[cfg(test)]
mod tests {
use super::push_to_hist;
#[test]
fn test_push_to_hist() {
let mut hist = [0; 4];
assert_eq!(&hist, &[0, 0, 0, 0]);
push_to_hist(&mut hist, 1);
assert_eq!(&hist, &[0, 0, 0, 1]);
push_to_hist(&mut hist, 3);
assert_eq!(&hist, &[0, 0, 1, 3]);
push_to_hist(&mut hist, 0);
assert_eq!(&hist, &[0, 1, 3, 0]);
push_to_hist(&mut hist, 10);
assert_eq!(&hist, &[1, 3, 0, 10]);
push_to_hist(&mut hist, 2);
assert_eq!(&hist, &[3, 0, 10, 2]);
}
}