WebDAV camera #22607

jkeljo · 2019-04-01T03:10:38Z

Breaking Change:

None

Description:

As suggested by @dgomes in #19758, here's a camera backed by image files on
a WebDAV share. The entity exposes a stream and individual images, iterating
through the images in sorted order by filename at a configurable rate.

Related issue (if applicable): N/A

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

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

sensor:
  - platform: webdav
    name: file_server
    host: 'https://server.name'
    image_interval: '1:00'

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.

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

Documentation added/updated in home-assistant.io

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

New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Tests have been added to verify that the new code works.

@dgomes

As suggested by @dgomes in home-assistant#19758, here's a camera backed by image files on a WebDAV share. The entity exposes a stream and individual images, iterating through the images in sorted order by filename at a configurable rate.

homeassistant/components/webdav/camera.py

dgomes

Maybe instead of the wait_and_advance() you could use async_track_time_change from homeassistant.helpers.event

awarecan · 2019-04-04T16:37:59Z

It is harsh time for new integration as we are doing refactoring, we are now requesting all components has to have a manifest file.

Please rebase you branch against current dev branch, and create a manifest.json file under your component's folder.

You may need to do more rebase in the next few days as we are still in the progress of refactoring.

jkeljo · 2019-04-07T00:11:59Z

@dgomes, thanks for the pointer! I see async_track_time_interval in that same file, which seems to be more what I want.

@awarecan, no worries, I know how it goes. I can roll with it. :-)

dgomes · 2019-04-18T14:28:59Z

Can you please rebase ? There several changes in the core that must be tested with this component before any merge.

homeassistant/components/webdav/manifest.json

homeassistant/components/webdav/camera.py

MartinHjelmare · 2019-07-14T16:03:46Z

@jkeljo are you planning to continue here?

jkeljo · 2019-07-14T18:55:20Z

Yep, definitely. Just a matter of finding some free time, hopefully in the next couple weeks. If it’s cluttering things up for you, feel free to close it out and I’ll open another when I can get back to it.

…

