hwinfo

The library provides information for various hardware components. Note that some features are marked with ❌ and are currently in development.

To build hwinfo from source, you need git, cmake, and a C++ compiler (gcc, clang, or MSVC). This process builds both static and dynamic libraries. Static library CMake targets are named <target>_static (e.g., hwinfo_static).

git clone https://github.com/lfreist/hwinfo
mkdir build
cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_CONFIGURATION_TYPES=Release
cmake --build build --config Release

If you have installed hwinfo to your system, follow these steps to integrate it into your project:

1. Install hwinfo:

git clone https://github.com/lfreist/hwinfo && cd hwinfo
mkdir build
cmake -B build && cmake --build build
cmake --install build

2. Configure CMakeLists.txt: Use find_package to locate the library:

find_package(hwinfo REQUIRED)

3. Link the library: Link against the lfreist-hwinfo::hwinfo target:

add_executable(your_executable your_executable.cpp)
target_link_libraries(your_executable PUBLIC lfreist-hwinfo::hwinfo)

4. Include the header in your C++ code:

#include <hwinfo/hwinfo.h>

To include hwinfo directly as a submodule within your project:

1. Add the submodule:

mkdir third_party
cd third_party
git clone https://github.com/lfreist/hwinfo

2. Configure your root CMakeLists.txt: Use add_subdirectory to include the submodule. You can define HWINFO_* options before this call to change default values.

# <project-root>/CMakeLists.txt
add_subdirectory(third_party/hwinfo)

3. Link the library:

add_executable(your_executable your_executable.cpp)
target_link_libraries(your_executable PUBLIC lfreist-hwinfo::hwinfo)

4. Include the header in your C++ code:

#include "hwinfo/hwinfo.h"

You can control which hardware components are included in the library by setting the following CMake options. By default, most are set to ON.

# Example of disabling specific components
set(HWINFO_OS OFF CACHE BOOL "")
set(HWINFO_CPU ON CACHE BOOL "")
set(HWINFO_GPU_OPENCL ON CACHE BOOL "")

The following CMake options control component detection during the build process:

HWINFO_OS             - Enable OS detection (default: ON)
HWINFO_MAINBOARD      - Enable mainboard detection (default: ON)
HWINFO_CPU            - Enable CPU detection (default: ON)
HWINFO_DISK           - Enable disk detection (default: ON)
HWINFO_RAM            - Enable RAM detection (default: ON)
HWINFO_GPU            - Enable GPU detection (default: ON)
HWINFO_GPU_OPENCL    - Enable usage of OpenCL in GPU information (default: OFF)
HWINFO_BATTERY        - Enable battery detection (default: ON)

You can link against the full library or specific component targets to reduce dependencies.

# Link everything
target_link_libraries(your_target PRIVATE hwinfo::hwinfo)

# Link specific components
target_link_libraries(
  your_target
  PRIVATE hwinfo::cpu
          hwinfo::gpu
          hwinfo::ram
          hwinfo::mainboard
          hwinfo::disk
          hwinfo::os
          hwinfo::battery)