> Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

---
title: Hardware Monitor
icon: chart-line
---

# <ApiPageIcon icon="chart-line" />Hardware Monitor

<ApiExposes data="[{&#x22;k&#x22;:&#x22;NAMESPACE&#x22;,&#x22;c&#x22;:&#x22;fn&#x22;,&#x22;s&#x22;:&#x22;hwmon&#x22;,&#x22;h&#x22;:&#x22;#hwmon&#x22;},{&#x22;k&#x22;:&#x22;OBJECT&#x22;,&#x22;c&#x22;:&#x22;method&#x22;,&#x22;s&#x22;:&#x22;hwmon.CPUCoreInfo&#x22;,&#x22;h&#x22;:&#x22;#hwmoncpucoreinfo&#x22;},{&#x22;k&#x22;:&#x22;OBJECT&#x22;,&#x22;c&#x22;:&#x22;method&#x22;,&#x22;s&#x22;:&#x22;hwmon.GPUAdapterInfo&#x22;,&#x22;h&#x22;:&#x22;#hwmongpuadapterinfo&#x22;},{&#x22;k&#x22;:&#x22;CDATA&#x22;,&#x22;c&#x22;:&#x22;method&#x22;,&#x22;s&#x22;:&#x22;LUID&#x22;,&#x22;h&#x22;:&#x22;#luid&#x22;},{&#x22;k&#x22;:&#x22;CDATA&#x22;,&#x22;c&#x22;:&#x22;method&#x22;,&#x22;s&#x22;:&#x22;PLUID&#x22;,&#x22;h&#x22;:&#x22;#pluid&#x22;}]" />

## hwmon<ApiTag label="global table" />

Read only values about the frame rate and the hardware of the computer.

The frame rate values are measured over the last second. If a value is not available, it is
`0`.

Load and usage values are fractions. `0` means idle and `1` means 100 percent.

