Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doums/baru
A simple system monitor for WM statusbar
https://github.com/doums/baru
archlinux bar baru dwm lemonbar linux monitor nerd-fonts rust status-bar statusbar system-monitor window-manager wm xmobar xmonad
Last synced: 1 day ago
JSON representation
A simple system monitor for WM statusbar
- Host: GitHub
- URL: https://github.com/doums/baru
- Owner: doums
- Created: 2020-04-20T00:25:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-29T20:16:22.000Z (3 months ago)
- Last Synced: 2024-08-29T22:38:34.342Z (3 months ago)
- Topics: archlinux, bar, baru, dwm, lemonbar, linux, monitor, nerd-fonts, rust, status-bar, statusbar, system-monitor, window-manager, wm, xmobar, xmonad
- Language: Rust
- Homepage:
- Size: 2 MB
- Stars: 131
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/doums/baru/actions?query=workflow%3ATest)
[](https://aur.archlinux.org/packages/baru/)
## baru
A simple system monitor for WM statusbar
Baru is a lightweight system monitor for WM status-bar.\
It can be used as a provider with any status-bar that can read from `stdout`.\
Like [xmobar](https://codeberg.org/xmobar/xmobar),
[lemonbar](https://github.com/LemonBoy/bar),
[dwm](https://dwm.suckless.org/status_monitor/) etc…
---
[features](#features) ∎ [prerequisite](#prerequisite) ∎ [install](#install) ∎ [configuration](#configuration) ∎ [usage](#usage) ∎ [credits](#credits) ∎ [license](#license)
### Features
* date and time
* battery (level, status, design level based)
* wireless (state, essid, signal strength)
* wired (state)
* audio sink and source (level, muted)
* brightness
* cpu usage, frequency and temperature
* memory (percent or used/total in gigabyte/gibibyte)
* weather current condition and
temperature ([OpenWeatherMap](https://openweathermap.org/))
* dynamic and customizable labels, play nicely with icons and [nerd-fonts](https://www.nerdfonts.com/)
* customizable format output
* configuration in YAML
### Prerequisite
The following system libraries are required:
- libnl (for wired and wireless modules)
- libpulse (for sound and mic modules)
### Install
- Arch Linux (AUR) [package](https://aur.archlinux.org/packages/baru)
- latest [release](https://github.com/doums/baru/releases)
### Configuration
The binary looks for the config file `baru.yaml` located
in `$XDG_CONFIG_HOME/baru/` (default to `$HOME/.config/baru/`).\
If the config file is not found, baru prints an error and exits.
You can find the full config details [here](https://github.com/doums/baru/blob/master/baru.yaml).
TIPS: To test and debug your config run baru from the terminal like this:
```shell
RUST_LOG=debug baru -l stdout
```
Use the root `format` option to customize baru output.\
You can pick which modules you want to display. Using the special markup `%x`
where `x` is the letter of the module.
These markups are replaced by the output of the corresponding modules.
Modules available:
- `a` battery
- `b` brightness
- `c` cpu usage
- `d` datetime
- `e` wired
- `f` cpu frequency
- `m` memory
- `i` mic
- `r` weather
- `s` sound
- `t` temperature
- `w` wireless
Module output:\
Each module takes a `format` option.\
`%l` and `%v` are respectively the label and the current value of the module.
#### Config example
```yaml
format: '%m %f %c %t %b %i %s %w%e %a %d'
tick: 50
# modules configuration
battery:
full_design: true
low_level: 30
full_label: '*'
charging_label: '^'
discharging_label: 'b'
low_label: '!'
unknown_label: '?'
format: '%l %v' # display label and value
brightness:
label: 'l'
format: '%l %v'
cpu_usage:
label: 'c'
high_label: '!'
format: '%v %l'
cpu_freq:
tick: 100
high_level: 60
label: 'f'
high_label: '!'
format: '%v %l'
memory:
label: 'm'
high_label: '!'
format: '%v %l'
mic:
label: 'i'
mute_label: '.'
format: '%v %l'
sound:
label: 's'
mute_label: '.'
format: '%v %l'
temperature:
core_inputs: 2..5
label: 't'
high_label: '!'
format: '%v %l'
wired:
discrete: true
label: 'e'
disconnected_label: '\'
format: '%l' # display label only
wireless:
interface: wlan0
display: Essid
max_essid_len: 5
label: 'w'
disconnected_label: '\'
format: '%v %l'
weather:
tick: 300 # seconds
# your openweathermap api key
api_key: 1234567890
location: 'Metz'
unit: metric
icons:
clear_sky: [ '', '' ] # day, night
partly_cloudy: [ '', '' ]
cloudy: ''
very_cloudy: ''
shower_rain: ''
rain: ''
thunderstorm: ''
snow: ''
mist: ''
format: '%v'
```
### Usage
```shell
baru -h
```
When spawning baru from your WM/status-bar you can pass the `-l file` flag\
if you want baru to log into a file (useful for debugging).\
Logs are written to the directory `$XDG_CACHE_HOME/baru/` (default
to `$HOME/.cache/baru/`).
```shell
baru -l file
```
### Implementation details
Baru gathers the information from `/sys` and `/proc` filesystems (filled by the
kernel).\
Except audio and network modules which use C libraries.\
All modules are threaded and loaded on-demand.\
Thanks to this modular design (as well Rust and C), baru is lightweight and
efficient.\
It can run at high refresh rate with a minimal cpu footprint.
The audio module communicates with
the [PipeWire](https://pipewire.org/)/[PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/)\
server
through [client API](https://freedesktop.org/software/pulseaudio/doxygen/) to
retrieve its data. Wireless and wired\
modules use the netlink interface with the help
of [libnl](https://www.infradead.org/~tgr/libnl/) to talk directly\
to kernel and retrieve their data.\
In addition, wireless module uses
the [802.11](https://github.com/torvalds/linux/blob/master/include/uapi/linux/nl80211.h)
API.
### Dev
#### Prerequisites
- [Rust](https://www.rust-lang.org/tools/install)
- CMake
- libnl and libpulse present on the system
```shell
RUST_LOG=trace cargo run -- -l stdout
```
### Credits
Clément Dommerc for providing me with the C code for the lib `netlink`, wireless
part.
### License
Mozilla Public License 2.0