Provided by: yambar_1.11.0-1_amd64 
NAME
cpu - This module provides the CPU usage
DESCRIPTION
This module reports CPU usage, in percent. The content particle is a template that is instantiated once
for each core, and once for the total CPU usage.
TAGS
┌──────┬───────┬────────────────────────────────────────────────────────────────────────────────────────┐
│ Name │ Type │ Description │
├──────┼───────┼────────────────────────────────────────────────────────────────────────────────────────┤
│ id │ int │ Core ID. 0..n represents individual cores, and -1 represents the total usage │
├──────┼───────┼────────────────────────────────────────────────────────────────────────────────────────┤
│ cpu │ range │ Current usage of CPU core {id}, in percent │
└──────┴───────┴────────────────────────────────────────────────────────────────────────────────────────┘
CONFIGURATION
┌───────────────┬──────┬─────┬──────────────────────────────────────────────────────────────────────────┐
│ Name │ Type │ Req │ Description │
├───────────────┼──────┼─────┼──────────────────────────────────────────────────────────────────────────┤
│ poll-interval │ int │ no │ Refresh interval of the CPU usage stats in milliseconds (default=500). │
│ │ │ │ Cannot be less then 250ms. │
└───────────────┴──────┴─────┴──────────────────────────────────────────────────────────────────────────┘
EXAMPLES
Display total CPU usage as a number
bar:
left:
- cpu:
poll-interval: 2500
content:
map:
conditions:
id < 0:
- string: {text: , font: Font Awesome 6 Free:style=solid}
- string: {text: "{cpu}%"}
Display a vertical bar for each core
bar:
left:
- cpu:
poll-interval: 2500
content:
map:
conditions:
id >= 0:
- ramp:
tag: cpu
items:
- string: {text: ▁}
- string: {text: ▂}
- string: {text: ▃}
- string: {text: ▄}
- string: {text: ▅}
- string: {text: ▆}
- string: {text: ▇}
- string: {text: █}
SEE ALSO
yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decorations(5)
2024-04-20 yambar-modules-cpu(5)