Added memory support

luca-vogels · luca-vogels · commit a3b2737ced35 · 2025-08-05T11:10:25.000+02:00
diff --git a/README.md b/README.md
@@ -66,18 +66,22 @@ Drives: [
         mount: 'C:',
         type: 'ntfs',
         total: 1999519543296,
-        free: 479322533888,
-        used: 1520197009408,
-        utilization: 0.7602811457907099
+        utilization: {
+            free: 470568960000,
+            used: 1528950583296,
+            percentage: 0.7646589844156682
+        }
     },
     {
         filesystem: 'D:',
         mount: 'D:',
         type: 'ntfs',
         total: 1000203087872,
-        free: 917103894528,
-        used: 83099193344,
-        utilization: 0.08308232033236287
+        utilization: {
+            free: 917100240896,
+            used: 83102846976,
+            percentage: 0.08308597322250519
+        }
     }
 ]
 GPU Info: [
@@ -91,11 +95,13 @@ GPU Info: [
         driverVersion: '32.0.15.7652',
         displayAttached: true,
         displayActive: true,
-        fanSpeed: 0.53,
-        utilization: 0.03,
-        memoryUtilization: 0.01,
-        temperature: 52,
-        powerDraw: 48.32
+        utilization: {
+            fanSpeed: 0.56,
+            processing: 0.01,
+            memory: 0,
+            temperature: 51,
+            powerDraw: 46.65
+        }
     }
 ]
 Network Interfaces: [
@@ -138,4 +144,7 @@ Temperatures: {
 
 ### GPU Readings
 For more detailed information on GPUs it is recommended to 
-install the [nvidia-smi](https://developer.nvidia.com/nvidia-system-management-interface) tool.
+install the [nvidia-smi](https://developer.nvidia.com/nvidia-system-management-interface) tool.
+
+### Docker
+For [Docker](https://www.docker.com/) support, ensure that the Docker daemon is running and accessible.
diff --git a/TODO.txt b/TODO.txt
@@ -1 +1,2 @@
 memory.ts
+ - Keep 'SMBIOSMemoryType' mapping up to date
diff --git a/src/__tests__/Memory.test.ts b/src/__tests__/Memory.test.ts
@@ -0,0 +1,6 @@
+import { getMemory } from '../memory';
+
+test('getMemory', async () => {
+  const memory = await getMemory();
+  console.log(memory); // TODO REMOVE
+});
diff --git a/src/docker.ts b/src/docker.ts
@@ -0,0 +1,3 @@
+export type DockerContainer = {
+
+};
diff --git a/src/drive.ts b/src/drive.ts
@@ -6,6 +6,19 @@ const VIRTUAL_DRIVE_TYPES = [
   'overlay', // Overlay filesystem
 ];
 
+export type DriveUtilization = {
+
+  /** The total amount of unused drive space in bytes. */
+  free: number;
+
+  /** The amount of drive space used in bytes. */
+  used: number;
+
+  /** The current drive utilization as a percentage (0-1). */
+  percentage: number;
+};
+
+
 export type DriveInfo = {
   /** The device name of the drive (e.g., /dev/sda1) */
   filesystem: string;
@@ -16,19 +29,14 @@ export type DriveInfo = {
   /** The filesystem type (e.g., ext4, ntfs) */
   type: 'btrfs' | 'devtmpfs' | 'ext4' | 'ntfs' | 'overlay' | 'tmpfs' | 'vfat' | 'xfs' | string;
 
-  /** The total amount of unused drive space in bytes. */
-  free: number;
-
-  /** The amount of drive space used in bytes. */
-  used: number;
-
   /** The total size of the drive in bytes. */
   total: number;
 
-  /** The current drive utilization as a percentage (0-1). */
-  utilization: number;
+  /** Usage of the drive. */
+  utilization: DriveUtilization;
 };
 
+
 /**
  * Returns information about the drives on the system (in Windows the logical drives are returned).
  *
@@ -56,10 +64,12 @@ export async function getDrives(includeVirtual: boolean = false): Promise<DriveI
           filesystem: parts[0] as string,
           type,
           total,
-          used,
-          free: parseInt(parts[4], 10) || 0,
-          utilization: total !== 0 ? used / total : 0,
           mount: (parts[6] || parts[0]) as string,
+          utilization: {
+            used,
+            free: parseInt(parts[4], 10) || 0,
+            percentage: total !== 0 ? used / total : 0,
+          }
         });
       }
       break;
@@ -78,9 +88,11 @@ export async function getDrives(includeVirtual: boolean = false): Promise<DriveI
           mount: drive.VolumeName || drive.Caption,
           type: (drive.FileSystem || 'unknown').toLowerCase(),
           total,
-          free,
-          used: total - free,
-          utilization: total !== 0 ? (total - free) / total : 0,
+          utilization: {
+            free,
+            used: total - free,
+            percentage: total !== 0 ? (total - free) / total : 0,
+          }
         });
       }
       break;
diff --git a/src/gpu.ts b/src/gpu.ts
@@ -1,5 +1,27 @@
 import { execCommand } from './utils';
 
+
+export type GPUUtilization = {
+  /** GPU memory utilization as a percentage (0.0-1.0). */
+  memory?: number;
+
+  /** GPU memory temperature in Celsius. */
+  memoryTemperature?: number;
+
+  /** GPU processing utilization as a percentage (0.0-1.0). */
+  processing?: number;
+
+  /** GPU temperature in Celsius. */
+  temperature?: number;
+
+  /** Fan speed in percentage (0.0-1.0). */
+  fanSpeed?: number;
+
+  /** GPU power draw in watts. */
+  powerDraw?: number;
+};
+
+
 export type GPU = {
   /** Unique ID of the GPU device. */
   id: string;
@@ -22,15 +44,6 @@ export type GPU = {
   /** Memory size of the GPU in bytes. */
   memory?: number;
 
-  /** Memory utilization of the GPU in percentage (0.0-1.0) */
-  memoryUtilization?: number;
-
-  /** Temperature of the memory in Celsius. */
-  memoryTemperature?: number;
-
-  /** GPU processing utilization in percentage (0.0-1.0) */
-  utilization?: number;
-
   /** Index of the GPU device. */
   index?: number;
 
@@ -40,14 +53,8 @@ export type GPU = {
   /** If memory is allocated inside the GPU for display purposes. Can be true even if no physical display is attached. */
   displayActive?: boolean;
 
-  /** Fan speed in percentage (0.0-1.0). */
-  fanSpeed?: number;
-
-  /** Temperature of the GPU in Celsius. */
-  temperature?: number;
-
-  /** Power draw of the GPU in watts. */
-  powerDraw?: number;
+  /** Utilization data of the GPU. */
+  utilization?: GPUUtilization;
 };
 
 export async function getGPUs(): Promise<GPU[]> {
@@ -159,17 +166,32 @@ export async function getGPUs(): Promise<GPU[]> {
       }
       if (displayAttached) currGpu.displayAttached = ['yes', 'enabled', '1'].includes(displayAttached.toLowerCase());
       if (displayActive) currGpu.displayActive = ['yes', 'enabled', '1'].includes(displayActive.toLowerCase());
-      if (fanSpeed && !Number.isNaN(parseFloat(fanSpeed))) currGpu.fanSpeed = parseFloat(fanSpeed) / 100;
+      if (fanSpeed && !Number.isNaN(parseFloat(fanSpeed))){
+        if(!currGpu.utilization) currGpu.utilization = {} as GPUUtilization;
+        currGpu.utilization.fanSpeed = parseFloat(fanSpeed) / 100;
+      }
       if (memoryTotal && !Number.isNaN(parseInt(memoryTotal, 10)))
         currGpu.memory = parseInt(memoryTotal, 10) * 1024 * 1024; // convert MiB to bytes
-      if (utilizationGPU && !Number.isNaN(parseFloat(utilizationGPU)))
-        currGpu.utilization = parseFloat(utilizationGPU) / 100;
-      if (utilizationMemory && !Number.isNaN(parseFloat(utilizationMemory)))
-        currGpu.memoryUtilization = parseFloat(utilizationMemory) / 100;
-      if (temperatureGPU && !Number.isNaN(parseFloat(temperatureGPU))) currGpu.temperature = parseFloat(temperatureGPU);
-      if (temperatureMemory && !Number.isNaN(parseFloat(temperatureMemory)))
-        currGpu.memoryTemperature = parseFloat(temperatureMemory);
-      if (powerDraw && !Number.isNaN(parseFloat(powerDraw))) currGpu.powerDraw = parseFloat(powerDraw);
+      if (utilizationGPU && !Number.isNaN(parseFloat(utilizationGPU))){
+        if(!currGpu.utilization) currGpu.utilization = {} as GPUUtilization;
+        currGpu.utilization.processing = parseFloat(utilizationGPU) / 100;
+      }
+      if (utilizationMemory && !Number.isNaN(parseFloat(utilizationMemory))){
+        if(!currGpu.utilization) currGpu.utilization = {} as GPUUtilization;
+        currGpu.utilization.memory = parseFloat(utilizationMemory) / 100;
+      }
+      if (temperatureGPU && !Number.isNaN(parseFloat(temperatureGPU))) {
+        if(!currGpu.utilization) currGpu.utilization = {} as GPUUtilization;
+        currGpu.utilization.temperature = parseFloat(temperatureGPU);
+      }
+      if (temperatureMemory && !Number.isNaN(parseFloat(temperatureMemory))) {
+        if(!currGpu.utilization) currGpu.utilization = {} as GPUUtilization;
+        currGpu.utilization.memoryTemperature = parseFloat(temperatureMemory);
+      }
+      if (powerDraw && !Number.isNaN(parseFloat(powerDraw))) {
+        if(!currGpu.utilization) currGpu.utilization = {} as GPUUtilization;
+        currGpu.utilization.powerDraw = parseFloat(powerDraw);
+      }
       gpus[currIdx] = currGpu;
     }
   }
diff --git a/src/index.ts b/src/index.ts
@@ -1,14 +1,18 @@
 export * from './cpu';
+export * from './docker';
 export * from './drive';
 export * from './gpu';
+export * from './memory';
 export * from './net';
 export * from './os';
 export * from './temperature';
 export * from './utils';
 
 import * as cpu from './cpu';
+import * as docker from './docker';
 import * as drive from './drive';
 import * as gpu from './gpu';
+import * as memory from './memory';
 import * as net from './net';
 import * as os from './os';
 import * as temperatures from './temperature';
@@ -19,8 +23,10 @@ import * as utils from './utils';
  */
 const lupSystem = {
   ...cpu,
+  ...docker,
   ...drive,
   ...gpu,
+  ...memory,
   ...net,
   ...os,
   ...temperatures,
diff --git a/src/memory.ts b/src/memory.ts
diff --git a/src/net.ts b/src/net.ts

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`memory.ts`
	`2`	`+ - Keep 'SMBIOSMemoryType' mapping up to date`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export type DockerContainer = {`
	`2`	`+`
	`3`	`+};`