Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/doums/baru

A system monitor written in Rust and C
https://github.com/doums/baru

archlinux bar baru dwm linux monitor monitoring-systems rust spectrwm status-bar system-monitor window-manager wm wm-bar

Last synced: about 2 months ago
JSON representation

A system monitor written in Rust and C

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: 2023-01-11T23:54:05.000Z (over 1 year ago)
Last Synced: 2024-05-15T13:06:58.091Z (4 months ago)
Topics: archlinux, bar, baru, dwm, linux, monitor, monitoring-systems, rust, spectrwm, status-bar, system-monitor, window-manager, wm, wm-bar
Language: Rust
Homepage:
Size: 1.99 MB
Stars: 129
Watchers: 1
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        [![baru](https://img.shields.io/github/actions/workflow/status/doums/baru/test.yml?color=0D0D0D&logoColor=BFBFBF&labelColor=404040&logo=github&style=for-the-badge)](https://github.com/doums/baru/actions?query=workflow%3ATest)

[![baru](https://img.shields.io/aur/version/baru?color=0D0D0D&logoColor=BFBFBF&labelColor=404040&logo=arch-linux&style=for-the-badge)](https://aur.archlinux.org/packages/baru/)

## baru

A system monitor written in Rust and C.

![baru](https://raw.githubusercontent.com/doums/baru/master/public/baru.png)

- [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)

* dynamic and customizable labels

* customizable format output

* configuration in YAML

Baru gathers the information from `/sys` and `/proc` filesystems (filled by the kernel). Except audio and network modules which use C libraries.\

There is no memory leak over time. All modules are threaded. Thanks to this design (as well Rust and C), baru is lightweight and efficient. It can run at high refresh rate with a minimal processor 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.

Baru is modular. This means that only the modules you want to see are instantiated and executed.

### prerequisite

- libnl (for wired and wireless modules)

- libpulse (for sound and mic modules)

### install

Rust is a language that compiles to native code and by default statically links all dependencies.\

Simply download the latest [release](https://github.com/doums/baru/releases) of the compiled binary and use it (do not forget to make it executable `chmod +x baru`).

For Arch Linux users, baru is present as a [package](https://aur.archlinux.org/packages/baru) in the Arch User Repository.

### 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.\

All options are detailed [here](https://github.com/doums/baru/blob/master/baru.yaml).

Example:

```yaml

format: '%m  %f  %c  %t  %b  %i  %s   %w%e  %a    %d'

tick: 50

battery:

  full_design: true

  low_level: 30

  full_label: '*'

  charging_label: '^'

  discharging_label: 'b'

  low_label: '!'

  unknown_label: '?'

  format: '%l %v'

brightness:

  label: 'l'

  format: '%l %v'

cpu:

  label: 'c'

  high_label: '!'

  format: '%v %l'

cpu_freq:

  tick: 100

  high_level: 60

  label: 'f'

  high_label: '!'

  format: '%v %l'

memory:

  core_inputs: 2..5

  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'

wireless:

  interface: wlan0

  display: Essid

  max_essid_len: 5

  label: 'w'

  disconnected_label: '\'

  format: '%v %l'

```

### usage

```

$ baru

```

### credits

Clément Dommerc for providing me with the C code for the lib `netlink`, wireless part.

### license

Mozilla Public License 2.0