Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions source/_components/sensor.folder.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
layout: page
title: "Folder sensor"
description: "Sensor for monitoring the contents of a folder."
date: 2018-02-21 14:00
sidebar: true
comments: false
sharing: true
footer: true
logo: file.png
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: 0.64
---

Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](https://home-assistant.io/docs/configuration/basic/). Optionally a [wildcard filter]((http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm)) 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 number of filtered files in the folder and total size in bytes of those files are exposed as attributes.

To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file:

```yaml
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 %}