Adds folder sensor #12208

robmarkcole · 2018-02-06T14:09:23Z

Description:

Home-assistant custom component for monitoring the contents of a folder.

The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The use case is detecting when a file is created in a folder . For example, I have a USB camera attached to my HA instance that saves a new timestamped photo when motion is detected. This sensor allows me to detect when another image is saved.
The number of files in the folder and the size in bytes are exposed in attributes.

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#4588

Example entry for `configuration.yaml` (if applicable):

sensor:
  - platform: folder
    folder: /share/motion
    filter: '*capture.jpg'
  - platform: folder
    folder: /config

Checklist:

The code change is tested and works locally.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
[x ] New files were added to .coveragerc.

If the code does not interact with devices:

[x ] Local tests with tox run successfully. Your PR cannot be merged unless tests pass
[ x] Tests have been added to verify that the new code works.

The state of the sensor is the time that the most recently modified file in a folder was modified.

arsaboo · 2018-02-06T15:30:34Z

homeassistant/components/sensor/folder.py

+        return
+
+    def get_sorted_files_list(self, folder_path, filter_term):
+        """Rerturn the sorted list of files in a directory, applying filter.


Typo....return. Also, shorten the docstring.

arsaboo · 2018-02-06T15:30:44Z

homeassistant/components/sensor/folder.py

+        return sorted_files_list
+
+    def get_last_updated(self, recent_modified_file):
+        """Rerturn the datetime a file was last modified."""


Same...typo return

Makes the recommended edits to docstrings

Qxlkdr · 2018-02-06T19:33:41Z

Don't forget to add your file to .coveragerc as described in the pull request template.

Add sensor/folder.py

balloob · 2018-02-11T20:02:20Z

homeassistant/components/sensor/folder.py

+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Set up the folder sensor."""
+    folder = Folder(config.get(CONF_FOLDER_PATHS), config.get(CONF_FILTER))


All paths have to be whitelisted by checking it with hass.config.is_allowed_path(path)

MartinHjelmare · 2018-02-12T00:06:28Z

homeassistant/components/sensor/folder.py

+        self._last_updated = ''
+        self._name = folder_path.split("/")[-2]
+        self._unit_of_measurement = ''
+        self.update()


Remove this. It's already called during entity addition.

MartinHjelmare · 2018-02-12T00:06:53Z

homeassistant/components/sensor/folder.py

+
+        self._last_updated = self.get_last_updated(
+            self._recent_modified_file)
+        return


Remove this unnecessary return statement.

MartinHjelmare · 2018-02-12T00:11:39Z

homeassistant/components/sensor/folder.py

+    @property
+    def device_state_attributes(self):
+        """Return other details about the sensor state."""
+        attrs = {}


Please construct the whole dict directly.

attr = { 'folder': self._folder_path, ... }

MartinHjelmare · 2018-02-12T00:15:00Z

homeassistant/components/sensor/folder.py

+        self._recent_modified_file = ''
+        self._last_updated = ''
+        self._name = folder_path.split("/")[-2]
+        self._unit_of_measurement = ''


This is not an allowed unit of measurement.

MartinHjelmare · 2018-02-12T00:15:46Z

homeassistant/components/sensor/folder.py

+        self._sorted_files_list = []
+        self._number_of_files = None
+        self._recent_modified_file = ''
+        self._last_updated = ''


Init as None.

Address requested changes in home-assistant/core#12208

Address requests changes

MartinHjelmare

Nice! Can be merged when build passes.

MartinHjelmare

Sorry, I forgot about tests. This should be tested since it's not integrating a 3rd party device.

houndci-bot · 2018-02-19T07:03:39Z

tests/components/sensor/test_folder.py

+            setup_component(self.hass, 'sensor', config))
+        assert len(self.hass.states.entity_ids()) == 1
+        state = self.hass.states.get('sensor.test_folder')
+        #assert state.state == '0.0'


block comment should start with '# '

robmarkcole · 2018-02-20T05:08:57Z

@MartinHjelmare @arsaboo @balloob @fabaff I've made all the required changes now, don't know what that strange error from Travis is about. Cheers

Fix setup with else statement

balloob · 2018-02-20T07:59:06Z

homeassistant/components/sensor/folder.py

+        self._number_of_files = None
+        self._recent_modified_file = None
+        self._last_updated = None
+        self._name = folder_path.split("/")[-2]


You must not use Windows

As in, this will not work on Windows? OK will try something else

Use https://docs.python.org/3/library/os.path.html#os.path.split or Pathlib

balloob · 2018-02-20T08:03:15Z

homeassistant/components/sensor/folder.py

+            'filter': self._filter_term,
+            'modified_file': self._recent_modified_file.split('/')[-1],
+            'number_of_files': len(self._sorted_files_list),
+            'files': [f.split('/')[-1] for f in self._sorted_files_list]


balloob · 2018-02-21T06:28:32Z

homeassistant/components/sensor/folder.py

+            'filter': self._filter_term,
+            'modified_file': os.path.split(self._recent_modified_file)[1],
+            'number_of_files': len(self._sorted_files_list),
+            'files': [os.path.split(f)[1] for f in self._sorted_files_list]


We should not do this. This is way too much data for in the state machine.

balloob · 2018-02-21T07:25:51Z

homeassistant/components/sensor/folder.py

