2024-11-27 18:57:16 +01:00

1.2 KiB

title description ha_category ha_iot_class ha_release ha_domain ha_platforms ha_integration_type ha_quality_scale
Folder Sensor for monitoring the contents of a folder.
Sensor
Utility
Local Polling 0.64 folder
sensor
integration legacy

Sensor for monitoring the contents of a folder. Note that folder paths must be added to allowlist_external_dirs. Optionally a wildcard filter can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The sensor exposes the number of filtered files in the folder, total size in bytes of those files and a comma separated list of the file paths as attributes.

Configuration

To enable the folder sensor in your installation, add the following to your {% term "configuration.yaml" %} file:

sensor:
  - platform: folder
    folder: /config

{% configuration %} folder: description: The folder path required: true type: string filter: description: Filter to apply required: false default: "*" type: string {% endconfiguration %}