From 19964e914af274d6245636be69e3d384167ab44f Mon Sep 17 00:00:00 2001 From: theolind Date: Sat, 7 Mar 2015 14:54:08 +0100 Subject: [PATCH] Added a system monitoring platform to the sensor component --- config/configuration.yaml.example | 12 +++ .../components/sensor/systemmonitor.py | 89 +++++++++++++++++++ requirements.txt | 3 + 3 files changed, 104 insertions(+) create mode 100644 homeassistant/components/sensor/systemmonitor.py diff --git a/config/configuration.yaml.example b/config/configuration.yaml.example index 355a24e94d4..1e42c836a33 100644 --- a/config/configuration.yaml.example +++ b/config/configuration.yaml.example @@ -102,3 +102,15 @@ automation 2: execute_service: notify.notify service_data: {"message":"It's 4, time for beer!"} + +sensor: + platform: systemmonitor + devices: + - {type: 'disk_use_percent', arg: '/'} + - {type: 'disk_use_percent', arg: '/home'} + - {type: 'disk_use', arg: '/home'} + - {type: 'disk_free', arg: '/'} + - {type: 'memory_use_percent'} + - {type: 'memory_use'} + - {type: 'memory_free'} + - {type: 'processor_use'} \ No newline at end of file diff --git a/homeassistant/components/sensor/systemmonitor.py b/homeassistant/components/sensor/systemmonitor.py new file mode 100644 index 00000000000..f53c4c09a33 --- /dev/null +++ b/homeassistant/components/sensor/systemmonitor.py @@ -0,0 +1,89 @@ +""" +homeassistant.components.sensor.systemmonitor +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Shows system monitor values such as: disk, memory and processor use + +""" + +from homeassistant.helpers.device import Device +from homeassistant.const import ( + ATTR_UNIT_OF_MEASUREMENT, ATTR_FRIENDLY_NAME) +import psutil +import logging + +sensor_types = { + 'disk_use_percent': ['Disk Use', '%'], + 'disk_use': ['Disk Use', 'GiB'], + 'disk_free': ['Disk Free', 'GiB'], + 'memory_use_percent': ['RAM Use', '%'], + 'memory_use': ['RAM Use', 'MiB'], + 'memory_free': ['RAM Free', 'MiB'], + 'processor_use': ['CPU Use', '%'], +} + +_LOGGER = logging.getLogger(__name__) + +# pylint: disable=unused-argument +def setup_platform(hass, config, add_devices, discovery_info=None): + """ Sets up the sensors """ + + devices = [] + for device in config['devices']: + if 'arg' not in device: + device['arg'] = '' + if device['type'] not in sensor_types: + _LOGGER.error('Sensor type: "%s" does not exist', device['type']) + else: + devices.append(SystemMonitorSensor(device['type'], device['arg'])) + + add_devices(devices) + + +class SystemMonitorSensor(Device): + """ A system monitor sensor """ + + def __init__(self, type, argument=''): + self._name = sensor_types[type][0] + ' ' + argument + self.argument = argument + self.type = type + self._state = None + self.unit_of_measurement = sensor_types[type][1] + self.update() + + @property + def name(self): + return self._name + + @property + def state(self): + """ Returns the state of the device. """ + return self._state + + @property + def state_attributes(self): + """ Returns the state attributes. """ + return { + ATTR_FRIENDLY_NAME: self.name, + ATTR_UNIT_OF_MEASUREMENT: self.unit_of_measurement, + } + + def update(self): + if self.type == 'disk_use_percent': + self._state = psutil.disk_usage(self.argument).percent + elif self.type == 'disk_use': + self._state = round(psutil.disk_usage(self.argument).used / + 1024**3, 1) + elif self.type == 'disk_free': + self._state = round(psutil.disk_usage(self.argument).free / + 1024**3, 1) + elif self.type == 'memory_use_percent': + self._state = psutil.virtual_memory().percent + elif self.type == 'memory_use': + self._state = round((psutil.virtual_memory().total - + psutil.virtual_memory().available) / + 1024**2, 1) + elif self.type == 'memory_free': + self._state = round(psutil.virtual_memory().available / 1024**2, 1) + elif self.type == 'processor_use': + self._state = round(psutil.cpu_percent(interval=None)) diff --git a/requirements.txt b/requirements.txt index 0d727f10b85..156181da508 100644 --- a/requirements.txt +++ b/requirements.txt @@ -35,3 +35,6 @@ pydispatcher>=2.0.5 # pyyaml pyyaml + +# psutil +psutil