[Custom Component] TrueNAS SCALE (25.10+, 26.0+) - Modern WebSocket JSON-RPC 2.0 Integration

Share your Projects! Custom Integrations
1

Hi everyone,

I created a new custom integration for TrueNAS SCALE built specifically for
versions 25.10+ and 26.0+.

Older TrueNAS integrations in the community rely on legacy REST or WebSocket endpoints
that are either deprecated or lack support for the newer JSON-RPC 2.0 protocol introduced
in recent TrueNAS SCALE releases. This integration uses native JSON-RPC 2.0 WebSocket
communication with live push subscriptions for telemetry.

Key Features

  • Real-time Telemetry: Uses native WebSocket events (reporting.realtime) for live updates.
  • Storage & Pools:
    • Usable Capacity, Used Space, and Free Space with exact byte precision matching the
      TrueNAS Storage GUI.
    • Pool Usage percentage and individual Pool I/O rates (MB/s and IOPS).
    • Dataset Used Space and physical drive temperatures (°C).
  • System Metrics:
    • CPU Usage (%) and CPU Temperature (°C) aggregated across active cores.
    • Load Averages (1m, 5m, 15m).
    • RAM Usage, Available/Used RAM, and ZFS ARC Cache size.
    • Network Download (Rx) and Upload (Tx) rates per interface (MB/s).
    • System-wide Disk Read/Write rates and IOPS.
  • App, Service, and VM Control:
    • Switches (switch) to start and stop TrueNAS Apps, System Services (SMB, SSH, NFS,
      etc.), and Virtual Machines (VMs).
    • Buttons (button) for one-click restarts of Apps (redeploy), Services, and VMs.
  • Updates & Monitoring:
    • Update entities (update) indicating available TrueNAS app updates with version
      numbers and logos.
    • Binary sensors (binary_sensor) for System Alerts, Pool Health, Service states,
      App states, and VM states.

Installation via HACS

  1. Open HACS in Home Assistant → click the 3 dots in the top right corner → Custom
    repositories    .
  2. Add repository URL: https://github.com/hurricaneb/hass_TrueNAS_Scale
  3. Select Integration as Category and click Add.
  4. Search for TrueNAS SCALE in HACS, download, and restart Home Assistant.
  5. Go to Settings → Devices & Services → Add Integration → Search for
    TrueNAS SCALE.

Links & Feedback

Feel free to test it out, open issues, or share any feedback and feature requests on
GitHub!

1 Like