Home Assistant Unofficial Reference 2024.12.1
Classes | Functions | Variables
homeassistant.components.system_bridge.sensor Namespace Reference

Classes

class  SystemBridgeSensor
 
class  SystemBridgeSensorEntityDescription
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry entry, AddEntitiesCallback async_add_entities)
 
datetime|None battery_time_remaining (SystemBridgeData data)
 
float|None cpu_power_per_cpu (PerCPU per_cpu)
 
float|None cpu_speed (SystemBridgeData data)
 
float|None cpu_usage_per_cpu (PerCPU per_cpu)
 
float|None display_refresh_rate (Display display)
 
int|None display_resolution_horizontal (Display display)
 
int|None display_resolution_vertical (Display display)
 
float|None gpu_core_clock_speed (GPU gpu)
 
float|None gpu_fan_speed (GPU gpu)
 
float|None gpu_memory_clock_speed (GPU gpu)
 
float|None gpu_memory_free (GPU gpu)
 
float|None gpu_memory_used (GPU gpu)
 
float|None gpu_memory_used_percentage (GPU gpu)
 
float|None gpu_power_usage (GPU gpu)
 
float|None gpu_temperature (GPU gpu)
 
float|None gpu_usage_percentage (GPU gpu)
 
float|None memory_free (SystemBridgeData data)
 
float|None memory_used (SystemBridgeData data)
 
float|None partition_usage (SystemBridgeData data, int device_index, int partition_index)
 
Callable with_display (func)
 
Callable with_gpu (func)
 
Callable with_per_cpu (func)
 

Variables

 Final
 

Detailed Description

Support for System Bridge sensors.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.system_bridge.sensor.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry,
AddEntitiesCallback  async_add_entities 
) 
Set up System Bridge sensor based on a config entry.

Definition at line 359 of file sensor.py.

◆ battery_time_remaining()

datetime | None homeassistant.components.system_bridge.sensor.battery_time_remaining ( SystemBridgeData  data) 
Return the battery time remaining.

Definition at line 58 of file sensor.py.

◆ cpu_power_per_cpu()

float | None homeassistant.components.system_bridge.sensor.cpu_power_per_cpu ( PerCPU  per_cpu) 
Return CPU power per CPU.

Definition at line 87 of file sensor.py.

◆ cpu_speed()

float | None homeassistant.components.system_bridge.sensor.cpu_speed ( SystemBridgeData  data) 
Return the CPU speed.

Definition at line 65 of file sensor.py.

◆ cpu_usage_per_cpu()

float | None homeassistant.components.system_bridge.sensor.cpu_usage_per_cpu ( PerCPU  per_cpu) 
Return CPU usage per CPU.

Definition at line 93 of file sensor.py.

◆ display_refresh_rate()

float | None homeassistant.components.system_bridge.sensor.display_refresh_rate ( Display  display) 
Return the Display refresh rate.

Definition at line 123 of file sensor.py.

◆ display_resolution_horizontal()

int | None homeassistant.components.system_bridge.sensor.display_resolution_horizontal ( Display  display) 
Return the Display resolution horizontal.

Definition at line 111 of file sensor.py.

◆ display_resolution_vertical()

int | None homeassistant.components.system_bridge.sensor.display_resolution_vertical ( Display  display) 
Return the Display resolution vertical.

Definition at line 117 of file sensor.py.

◆ gpu_core_clock_speed()

float | None homeassistant.components.system_bridge.sensor.gpu_core_clock_speed ( GPU  gpu) 
Return the GPU core clock speed.

Definition at line 141 of file sensor.py.

◆ gpu_fan_speed()

float | None homeassistant.components.system_bridge.sensor.gpu_fan_speed ( GPU  gpu) 
Return the GPU fan speed.

Definition at line 147 of file sensor.py.

◆ gpu_memory_clock_speed()

float | None homeassistant.components.system_bridge.sensor.gpu_memory_clock_speed ( GPU  gpu) 
Return the GPU memory clock speed.

Definition at line 153 of file sensor.py.

◆ gpu_memory_free()

float | None homeassistant.components.system_bridge.sensor.gpu_memory_free ( GPU  gpu) 
Return the free GPU memory.

Definition at line 159 of file sensor.py.

◆ gpu_memory_used()

float | None homeassistant.components.system_bridge.sensor.gpu_memory_used ( GPU  gpu) 
Return the used GPU memory.

Definition at line 165 of file sensor.py.

◆ gpu_memory_used_percentage()

float | None homeassistant.components.system_bridge.sensor.gpu_memory_used_percentage ( GPU  gpu) 
Return the used GPU memory percentage.

Definition at line 171 of file sensor.py.

◆ gpu_power_usage()

float | None homeassistant.components.system_bridge.sensor.gpu_power_usage ( GPU  gpu) 
Return the GPU power usage.

Definition at line 179 of file sensor.py.

◆ gpu_temperature()

float | None homeassistant.components.system_bridge.sensor.gpu_temperature ( GPU  gpu) 
Return the GPU temperature.

Definition at line 185 of file sensor.py.

◆ gpu_usage_percentage()

float | None homeassistant.components.system_bridge.sensor.gpu_usage_percentage ( GPU  gpu) 
Return the GPU usage percentage.

Definition at line 191 of file sensor.py.

◆ memory_free()

float | None homeassistant.components.system_bridge.sensor.memory_free ( SystemBridgeData  data) 
Return the free memory.

Definition at line 196 of file sensor.py.

◆ memory_used()

float | None homeassistant.components.system_bridge.sensor.memory_used ( SystemBridgeData  data) 
Return the used memory.

Definition at line 205 of file sensor.py.

◆ partition_usage()

float | None homeassistant.components.system_bridge.sensor.partition_usage ( SystemBridgeData  data,
int  device_index,
int  partition_index 
) 
Return the used memory.

Definition at line 214 of file sensor.py.

◆ with_display()

Callable homeassistant.components.system_bridge.sensor.with_display (   func) 
Wrap a function to ensure a Display is available.

Definition at line 98 of file sensor.py.

◆ with_gpu()

Callable homeassistant.components.system_bridge.sensor.with_gpu (   func) 
Wrap a function to ensure a GPU is available.

Definition at line 128 of file sensor.py.

◆ with_per_cpu()

Callable homeassistant.components.system_bridge.sensor.with_per_cpu (   func) 
Wrap a function to ensure per CPU data is available.

Definition at line 74 of file sensor.py.

Variable Documentation

◆ Final

homeassistant.components.system_bridge.sensor.Final

Definition at line 41 of file sensor.py.