perun.data_model.sensor
=======================

.. py:module:: perun.data_model.sensor

.. autoapi-nested-parse::

   Device module.



Classes
-------

.. autoapisummary::

   perun.data_model.sensor.DeviceType
   perun.data_model.sensor.Sensor


Module Contents
---------------

.. py:class:: DeviceType

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   DeviceType enum.


   .. py:attribute:: RACK
      :value: 'rack'



   .. py:attribute:: NODE
      :value: 'node'



   .. py:attribute:: CPU
      :value: 'cpu'



   .. py:attribute:: GPU
      :value: 'gpu'



   .. py:attribute:: RAM
      :value: 'ram'



   .. py:attribute:: DISK
      :value: 'disk'



   .. py:attribute:: NET
      :value: 'net'



   .. py:attribute:: FAN
      :value: 'fan'



   .. py:attribute:: OTHER
      :value: 'other'



.. py:class:: Sensor

   Defines a devices sensor properties.


   .. py:attribute:: id
      :type:  str


   .. py:attribute:: type
      :type:  DeviceType


   .. py:attribute:: metadata
      :type:  dict


   .. py:attribute:: dataType
      :type:  perun.data_model.measurement_type.MetricMetaData


   .. py:attribute:: measureCallback
      :type:  Callable[[], perun.data_model.measurement_type.Number]


   .. py:method:: read() -> perun.data_model.measurement_type.Number

      Read value from sensor.



   .. py:method:: toDict() -> dict[str, Any]

      Return device as a dictionary.