<ApiMembers>
  <ApiMember kind="prop" name="hwmon.average_fps" summary="The average frame rate in the last second." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.cpu_base_frequency" summary="The rated maximum frequency of the CPU, in MHz." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.cpu_cores" summary="Information for each logical processor, sorted by `processor_id` and then by `core_id`." ret="[[{&#x22;s&#x22;:&#x22;hwmon.CPUCoreInfo&#x22;,&#x22;k&#x22;:&#x22;class&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/runtime/hwmon#hwmoncpucoreinfo&#x22;},{&#x22;s&#x22;:&#x22;[&#x22;},{&#x22;s&#x22;:&#x22;]&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.cpu_cores_count" summary="The number of entries in `cpu_cores`." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.cpu_count" summary="The number of logical processors." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.cpu_frequency" summary="The average current frequency of all logical processors, in MHz." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.cpu_load" summary="The average load of all logical processors, as a fraction. The value can be above `1` when the CPU runs faster than its base frequency." ret="[[{&#x22;s&#x22;:&#x22;number&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#number&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.cpu_max_frequency" summary="The highest current frequency of a single logical processor, in MHz." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.cpu_max_load" summary="The highest load of a single logical processor, as a fraction." ret="[[{&#x22;s&#x22;:&#x22;number&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#number&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.frame_smoothness" summary="How even the frame times are, from 0 to 1. A higher value means more even frame times." ret="[[{&#x22;s&#x22;:&#x22;number&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#number&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.gpu_count" summary="The number of graphics adapters." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.gpu_list" summary="Information for each graphics adapter." ret="[[{&#x22;s&#x22;:&#x22;hwmon.GPUAdapterInfo&#x22;,&#x22;k&#x22;:&#x22;class&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/runtime/hwmon#hwmongpuadapterinfo&#x22;},{&#x22;s&#x22;:&#x22;[&#x22;},{&#x22;s&#x22;:&#x22;]&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.max_fps" summary="The highest frame rate in the last second." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.memory_load" summary="The part of the physical memory that is in use, as a fraction." ret="[[{&#x22;s&#x22;:&#x22;number&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#number&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.memory_total" summary="The total physical memory, in megabytes." ret="[[{&#x22;s&#x22;:&#x22;uint64_t&#x22;,&#x22;k&#x22;:&#x22;class&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#uint64_t&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.memory_usage" summary="The physical memory that is in use, in megabytes." ret="[[{&#x22;s&#x22;:&#x22;uint64_t&#x22;,&#x22;k&#x22;:&#x22;class&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#uint64_t&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.min_fps" summary="The lowest frame rate in the last second." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.one_percent_low_fps" summary="The 1 percent low frame rate. This is the frame rate of the slowest 1 percent of frames in the last second." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />
</ApiMembers>

## hwmon.CPUCoreInfo<ApiTag label="object type" />

Information about one logical processor.

<ApiMembers>
  <ApiMember kind="prop" name="hwmon.CPUCoreInfo.core_id" summary="The index of the logical processor in its processor group." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.CPUCoreInfo.frequency_mhz" summary="The current frequency of this logical processor, in MHz." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.CPUCoreInfo.processor_id" summary="The index of the processor group. On most computers this is `0`." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.CPUCoreInfo.usage" summary="The current load of this logical processor, as a fraction." ret="[[{&#x22;s&#x22;:&#x22;number&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#number&#x22;}]]" />
</ApiMembers>

## hwmon.GPUAdapterInfo<ApiTag label="object type" />

Information about one graphics adapter.

<ApiMembers>
  <ApiMember kind="prop" name="hwmon.GPUAdapterInfo.adapter_luid" summary="The locally unique identifier of the adapter. It is valid until Windows restarts." ret="[[{&#x22;s&#x22;:&#x22;LUID&#x22;,&#x22;k&#x22;:&#x22;class&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/runtime/hwmon#luid&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.GPUAdapterInfo.adapter_name" summary="The name of the adapter, such as the model of the graphics card." ret="[[{&#x22;s&#x22;:&#x22;string&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#string&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.GPUAdapterInfo.dedicated_vram_mb" summary="The dedicated video memory of the adapter, in megabytes. It includes system memory that is reserved only for the adapter." ret="[[{&#x22;s&#x22;:&#x22;uint64_t&#x22;,&#x22;k&#x22;:&#x22;class&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#uint64_t&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.GPUAdapterInfo.device_id" summary="The PCI device ID." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.GPUAdapterInfo.gpu_usage_percent" summary="The current load of the adapter, as a fraction from 0 to 1." ret="[[{&#x22;s&#x22;:&#x22;number&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#number&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.GPUAdapterInfo.shared_memory_mb" summary="The system memory that the adapter can share with the CPU, in megabytes." ret="[[{&#x22;s&#x22;:&#x22;uint64_t&#x22;,&#x22;k&#x22;:&#x22;class&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#uint64_t&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.GPUAdapterInfo.unique_id" summary="An identifier for the adapter made from its device ID and vendor ID, such as `&#x22;0x00002684_0x000010DE&#x22;`." ret="[[{&#x22;s&#x22;:&#x22;string&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#string&#x22;}]]" />

  <ApiMember kind="prop" name="hwmon.GPUAdapterInfo.vendor_id" summary="The PCI vendor ID." ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />
</ApiMembers>

## LUID<ApiTag label="cdata" href="/cs2/api_reference/tutorials/ffi-crash-course#ctype-and-cdata" title="cdata<struct _LUID>" />

<ApiMembers>
  <ApiMember kind="prop" name="LUID.HighPart" ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />

  <ApiMember kind="prop" name="LUID.LowPart" ret="[[{&#x22;s&#x22;:&#x22;integer&#x22;,&#x22;k&#x22;:&#x22;prim&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/lua/base#integer&#x22;}]]" />
</ApiMembers>

## PLUID<ApiTag label="cdata" href="/cs2/api_reference/tutorials/ffi-crash-course#ctype-and-cdata" title="cdata<struct _LUID *>" />

<ApiSymbol inherits="[{&#x22;n&#x22;:&#x22;LUID&#x22;,&#x22;h&#x22;:&#x22;/cs2/api_reference/runtime/hwmon#luid&#x22;}]" />