On July 14, 2019 at 9:04:32 AM, Martin Hjelmare ***@***.******@***.***)) wrote: @jkeljo(https://github.com/jkeljo) are you planning to continue here? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub(#22607), or mute the thread(https://github.com/notifications/unsubscribe-auth/ABTZNWKKNISVGJS7RDEZ3LTP7NFBBANCNFSM4HCTBN3A).

MartinHjelmare · 2019-07-14T19:01:49Z

@jkeljo please close, since then you can open this PR again yourself, when you have time, and we can keep the comment history in one place.

balloob · 2019-07-15T21:57:01Z

oops, waiting for @jkeljo to close, so he can also re-open it, compared to when I close it.

I think I was thinking in another language, since this was not valid Python. Result was that the thread that maintained the SocketIO connection to the table would die early on, so no status updates were actually flowing from the table.

homeassistant/components/sisyphus/__init__.py

MartinHjelmare

Be wary of mixing sync and async calls in the same context. Coroutines should be awaited in async context and blocking (sync) I/O is not allowed in async context.

MartinHjelmare · 2019-11-01T08:24:41Z

homeassistant/components/webdav/camera.py

+This component models a WebDAV share full of images as a camera.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/camera.webdav/


We don't add the url to the docstring anymore. Just keep the very first line.

MartinHjelmare · 2019-11-01T08:25:24Z

homeassistant/components/webdav/camera.py

+"""
+
+import logging
+


Please remove this blank line. I recommend the isort tool to automatically sort and group imports.

MartinHjelmare · 2019-11-01T08:25:49Z

homeassistant/components/webdav/camera.py

+
+import asyncio
+from datetime import timedelta
+from aiohttp import ClientError


Please add a blank line between standard library and 3rd party import groups.

MartinHjelmare · 2019-11-01T08:27:31Z

homeassistant/components/webdav/camera.py

+            "webdav_root": path,
+        }
+    )
+    session = async_get_clientsession(hass)


This should be called in async context. Currently we're in sync context.

MartinHjelmare · 2019-11-01T08:27:56Z

homeassistant/components/webdav/camera.py

+SCAN_INTERVAL = timedelta(minutes=15)
+
+
+def setup_platform(hass, config, add_entities, discovery_info=None):


Change def setup_platform to async def async_setup_platform.

Please rename add_entities to async_add_entities.

MartinHjelmare · 2019-11-01T08:29:58Z

homeassistant/components/webdav/camera.py

+            update_before_add=True,
+        )
+    except WebDavException as exception:
+        _LOGGER.warning("Failed to connect to %s: %s", client.get_url(""), exception)


Does client.get_url make I/O?

MartinHjelmare · 2019-11-01T08:31:25Z

homeassistant/components/webdav/camera.py

+        while images_checked < len(self._files):
+            self._image_number += 1
+            images_checked += 1
+            content_type = self._client.get_property(


This makes I/O so needs to be scheduled on the executor thread pool. Use await self.hass.async_add_executor_job(...).

MartinHjelmare · 2019-11-01T08:32:25Z

homeassistant/components/webdav/camera.py

+        """Return True if the camera is playing through files in the share."""
+        return self._stop_advancing is not None
+
+    def turn_on(self):


This should be a coroutine and rename it to async_turn_on.

MartinHjelmare · 2019-11-01T08:32:49Z

homeassistant/components/webdav/camera.py

+                self.hass, self._advance, self._image_interval
+            )
+
+    def turn_off(self):


MartinHjelmare · 2019-11-01T08:34:38Z

homeassistant/components/webdav/camera.py

+    async def async_added_to_hass(self):
+        """Set up periodic image advancement."""
+        self._image_lock = asyncio.Lock()
+        self.turn_on()


await self.async_turn_on()

balloob · 2019-11-26T00:02:03Z

This PR seems to have gone stale. Closing it.

WebDAV camera

b78380e

As suggested by @dgomes in home-assistant#19758, here's a camera backed by image files on a WebDAV share. The entity exposes a stream and individual images, iterating through the images in sorted order by filename at a configurable rate.

homeassistant added cla-signed integration: webdav new-integration new-platform labels Apr 1, 2019

ghost added the in progress label Apr 1, 2019

houndci-bot reviewed Apr 1, 2019

View reviewed changes

homeassistant/components/webdav/camera.py Outdated Show resolved Hide resolved

lint

3ddb052

jkeljo mentioned this pull request Apr 1, 2019

Documentation for the new WebDAV camera. home-assistant/home-assistant.io#9085

Closed

2 tasks

rohankapoorcom reviewed Apr 1, 2019

View reviewed changes

homeassistant/components/webdav/camera.py Outdated Show resolved Hide resolved

rohankapoorcom reviewed Apr 1, 2019

View reviewed changes

homeassistant/components/webdav/camera.py Outdated Show resolved Hide resolved

rohankapoorcom reviewed Apr 1, 2019

View reviewed changes

homeassistant/components/webdav/camera.py Show resolved Hide resolved

rohankapoorcom reviewed Apr 1, 2019

View reviewed changes

homeassistant/components/webdav/camera.py Show resolved Hide resolved

Feedback

afdf0bf

dgomes reviewed Apr 2, 2019

View reviewed changes

Use async_track_time_interval to handle advance intervals for me

997ce27

jkeljo added 3 commits April 6, 2019 17:13

Merge remote-tracking branch 'upstream/dev' into webdav

4418979

Upgrade to webdavclient3 0.11

b4f3dd8

Add manifest file

f07e126

This comment has been minimized.

Sign in to view

Merge remote-tracking branch 'upstream/dev' into webdav

b07168f

Quentame reviewed Jun 12, 2019

View reviewed changes

homeassistant/components/webdav/manifest.json Outdated Show resolved Hide resolved

balloob reviewed Jun 18, 2019

View reviewed changes

homeassistant/components/webdav/camera.py Outdated Show resolved Hide resolved

balloob reviewed Jun 18, 2019

View reviewed changes

homeassistant/components/webdav/camera.py Outdated Show resolved Hide resolved

balloob reviewed Jun 18, 2019

View reviewed changes

homeassistant/components/webdav/camera.py Outdated Show resolved Hide resolved

balloob reviewed Jun 18, 2019

View reviewed changes

homeassistant/components/webdav/camera.py Outdated Show resolved Hide resolved

balloob reviewed Jun 18, 2019

View reviewed changes

homeassistant/components/webdav/camera.py Outdated Show resolved Hide resolved

balloob closed this Jul 15, 2019

balloob reopened this Jul 15, 2019

jkeljo closed this Jul 15, 2019

jkeljo added 2 commits August 17, 2019 11:48

Merge remote-tracking branch 'upstream/dev' into webdav

b46640d

Feedback

2a05cb5

jkeljo reopened this Aug 17, 2019

This comment has been minimized.

Sign in to view

jkeljo added 3 commits August 17, 2019 16:06

Regenerate CODEOWNERS

873c762

Fix background crash in sisyphus integration

b2924ea

I think I was thinking in another language, since this was not valid Python. Result was that the thread that maintained the SocketIO connection to the table would die early on, so no status updates were actually flowing from the table.

Update requirements

ad0efbe

MartinHjelmare requested changes Aug 18, 2019

View reviewed changes

homeassistant/components/sisyphus/__init__.py Outdated Show resolved Hide resolved

jkeljo added 2 commits August 18, 2019 19:02

Merge remote-tracking branch 'upstream/dev' into webdav

a9ba4f8

Merge remote-tracking branch 'upstream/dev' into webdav

f4e5c09

MartinHjelmare added this to Needs review in Dev Sep 23, 2019

jkeljo requested a review from MartinHjelmare November 1, 2019 04:06

MartinHjelmare requested changes Nov 1, 2019

View reviewed changes

Dev automation moved this from Needs review to Review in progress Nov 1, 2019

balloob closed this Nov 26, 2019

Dev automation moved this from Review in progress to Cancelled Nov 26, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WebDAV camera #22607

WebDAV camera #22607

jkeljo commented Apr 1, 2019 •

edited

dgomes left a comment

awarecan commented Apr 4, 2019

jkeljo commented Apr 7, 2019

This comment has been minimized.

dgomes commented Apr 18, 2019

MartinHjelmare commented Jul 14, 2019

jkeljo commented Jul 14, 2019 via email

MartinHjelmare commented Jul 14, 2019

balloob commented Jul 15, 2019

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

MartinHjelmare left a comment

MartinHjelmare Nov 1, 2019

MartinHjelmare Nov 1, 2019

MartinHjelmare Nov 1, 2019

MartinHjelmare Nov 1, 2019

MartinHjelmare Nov 1, 2019

MartinHjelmare Nov 1, 2019

MartinHjelmare Nov 1, 2019

MartinHjelmare Nov 1, 2019

MartinHjelmare Nov 1, 2019

MartinHjelmare Nov 1, 2019

MartinHjelmare Nov 1, 2019

balloob commented Nov 26, 2019

		SCAN_INTERVAL = timedelta(minutes=15)


		def setup_platform(hass, config, add_entities, discovery_info=None):

WebDAV camera #22607

WebDAV camera #22607

Conversation

jkeljo commented Apr 1, 2019 • edited

Breaking Change:

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

dgomes left a comment

Choose a reason for hiding this comment

awarecan commented Apr 4, 2019

jkeljo commented Apr 7, 2019

This comment has been minimized.

dgomes commented Apr 18, 2019

MartinHjelmare commented Jul 14, 2019

jkeljo commented Jul 14, 2019 via email

MartinHjelmare commented Jul 14, 2019

balloob commented Jul 15, 2019

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

MartinHjelmare left a 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

Choose a reason for hiding this comment

balloob commented Nov 26, 2019

jkeljo commented Apr 1, 2019 •

edited

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