ferrix-lib 0.5.0

A library for obtaining information about the software and hardware of a computer running Linux
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

# ferrix-lib

> **NOTE 1:** visit our [GitHub repository](https://github.com/mskrasnov/fsm) to get more information about this crate.
>
> **NOTE 2:** this crate is a part of [ferrix-app](https://crates.io/crates/ferrix-app) crate.

Crate to get information about PC's hardware and software. Only for Linux. Some features are requires `d-bus` and `systemd`. This crate can get information about:

- CPU (`/proc/cpuinfo`);
- RAM (`/proc/meminfo`) and swaps (`/proc/swaps`);
- Linux kernel information (version, architecture, cmdline);
- Kernel modules list;
- Users and groups;
- Environment variables for current user;
- `systemd` services;
- Infrormation from DMI tables (BIOS, motherboard, chassis/enclosure, processor, RAM);
- Information from EDID (basic info);
- Supported resolutions for monitor;
- Hardware resources;
- UEFI Settings;
- Mounted partitions;
- Installed software (`deb`, `rpm` packages);
- Network statistics (RX/TX Bytes, Packets, Errors, Drops);
- Command interpreter (name, version, path);
- Desktop environment name and version;
- Notebook battery;

TODO:

- [X] Get more info from EDID (done in `v0.5.0`);
- [ ] Get information about installed software (`flatpak`, `deb`, `rpm`);
- [X] Get information about notebook battery;
- [ ] Get information about audio;
- [ ] Get information about GUI (desktop environment, session type (Wayland or X.org), etc.);
- [ ] Backup and reset `gsettings` settins;

At this time, the API is stable, and changes between versions are very minor. All changes are made primarily to further the development of the FSM project (adding new data sources).

## Features

Now, `ferrix-lib` has a modular structure in which each module depends on a specific enabled feature. Since `ferrix-lib` is part of the [FSM](https://mskrasnov.github.io/fsm/) project by default, all features are enabled by default (`features.default`).

Features list:

- `battery`;
- `cpu`;
- `cpu_freq`;
- `desktop`;
- `dmi`;
- `drm`;
- `firmware`;
- `init` (DBus is needed);
- `mem`;
- `net`;
- `parts` (`glibc` is needed);
- `resources`;
- `soft`;
- `sys`;
- `vulnerabilities`;

Using `ferrix-lib` with specific features:

```bash
cargo add ferrix-lib    \
  --no-default-features \
  --features=feature1,feature2,...,featuren
```

## Changelog

### v0.5.0

- EDID parser update:
  - Add `description`, `serial`, `model`, `diagonal`, `resolution, max`, `aspect ratio`, `pixel clock, MHz`, `extension blocks count`, `checksum` fields;
  - New EDID blocks parsing: DTD block, range limits;
- Update docs for `battery`, `parts`, `drm`, `init`, `firmware`, `desktop`, `cpu_freq` modules;

## License

`ferrix-lib` is distributed under the GNU GPL v3 license.