evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use NamedTuple - glances (#53297)

Browse source
This commit is contained in:
Marc Mueller 2021-07-22 07:27:01 +02:00 • committed by GitHub
parent f5480481cd
commit 5c3fb77660
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 165 additions and 86 deletions
Download patch file Download diff file Expand all files Collapse all files

194
homeassistant/components/glances/const.py
View file

@ -1,5 +1,8 @@
"""Constants for Glances component.""" """Constants for Glances component."""
from __future__ import annotations
import sys import sys
from typing import NamedTuple
from homeassistant.const import ( from homeassistant.const import (
DATA_GIBIBYTES, DATA_GIBIBYTES,
@ -26,51 +29,148 @@ if sys.maxsize > 2 ** 32:
else: else:
CPU_ICON = "mdi:cpu-32-bit" CPU_ICON = "mdi:cpu-32-bit"
SENSOR_TYPES = {
"disk_use_percent": ["fs", "used percent", PERCENTAGE, "mdi:harddisk", None], class GlancesSensorMetadata(NamedTuple):
"disk_use": ["fs", "used", DATA_GIBIBYTES, "mdi:harddisk", None], """Sensor metadata for an individual Glances sensor."""
"disk_free": ["fs", "free", DATA_GIBIBYTES, "mdi:harddisk", None],
"memory_use_percent": ["mem", "RAM used percent", PERCENTAGE, "mdi:memory", None], type: str
"memory_use": ["mem", "RAM used", DATA_MEBIBYTES, "mdi:memory", None], name_suffix: str
"memory_free": ["mem", "RAM free", DATA_MEBIBYTES, "mdi:memory", None], unit_of_measurement: str
"swap_use_percent": [ icon: str | None = None
"memswap", device_class: str | None = None
"Swap used percent",
PERCENTAGE,
"mdi:memory", SENSOR_TYPES: dict[str, GlancesSensorMetadata] = {
None, "disk_use_percent": GlancesSensorMetadata(
], type="fs",
"swap_use": ["memswap", "Swap used", DATA_GIBIBYTES, "mdi:memory", None], name_suffix="used percent",
"swap_free": ["memswap", "Swap free", DATA_GIBIBYTES, "mdi:memory", None], unit_of_measurement=PERCENTAGE,
"processor_load": ["load", "CPU load", "15 min", CPU_ICON, None], icon="mdi:harddisk",
"process_running": ["processcount", "Running", "Count", CPU_ICON, None], ),
"process_total": ["processcount", "Total", "Count", CPU_ICON, None], "disk_use": GlancesSensorMetadata(
"process_thread": ["processcount", "Thread", "Count", CPU_ICON, None], type="fs",
"process_sleeping": ["processcount", "Sleeping", "Count", CPU_ICON, None], name_suffix="used",
"cpu_use_percent": ["cpu", "CPU used", PERCENTAGE, CPU_ICON, None], unit_of_measurement=DATA_GIBIBYTES,
"temperature_core": [ icon="mdi:harddisk",
"sensors", ),
"Temperature", "disk_free": GlancesSensorMetadata(
TEMP_CELSIUS, type="fs",
None, name_suffix="free",
DEVICE_CLASS_TEMPERATURE, unit_of_measurement=DATA_GIBIBYTES,
], icon="mdi:harddisk",
"temperature_hdd": [ ),
"sensors", "memory_use_percent": GlancesSensorMetadata(
"Temperature", type="mem",
TEMP_CELSIUS, name_suffix="RAM used percent",
None, unit_of_measurement=PERCENTAGE,
DEVICE_CLASS_TEMPERATURE, icon="mdi:memory",
], ),
"fan_speed": ["sensors", "Fan speed", "RPM", "mdi:fan", None], "memory_use": GlancesSensorMetadata(
"battery": ["sensors", "Charge", PERCENTAGE, "mdi:battery", None], type="mem",
"docker_active": ["docker", "Containers active", "", "mdi:docker", None], name_suffix="RAM used",
"docker_cpu_use": ["docker", "Containers CPU used", PERCENTAGE, "mdi:docker", None], unit_of_measurement=DATA_MEBIBYTES,
"docker_memory_use": [ icon="mdi:memory",
"docker", ),
"Containers RAM used", "memory_free": GlancesSensorMetadata(
DATA_MEBIBYTES, type="mem",
"mdi:docker", name_suffix="RAM free",
None, unit_of_measurement=DATA_MEBIBYTES,
], icon="mdi:memory",
),
"swap_use_percent": GlancesSensorMetadata(
type="memswap",
name_suffix="Swap used percent",
unit_of_measurement=PERCENTAGE,
icon="mdi:memory",
),
"swap_use": GlancesSensorMetadata(
type="memswap",
name_suffix="Swap used",
unit_of_measurement=DATA_GIBIBYTES,
icon="mdi:memory",
),
"swap_free": GlancesSensorMetadata(
type="memswap",
name_suffix="Swap free",
unit_of_measurement=DATA_GIBIBYTES,
icon="mdi:memory",
),
"processor_load": GlancesSensorMetadata(
type="load",
name_suffix="CPU load",
unit_of_measurement="15 min",
icon=CPU_ICON,
),
"process_running": GlancesSensorMetadata(
type="processcount",
name_suffix="Running",
unit_of_measurement="Count",
icon=CPU_ICON,
),
"process_total": GlancesSensorMetadata(
type="processcount",
name_suffix="Total",
unit_of_measurement="Count",
icon=CPU_ICON,
),
"process_thread": GlancesSensorMetadata(
type="processcount",
name_suffix="Thread",
unit_of_measurement="Count",
icon=CPU_ICON,
),
"process_sleeping": GlancesSensorMetadata(
type="processcount",
name_suffix="Sleeping",
unit_of_measurement="Count",
icon=CPU_ICON,
),
"cpu_use_percent": GlancesSensorMetadata(
type="cpu",
name_suffix="CPU used",
unit_of_measurement=PERCENTAGE,
icon=CPU_ICON,
),
"temperature_core": GlancesSensorMetadata(
type="sensors",
name_suffix="Temperature",
unit_of_measurement=TEMP_CELSIUS,
device_class=DEVICE_CLASS_TEMPERATURE,
),
"temperature_hdd": GlancesSensorMetadata(
type="sensors",
name_suffix="Temperature",
unit_of_measurement=TEMP_CELSIUS,
device_class=DEVICE_CLASS_TEMPERATURE,
),
"fan_speed": GlancesSensorMetadata(
type="sensors",
name_suffix="Fan speed",
unit_of_measurement="RPM",
icon="mdi:fan",
),
"battery": GlancesSensorMetadata(
type="sensors",
name_suffix="Charge",
unit_of_measurement=PERCENTAGE,
icon="mdi:battery",
),
"docker_active": GlancesSensorMetadata(
type="docker",
name_suffix="Containers active",
unit_of_measurement="",
icon="mdi:docker",
),
"docker_cpu_use": GlancesSensorMetadata(
type="docker",
name_suffix="Containers CPU used",
unit_of_measurement=PERCENTAGE,
icon="mdi:docker",
),
"docker_memory_use": GlancesSensorMetadata(
type="docker",
name_suffix="Containers RAM used",
unit_of_measurement=DATA_MEBIBYTES,
icon="mdi:docker",
),
} }

57
homeassistant/components/glances/sensor.py
View file

@ -4,7 +4,7 @@ from homeassistant.const import CONF_NAME, STATE_UNAVAILABLE
from homeassistant.core import callback from homeassistant.core import callback
from homeassistant.helpers.dispatcher import async_dispatcher_connect from homeassistant.helpers.dispatcher import async_dispatcher_connect
from .const import DATA_UPDATED, DOMAIN, SENSOR_TYPES from .const import DATA_UPDATED, DOMAIN, SENSOR_TYPES, GlancesSensorMetadata
async def async_setup_entry(hass, config_entry, async_add_entities): async def async_setup_entry(hass, config_entry, async_add_entities):
@ -14,45 +14,42 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
name = config_entry.data[CONF_NAME] name = config_entry.data[CONF_NAME]
dev = [] dev = []
for sensor_type, sensor_details in SENSOR_TYPES.items(): for sensor_type, metadata in SENSOR_TYPES.items():
if sensor_details[0] not in client.api.data: if metadata.type not in client.api.data:
continue continue
if sensor_details[0] == "fs": if metadata.type == "fs":
# fs will provide a list of disks attached # fs will provide a list of disks attached
for disk in client.api.data[sensor_details[0]]: for disk in client.api.data[metadata.type]:
dev.append( dev.append(
GlancesSensor( GlancesSensor(
client, client,
name, name,
disk["mnt_point"], disk["mnt_point"],
sensor_details[1],
sensor_type, sensor_type,
sensor_details, metadata,
) )
) )
elif sensor_details[0] == "sensors": elif metadata.type == "sensors":
# sensors will provide temp for different devices # sensors will provide temp for different devices
for sensor in client.api.data[sensor_details[0]]: for sensor in client.api.data[metadata.type]:
if sensor["type"] == sensor_type: if sensor["type"] == sensor_type:
dev.append( dev.append(
GlancesSensor( GlancesSensor(
client, client,
name, name,
sensor["label"], sensor["label"],
sensor_details[1],
sensor_type, sensor_type,
sensor_details, metadata,
) )
) )
elif client.api.data[sensor_details[0]]: elif client.api.data[metadata.type]:
dev.append( dev.append(
GlancesSensor( GlancesSensor(
client, client,
name, name,
"", "",
sensor_details[1],
sensor_type, sensor_type,
sensor_details, metadata,
) )
) )
@ -67,45 +64,27 @@ class GlancesSensor(SensorEntity):
glances_data, glances_data,
name, name,
sensor_name_prefix, sensor_name_prefix,
sensor_name_suffix,
sensor_type, sensor_type,
sensor_details, metadata: GlancesSensorMetadata,
): ):
"""Initialize the sensor.""" """Initialize the sensor."""
self.glances_data = glances_data self.glances_data = glances_data
self._sensor_name_prefix = sensor_name_prefix self._sensor_name_prefix = sensor_name_prefix
self._sensor_name_suffix = sensor_name_suffix
self._name = name
self.type = sensor_type self.type = sensor_type
self._state = None self._state = None
self.sensor_details = sensor_details self._metadata = metadata
self.unsub_update = None self.unsub_update = None
@property self._attr_name = f"{name} {sensor_name_prefix} {metadata.name_suffix}"
def name(self): self._attr_icon = metadata.icon
"""Return the name of the sensor.""" self._attr_unit_of_measurement = metadata.unit_of_measurement
return f"{self._name} {self._sensor_name_prefix} {self._sensor_name_suffix}" self._attr_device_class = metadata.device_class
@property @property
def unique_id(self): def unique_id(self):
"""Set unique_id for sensor.""" """Set unique_id for sensor."""
return f"{self.glances_data.host}-{self.name}" return f"{self.glances_data.host}-{self.name}"
@property
def device_class(self):
"""Return the class of this device, from component DEVICE_CLASSES."""
return self.sensor_details[4]
@property
def icon(self):
"""Icon to use in the frontend, if any."""
return self.sensor_details[3]
@property
def unit_of_measurement(self):
"""Return the unit the value is expressed in."""
return self.sensor_details[2]
@property @property
def available(self): def available(self):
"""Could the device be accessed during the last update call.""" """Could the device be accessed during the last update call."""
@ -143,7 +122,7 @@ class GlancesSensor(SensorEntity):
if value is None: if value is None:
return return
if self.sensor_details[0] == "fs": if self._metadata.type == "fs":
for var in value["fs"]: for var in value["fs"]:
if var["mnt_point"] == self._sensor_name_prefix: if var["mnt_point"] == self._sensor_name_prefix:
disk = var disk = var