diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md index 90cbc0d..5b7d464 100644 --- a/docs/_Sidebar.md +++ b/docs/_Sidebar.md @@ -17,6 +17,6 @@ - [Launcher](launcher) - [MPD](mpd) - [Script](script) -- [Sys-info](sys-info) +- [Sys_Info](sys-info) - [Tray](tray) - [Workspaces](workspaces) \ No newline at end of file diff --git a/docs/Sys-Info.md b/docs/modules/Sys-Info.md similarity index 65% rename from docs/Sys-Info.md rename to docs/modules/Sys-Info.md index dca0d7b..10e3588 100644 --- a/docs/Sys-Info.md +++ b/docs/modules/Sys-Info.md @@ -8,7 +8,7 @@ Pango markup is supported. ## Configuration -> Type: `sys-info` +> Type: `sys_info` | Name | Type | Default | Description | |--------------------|--------------------|---------|--------------------------------------------------------------------------------------------------------------------------------| @@ -28,12 +28,12 @@ Pango markup is supported. "end": [ { "format": [ - " {cpu-percent}% | {temp-c:k10temp-Tccd1}°C", - " {memory-used} / {memory-total} GB ({memory-percent}%)", - "| {swap-used} / {swap-total} GB ({swap-percent}%)", - " {disk-used:/} / {disk-total:/} GB ({disk-percent:/}%)", - "李 {net-down:enp39s0} / {net-up:enp39s0} Mbps", - "猪 {load-average:1} | {load-average:5} | {load-average:15}", + " {cpu_percent}% | {temp_c:k10temp_Tccd1}°C", + " {memory_used} / {memory_total} GB ({memory_percent}%)", + "| {swap_used} / {swap_total} GB ({swap_percent}%)", + " {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)", + "李 {net_down:enp39s0} / {net_up:enp39s0} Mbps", + "猪 {load_average:1} | {load_average:5} | {load_average:15}", " {uptime}" ], "interval": { @@ -43,7 +43,7 @@ Pango markup is supported. "networks": 3, "temps": 5 }, - "type": "sys-info" + "type": "sys_info" } ] } @@ -56,14 +56,14 @@ Pango markup is supported. ```toml [[end]] -type = 'sys-info' +type = 'sys_info' format = [ - ' {cpu-percent}% | {temp-c:k10temp-Tccd1}°C', - ' {memory-used} / {memory-total} GB ({memory-percent}%)', - '| {swap-used} / {swap-total} GB ({swap-percent}%)', - ' {disk-used:/} / {disk-total:/} GB ({disk-percent:/}%)', - '李 {net-down:enp39s0} / {net-up:enp39s0} Mbps', - '猪 {load-average:1} | {load-average:5} | {load-average:15}', + ' {cpu_percent}% | {temp_c:k10temp_Tccd1}°C', + ' {memory_used} / {memory_total} GB ({memory_percent}%)', + '| {swap_used} / {swap_total} GB ({swap_percent}%)', + ' {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)', + '李 {net_down:enp39s0} / {net_up:enp39s0} Mbps', + '猪 {load_average:1} | {load_average:5} | {load_average:15}', ' {uptime}', ] @@ -85,20 +85,20 @@ temps = 5 ```yaml end: - format: - -  {cpu-percent}% | {temp-c:k10temp-Tccd1}°C - -  {memory-used} / {memory-total} GB ({memory-percent}%) - - '| {swap-used} / {swap-total} GB ({swap-percent}%)' - -  {disk-used:/} / {disk-total:/} GB ({disk-percent:/}%) - - 李 {net-down:enp39s0} / {net-up:enp39s0} Mbps - - 猪 {load-average:1} | {load-average:5} | {load-average:15} - -  {uptime} + - ' {cpu_percent}% | {temp_c:k10temp_Tccd1}°C' + - ' {memory_used} / {memory_total} GB ({memory_percent}%)' + - '| {swap_used} / {swap_total} GB ({swap_percent}%)' + - ' {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)' + - '李 {net_down:enp39s0} / {net_up:enp39s0} Mbps' + - '猪 {load_average:1} | {load_average:5} | {load_average:15}' + - ' {uptime}' interval: cpu: 1 disks: 300 memory: 30 networks: 3 temps: 5 - type: sys-info + type: sys_info ``` @@ -110,7 +110,7 @@ end: { end = [ { - type = "sys-info" + type = "sys_info" interval.memory = 30 interval.cpu = 1 @@ -119,12 +119,12 @@ end: interval.networks = 3 format = [ - " {cpu-percent}% | {temp-c:k10temp-Tccd1}°C" - " {memory-used} / {memory-total} GB ({memory-percent}%)" - "| {swap-used} / {swap-total} GB ({swap-percent}%)" - " {disk-used:/} / {disk-total:/} GB ({disk-percent:/}%)" - "李 {net-down:enp39s0} / {net-up:enp39s0} Mbps" - "猪 {load-average:1} | {load-average:5} | {load-average:15}" + " {cpu_percent}% | {temp_c:k10temp_Tccd1}°C" + " {memory_used} / {memory_total} GB ({memory_percent}%)" + "| {swap_used} / {swap_total} GB ({swap_percent}%)" + " {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)" + "李 {net_down:enp39s0} / {net_up:enp39s0} Mbps" + "猪 {load_average:1} | {load_average:5} | {load_average:15}" " {uptime}" ] } @@ -141,31 +141,31 @@ The following tokens can be used in the `format` configuration option: | Token | Description | |--------------------------|------------------------------------------------------------------------------------| | **CPU** | | -| `{cpu-percent}` | Total CPU utilisation percentage | +| `{cpu_percent}` | Total CPU utilisation percentage | | **Memory** | | -| `{memory-free}` | Memory free in GB. | -| `{memory-used}` | Memory used in GB. | -| `{memory-total}` | Memory total in GB. | -| `{memory-percent}` | Memory utilisation percentage. | -| `{swap-free}` | Swap free in GB. | -| `{swap-used}` | Swap used in GB. | -| `{swap-total}` | Swap total in GB. | -| `{swap-percent}` | Swap utilisation percentage. | +| `{memory_free}` | Memory free in GB. | +| `{memory_used}` | Memory used in GB. | +| `{memory_total}` | Memory total in GB. | +| `{memory_percent}` | Memory utilisation percentage. | +| `{swap_free}` | Swap free in GB. | +| `{swap_used}` | Swap used in GB. | +| `{swap_total}` | Swap total in GB. | +| `{swap_percent}` | Swap utilisation percentage. | | **Temperature** | | -| `{temp-c:[sensor]}` | Temperature in degrees C. Replace `[sensor]` with the sensor label. | -| `{temp-f:[sensor]}` | Temperature in degrees F. Replace `[sensor]` with the sensor label. | +| `{temp_c:[sensor]}` | Temperature in degrees C. Replace `[sensor]` with the sensor label. | +| `{temp_f:[sensor]}` | Temperature in degrees F. Replace `[sensor]` with the sensor label. | | **Disk** | | -| `{disk-free:[mount]}` | Disk free space in GB. Replace `[mount]` with the disk mountpoint. | -| `{disk-used:[mount]}` | Disk used space in GB. Replace `[mount]` with the disk mountpoint. | -| `{disk-total:[mount]}` | Disk total space in GB. Replace `[mount]` with the disk mountpoint. | -| `{disk-percent:[mount]}` | Disk utilisation percentage. Replace `[mount]` with the disk mountpoint. | +| `{disk_free:[mount]}` | Disk free space in GB. Replace `[mount]` with the disk mountpoint. | +| `{disk_used:[mount]}` | Disk used space in GB. Replace `[mount]` with the disk mountpoint. | +| `{disk_total:[mount]}` | Disk total space in GB. Replace `[mount]` with the disk mountpoint. | +| `{disk_percent:[mount]}` | Disk utilisation percentage. Replace `[mount]` with the disk mountpoint. | | **Network** | | -| `{net-down:[adapter]}` | Average network download speed in Mbps. Replace `[adapter]` with the adapter name. | -| `{net-up:[adapter]}` | Average network upload speed in Mbps. Replace `[adapter]` with the adapter name. | +| `{net_down:[adapter]}` | Average network download speed in Mbps. Replace `[adapter]` with the adapter name. | +| `{net_up:[adapter]}` | Average network upload speed in Mbps. Replace `[adapter]` with the adapter name. | | **System** | | -| `{load-average:1}` | 1-minute load average. | -| `{load-average:5}` | 5-minute load average. | -| `{load-average:15}` | 15-minute load average. | +| `{load_average:1}` | 1-minute load average. | +| `{load_average:5}` | 5-minute load average. | +| `{load_average:15}` | 15-minute load average. | | `{uptime}` | System uptime formatted as `HH:mm`. | ## Styling diff --git a/src/modules/sysinfo.rs b/src/modules/sysinfo.rs index e2581f5..b15531a 100644 --- a/src/modules/sysinfo.rs +++ b/src/modules/sysinfo.rs @@ -293,19 +293,19 @@ fn refresh_memory_tokens(format_info: &mut HashMap, sys: &mut Sy let memory_percent = actual_used_memory as f64 / total_memory as f64 * 100.0; format_info.insert( - String::from("memory-free"), + String::from("memory_free"), (bytes_to_gigabytes(available_memory)).to_string(), ); format_info.insert( - String::from("memory-used"), + String::from("memory_used"), (bytes_to_gigabytes(actual_used_memory)).to_string(), ); format_info.insert( - String::from("memory-total"), + String::from("memory_total"), (bytes_to_gigabytes(total_memory)).to_string(), ); format_info.insert( - String::from("memory-percent"), + String::from("memory_percent"), format!("{:0>2.0}", memory_percent), ); @@ -313,19 +313,19 @@ fn refresh_memory_tokens(format_info: &mut HashMap, sys: &mut Sy let total_swap = sys.total_swap(); format_info.insert( - String::from("swap-free"), + String::from("swap_free"), (bytes_to_gigabytes(sys.free_swap())).to_string(), ); format_info.insert( - String::from("swap-used"), + String::from("swap_used"), (bytes_to_gigabytes(used_swap)).to_string(), ); format_info.insert( - String::from("swap-total"), + String::from("swap_total"), (bytes_to_gigabytes(total_swap)).to_string(), ); format_info.insert( - String::from("swap-percent"), + String::from("swap_percent"), format!("{:0>2.0}", used_swap as f64 / total_swap as f64 * 100.0), ); } @@ -337,7 +337,7 @@ fn refresh_cpu_tokens(format_info: &mut HashMap, sys: &mut Syste let cpu_percent = cpu_info.cpu_usage(); format_info.insert( - String::from("cpu-percent"), + String::from("cpu_percent"), format!("{:0>2.0}", cpu_percent), ); } @@ -350,8 +350,8 @@ fn refresh_temp_tokens(format_info: &mut HashMap, sys: &mut Syst let key = component.label().replace(' ', "-"); let temp = component.temperature(); - format_info.insert(format!("temp-c:{key}"), format!("{temp:.0}")); - format_info.insert(format!("temp-f:{key}"), format!("{:.0}", c_to_f(temp))); + format_info.insert(format!("temp_c:{key}"), format!("{temp:.0}")); + format_info.insert(format!("temp_f:{key}"), format!("{:.0}", c_to_f(temp))); } } @@ -371,22 +371,22 @@ fn refresh_disk_tokens(format_info: &mut HashMap, sys: &mut Syst let used = total - available; format_info.insert( - format!("disk-free:{key}"), + format!("disk_free:{key}"), bytes_to_gigabytes(available).to_string(), ); format_info.insert( - format!("disk-used:{key}"), + format!("disk_used:{key}"), bytes_to_gigabytes(used).to_string(), ); format_info.insert( - format!("disk-total:{key}"), + format!("disk_total:{key}"), bytes_to_gigabytes(total).to_string(), ); format_info.insert( - format!("disk-percent:{key}"), + format!("disk_percent:{key}"), format!("{:0>2.0}", used as f64 / total as f64 * 100.0), ); } @@ -402,12 +402,12 @@ fn refresh_network_tokens( for (iface, network) in sys.networks() { format_info.insert( - format!("net-down:{iface}"), + format!("net_down:{iface}"), format!("{:0>2.0}", bytes_to_megabits(network.received()) / interval), ); format_info.insert( - format!("net-up:{iface}"), + format!("net_up:{iface}"), format!( "{:0>2.0}", bytes_to_megabits(network.transmitted()) / interval @@ -420,15 +420,15 @@ fn refresh_system_tokens(format_info: &mut HashMap, sys: &System // no refresh required for these tokens let load_average = sys.load_average(); - format_info.insert(String::from("load-average:1"), load_average.one.to_string()); + format_info.insert(String::from("load_average:1"), load_average.one.to_string()); format_info.insert( - String::from("load-average:5"), + String::from("load_average:5"), load_average.five.to_string(), ); format_info.insert( - String::from("load-average:15"), + String::from("load_average:15"), load_average.fifteen.to_string(), );