useSystemMonitor

Subscribes to system and hardware information streamed from the Fluxlay desktop app. Useful for building cyberpunk HUDs, system monitor wallpapers, and hardware-reactive visuals.

Import

import { useSystemMonitor } from "@fluxlay/react";

Signature

function useSystemMonitor(options?: SystemMonitorOptions): SystemMonitorInfo;

Parameters

SystemMonitorOptions

Per-category polling intervals in milliseconds. Omitted fields use their default values.

Shorter intervals increase responsiveness but also increase CPU usage. Adjust the balance to suit your wallpaper's needs.

Return Value

CPU

Memory

Battery

Network

Disk

DiskInfo:

System Info

Example

function Wallpaper() {
  const { cpuUsage, memoryUsage, batteryLevel, batteryCharging } = useSystemMonitor({
    cpuIntervalMs: 500,
    memoryIntervalMs: 1000,
    batteryIntervalMs: 10000
  });
 
  // Change background color based on CPU load
  const bg = cpuUsage > 80 ? "#1a0000" : "#000a1a";
 
  return (
    <div style={{ background: bg, color: "white", padding: 32, fontFamily: "monospace" }}>
      <p>CPU: {cpuUsage.toFixed(1)}%</p>
      <p>Memory: {memoryUsage.toFixed(1)}%</p>
      <p>
        Battery: {batteryLevel !== null ? `${batteryLevel.toFixed(0)}%` : "N/A"}
        {batteryCharging ? " ⚡" : ""}
      </p>
    </div>
  );
}

Combining with useProperties

Combine with useProperties to let end users adjust polling intervals.

function Wallpaper() {
  const props = useProperties();
  const info = useSystemMonitor({
    cpuIntervalMs: props.cpuInterval as number
  });
  // ...
}

Notes

• Each category is only refreshed and read at its configured interval. Cached values are used between refreshes.
• No data is sent to the stream on ticks where nothing was updated, so the effective receive rate matches the shortest configured interval.
• Static information (hostname, OS name, CPU model, etc.) is fetched once at app startup and never changes.
• Monitoring starts when the first subscriber connects and stops when all subscribers disconnect.
• This hook only works inside the Fluxlay desktop app. In a normal browser, it returns the initial zero values.
• When options values change, the stream is automatically reconnected.