+        attr = {
+            'path': self._folder_path,
+            'filter': self._filter_term,
+            'modified_file': os.path.split(self._recent_modified_file)[1],


Let's drop this attribute. If people want this info, we should get a watchdog component to monitor folders/files and fire events. If people want to automate on this, it will not work if 2 files get added between 2 updates. Then they want to have that fixed etc. I think that we should have people do the right thing right away by not including this, so they will look for the watchdog component instead.

balloob · 2018-02-21T07:26:30Z

homeassistant/components/sensor/folder.py

+
+    def update(self):
+        """Update the sensor."""
+        self._sorted_files_list = get_sorted_files_list(


It's better if we don't keep this in memory but instead only set the instance variables that we want to derive from it.

robmarkcole · 2018-02-22T06:04:40Z

@balloob and @MartinHjelmare all changes have beeb made I believe

Adds folder sensor

ffd634f

The state of the sensor is the time that the most recently modified file in a folder was modified.

homeassistant added cla-signed new-platform platform: sensor.folder labels Feb 6, 2018

robmarkcole mentioned this pull request Feb 6, 2018

Adds folder sensor home-assistant/home-assistant.io#4588

Merged

1 task

Address lint errors

f9707ce

homeassistant added the cla-signed label Feb 6, 2018

arsaboo reviewed Feb 6, 2018

View reviewed changes

Edit docstrings

adbbabc

Makes the recommended edits to docstrings

robmarkcole added 2 commits February 7, 2018 06:46

Update .coveragerc

16c078b

Add sensor/folder.py

Update folder.py

5ee5e0d

balloob requested changes Feb 11, 2018

View reviewed changes

MartinHjelmare requested changes Feb 12, 2018

View reviewed changes

robmarkcole added a commit to robmarkcole/HASS-folder-sensor that referenced this pull request Feb 12, 2018

Address requested changes

6a49c80

Address requested changes in home-assistant/core#12208

Address requests

929b532

Address requests changes

homeassistant added the cla-signed label Feb 12, 2018

MartinHjelmare approved these changes Feb 12, 2018

View reviewed changes

MartinHjelmare requested changes Feb 12, 2018

View reviewed changes

robmarkcole added 2 commits February 16, 2018 05:25

Adds folder

2c8bfc0

Adds test, tidy up

54739fb

houndci-bot reviewed Feb 19, 2018

View reviewed changes

robmarkcole and others added 3 commits February 19, 2018 07:05

Tidy

5c8a792

Update test_folder.py

c4cef26

Update folder.py

07462e7

Fix setup

51bc020

Fix setup with else statement

homeassistant added the cla-signed label Feb 20, 2018

balloob reviewed Feb 20, 2018

View reviewed changes

robmarkcole added 2 commits February 20, 2018 21:23

Update folder.py

6cb0695

Update folder.py

e3615f8

balloob reviewed Feb 21, 2018

View reviewed changes

robmarkcole added 2 commits February 21, 2018 06:34

Remove list of files from attributes

117be0d

Update test_folder.py

8c0c0a2

balloob reviewed Feb 21, 2018

View reviewed changes

robmarkcole added 4 commits February 21, 2018 17:17

Update folder.py

ff5872c

Update test_folder.py

8fd2a71

Update folder.py

6676eff

Update folder.py

1974a7f

balloob approved these changes Feb 22, 2018

View reviewed changes

balloob merged commit 4d7fb2c into home-assistant:dev Feb 22, 2018

robmarkcole deleted the folder-sensor branch February 22, 2018 07:24

balloob mentioned this pull request Feb 22, 2018

0.64.0 #12609

Merged

home-assistant locked and limited conversation to collaborators May 29, 2018

ghost added integration: folder and removed platform: sensor.folder labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds folder sensor #12208

Adds folder sensor #12208

robmarkcole commented Feb 6, 2018 •

edited

Loading

arsaboo Feb 6, 2018 •

edited

Loading

arsaboo Feb 6, 2018

Qxlkdr commented Feb 6, 2018

balloob Feb 11, 2018

MartinHjelmare Feb 12, 2018

MartinHjelmare Feb 12, 2018

MartinHjelmare Feb 12, 2018

MartinHjelmare Feb 12, 2018

MartinHjelmare Feb 12, 2018

MartinHjelmare left a comment

MartinHjelmare left a comment

houndci-bot Feb 19, 2018

robmarkcole commented Feb 20, 2018 •

edited

Loading

balloob Feb 20, 2018

robmarkcole Feb 20, 2018

balloob Feb 20, 2018

robmarkcole Feb 20, 2018

balloob Feb 20, 2018

robmarkcole Feb 20, 2018

balloob Feb 21, 2018

robmarkcole Feb 21, 2018

balloob Feb 21, 2018

robmarkcole Feb 21, 2018

balloob Feb 21, 2018

robmarkcole Feb 21, 2018

robmarkcole commented Feb 22, 2018

Adds folder sensor #12208

Adds folder sensor #12208

Conversation

robmarkcole commented Feb 6, 2018 • edited Loading

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

arsaboo Feb 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Qxlkdr commented Feb 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MartinHjelmare left a comment

Choose a reason for hiding this comment

MartinHjelmare left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robmarkcole commented Feb 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robmarkcole commented Feb 22, 2018

robmarkcole commented Feb 6, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

arsaboo Feb 6, 2018 •

edited

Loading

robmarkcole commented Feb 20, 2018 •

edited

Loading