https://github.com/jfjlaros/status
Status scripts for i3blocks.
https://github.com/jfjlaros/status
bar i3 i3blocks status
Last synced: about 1 month ago
JSON representation
Status scripts for i3blocks.
- Host: GitHub
- URL: https://github.com/jfjlaros/status
- Owner: jfjlaros
- License: mit
- Created: 2017-01-22T18:43:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-10-22T12:44:05.000Z (almost 5 years ago)
- Last Synced: 2025-03-01T18:47:08.919Z (over 1 year ago)
- Topics: bar, i3, i3blocks, status
- Language: Shell
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Status scripts for i3blocks
Various status monitoring scrips using a common library.
## Installation
Make sure to install [Font Awesome](http://fontawesome.io/) for the icons to
render correctly.
Get the repository (as root) and install it in the i3blocks directory.
git clone git://github.com/jfjlaros/status.git /usr/share/i3blocks/status
To configure your i3blocks behaviour, edit `~/.config/i3blocks/config`. Please
have a look at this [sample configuration file](i3blocks_config.sample). The
result will look something like this:
## API
To use the library, simply source the library file from your script.
```bash
. "/usr/share/i3blocks/status/lib/status.bash"
```
This imports a number of functions and a wrapper function `format_info`.
### Functions
The `scale` function is used to convert a value, given a minimum and a maximum,
to a percentage. For example, to convert the value 120 in the range 40 to 1000,
to a percentage:
```bash
$ scale 120 40 1000
8
```
The `pick_colour` function is used to convert a percentage to an RGB value
ranging from green to red. For example:
```bash
$ pick_colour 35
#b2ff00
```
The `pick_icon` function is used to convert a percentage to an icon. For
example:
```bash
$ pick_icon 21 ABCDE
B
```
The `set_timer` function records the current time. This can later be used to
see how much time has passed.
```bash
$ set_timer
$ cat /run/user/${UID}/i3/bash_timer.dat
1485202697
```
The `get_timer` function checks whether a certain amount of time has passed. It
returns 1 if the timer is still running, otherwise it will remove the recorded
time and return 0.
```bash
$ set_timer
$ if get_timer 5; then echo not done yet; fi
not done yet
$ sleep 6
$ if get_timer 5; then echo not done yet; fi
```
The `key_command` function execute a command when a button is pressed, e.g.,
```bash
$ BLOCK_BUTTON="3"
$ key_command 3 set_timer
$ cat /run/user/${UID}/i3/bash_timer.dat
1485626146
```
The `key_launch` function launches or kills an application when a button is
pressed. The following example will launch `wicd-client -n`, or, if the
application is already running, will kill the running instance.
```bash
$ BLOCK_BUTTON="1"
$ key_command 1 wicd-client -n
```
the `parse_args` function assigns each word in the `BLOCK_INSTANCE` variable to
a variable.
```bash
$ BLOCK_INSTANCE="10 wlan0"
$ parse_args 10 dev
$ echo ${dev}
wlan0
```
### Wrapper function
Finally, the wrapper function named `format_info` will pick a colour and an
icon based on a value and it will echo some additional info back. For simple
status scripts, this function is probably all that is needed. A simple example
will look like this:
```bash
$ format_info ABCDE 21 "status text"
B status text
#6bff00
```
This function also accepts the following optional arguments:
- `invert` (default false) inverts the colour.
- `minimum` (default 0) and `maximum` (default 100) for converting to a
percentage.
A more complicated example, where we want to show a value between 10 and 30 and
we want the colour to go from red to green:
```bash
$ format_info ABCDE 21 "status text" true 10 30
C status text
#e5ff00
```