baleia

⚠️ Early work in progress.

Baleia is a command-line tool (and complimentary Telegram bot) to retrieve data about your Raspberry Pi, with implementations in C++11 or Go. Although made to target the RPi, it should run (although lacking vcgencmd-originated data) on any system running GNU/Linux.

Implementations

Both C++11 and Go source codes should produce the exact same logs, with the main difference being the specification format used by the -f, --fmt flag, with very similar performance. The Go binaries in the releases page are statically linked so they'll run even if Go is not installed on your destination system.

Usage

Usage: ./baleia [-c, --cpu] [-f, --file-info] [-u, --user] [-a, --all] [-d, --discard] [-C, --cfg] [--fmt <format-string>]

-h, --help      	Show this message and exit.
-c, --cpu       	Save CPU frequency, temperature and scaling governor.
-u, --user      	Save user and OS data.
-F, --file-info 	Save filename and Baleia version.
-a, --all       	Save all available data.
-d, --discard   	Print to stdout without saving to a file.
-t, --toml      	Saves the output in TOML format.
--fmt <fmt-str> 	Dictate output's filename following the `strftime` format specification.

Output formats

.ini-style format

Easily parsable format, ready for use with TOML or rxi/ini. This format is used when the --cfg flag is set.

An example follows:

./baleia -at
[file-info]
baleia-ver="baleia v.0.1-alpha"
filename="baleia-log-July-10-20-13h36m15s"
[user-info]
username="pi"
hostname="raspberrypi"
distro="Raspbian GNU/Linux 10 (buster)"
kernel="Linux 4.19.118-v7+ armv7l"
uptime="8 hours 18 minutes 52 seconds"
[cpu-info]
cur_freq="600 MHz"
min_freq="600 MHz"
max_freq="1200 MHz"
temperature="39.70 °C"
cpu_gov="ondemand"
cpu_mem="940MB"
gpu_mem="84MB"
core_volt="1.2000V"

Simple, readability-first, output

An example in this format follows:

Version:         	baleia v.0.1-alpha
Filename:        	baleia-log-July-10-20-01h46m53s
Username:        	pi
Hostname:        	raspberrypi
Distro:          	Raspbian GNU/Linux 10 (buster)
Kernel:          	Linux 4.19.118-v7+ armv7l
Uptime:          	51 minutes 46 seconds
Temperature:     	40.24 °C
Cur. CPU freq:   	600 MHz
Min. CPU freq:   	600 MHz
Max. CPU freq:   	1200 MHz
CPU scaling gov.: 	ondemand
CPU memory:      	940MB
GPU memory:      	84MB
Core voltage:    	1.2000V

Build

To build the C++ version:

git clone https://github.com/vrmiguel/baleia.git
cd baleia/baleia-cpp
qmake
make

To build the Go version (through cross-compilation):

git clone https://github.com/vrmiguel/baleia.git
cd baleia/baleia-go
export GOOS=linux
export GOARCH=arm
go build -o baleia-go-arm main.go

Binaries can be found at the releases page.

Internals

If you wish to use this programmatically, you can use the librpidata.cpp/.h files, which provide a RPIData namespace with the methods you'd want to use, when on C++, or the rpidata module when using Go.