`sensor.dht`#

Description#

Plugin to interact with a DHT11/DHT22/AM2302 temperature/humidity sensor through GPIO.

Configuration#

sensor.dht:
  # [Required]
  # Type of sensor to be used (supported types: DHT11, DHT22, AM2302).
  sensor_type:   # type=str

  # [Required]
  # GPIO PIN where the sensor is connected.
  pin:   # type=int

  # [Optional]
  # Number of retries in case of failed read (default: 5).
  # retries: 5  # type=int

  # [Optional]
  # Number of seconds to wait between retries (default: 2).
  # retry_seconds: 2  # type=int

  # [Optional]
  # How often the `RunnablePlugin.loop <https://docs.platypush.tech/platypush/plugins/.html#platypush.plugins.RunnablePlugin.loop>`_ function should be
  # executed (default: 15 seconds). *NOTE*: For back-compatibility
  # reasons, the `poll_seconds` argument is also supported, but it's
  # deprecated.
  # poll_interval: 5.0  # type=float

  # [Optional]
  # A number, numeric pair or mapping of ``str`` to
  # number/numeric pair representing the thresholds for the sensor.
  #
  # Examples:
  #
  #     .. code-block:: yaml
  #
  #         # Any value below 25 from any sensor will trigger a
  #         # SensorDataBelowThresholdEvent, if the previous value was
  #         # equal or above, and any value above 25 will trigger a
  #         # SensorDataAboveThresholdEvent, if the previous value was
  #         # equal or below
  #         thresholds: 25.0
  #
  #         # Same as above, but the threshold is only applied to
  #         # ``temperature`` readings
  #         thresholds:
  #             temperature: 25.0
  #
  #         # Any value below 20 from any sensor will trigger a
  #         # SensorDataBelowThresholdEvent, if the previous value was
  #         # equal or above, and any value above 25 will trigger a
  #         # SensorDataAboveThresholdEvent, if the previous value was
  #         # equal or below (hysteresis configuration with double
  #         # threshold)
  #         thresholds:
  #             - 20.0
  #             - 25.0
  #
  #         # Same as above, but the threshold is only applied to
  #         # ``temperature`` readings
  #         thresholds:
  #             temperature:
  #                 - 20.0
  #                 - 25.0
  # thresholds:   # type=Union[float, int, Tuple[Union[float, int], Union[float, int]], Mapping[str, Union[float, int, Tuple[Union[float, int], Union[float, int]]]], NoneType]

  # [Optional]
  # If set, then the sensor change events will be
  # triggered only if the difference between the new value and the
  # previous value is higher than the specified tolerance. For example,
  # if the sensor data is mapped to a dictionary::
  #
  #     {
  #         "temperature": 0.01,  # Tolerance on the 2nd decimal digit
  #         "humidity": 0.1       # Tolerance on the 1st decimal digit
  #     }
  #
  # Or, if it's a raw scalar number::
  #
  #     0.1  # Tolerance on the 1st decimal digit
  #
  # Or, if it's a list of values::
  #
  #     [
  #         0.01,   # Tolerance on the 2nd decimal digit for the first value
  #         0.1     # Tolerance on the 1st decimal digit for the second value
  #     ]
  # tolerance: 0  # type=Union[float, int, Mapping[str, Union[float, int]], Iterable[Union[float, int]]]

  # [Optional]
  # If `SensorPlugin.get_measurement <https://docs.platypush.tech/platypush/plugins/sensor.html#platypush.plugins.sensor.SensorPlugin.get_measurement>`_ returns a key-value
  # mapping, and ``enabled_sensors`` is set, then only the reported
  # sensor keys will be returned.
  # enabled_sensors:   # type=Optional[Iterable[str]]

  # [Optional]
  # How long we should wait for any running
  # threads/processes to stop before exiting (default: 5 seconds).
  # stop_timeout: 5  # type=Optional[float]

  # [Optional]
  # If set to True then the plugin will not monitor
  # for new events. This is useful if you want to run a plugin in
  # stateless mode and only leverage its actions, without triggering any
  # events. Defaults to False.
  # disable_monitor: False  # type=bool

Dependencies#

pip

pip install Adafruit_Python_DHT

Triggered events#

platypush.message.event.sensor.SensorDataBelowThresholdEvent

platypush.message.event.sensor.SensorDataAboveThresholdEvent

platypush.message.event.sensor.SensorDataChangeEvent

Actions#

sensor.dht.get_data

sensor.dht.get_measurement

sensor.dht.read

sensor.dht.status

Module reference#

class platypush.plugins.sensor.dht.SensorDhtPlugin(*_, **__)[source]#

Bases: SensorPlugin

Plugin to interact with a DHT11/DHT22/AM2302 temperature/humidity sensor through GPIO.

__init__(sensor_type: str, pin: int, retries: int = 5, retry_seconds: int = 2, poll_interval: float = 5.0, **kwargs)[source]#

Parameters:

sensor_type – Type of sensor to be used (supported types: DHT11, DHT22, AM2302).
pin – GPIO PIN where the sensor is connected.
retries – Number of retries in case of failed read (default: 5).
retry_seconds – Number of seconds to wait between retries (default: 2).

get_data(*args, **kwargs)#: (Deprecated) alias for get_measurement()

get_measurement(*_, **__) → Dict[str, float][source]#

Get data from the sensor.

Returns:

A mapping with the measured temperature and humidity. Example:

{
    "humidity": 30.0,
    "temperature": 25.5
}

main()#: Implementation of the main loop of the plugin.

Publishes a list of entities. The downstream consumers include:

The entity persistence manager

The web server

Any consumer subscribed to
platypush.message.event.entities.EntityUpdateEvent events (e.g. web clients)

It also accepts an optional callback that will be called when each of the entities in the set is flushed to the database.

You usually don’t need to override this class (but you may want to extend transform_entities() instead if your extension doesn’t natively handle Entity objects).

read(sensor_type: str | None = None, pin: int | None = None, retries: int | None = None, retry_seconds: int | None = None, **__) → Dict[str, float][source]#

Read data from the sensor.