WebDAV sensor #19758
WebDAV sensor #19758
Conversation
This sensor monitors a WebDAV share. Its state is simply a boolean of whether the share is available or not. It has a `files` attribute that lists all files in the share.
ghost
added
the
The Depict art frame (https://depict.com) is a wall-mounted 49" 4K display that looks like a picture frame. It seems to be mostly intended to view curated art collections (most of which are paid subscriptions). The app that comes with it allows one-off uploading of photos, but has no slideshow support or similar. Home Assistant to the rescue! This component allows Home Assistant to turn the frame on and off, adjust brightness and contrast, and set what image is displayed on the frame. By combining this component with a [`random`](https://www.home-assistant.io/components/sensor.random/) sensor, a `webdav` sensor (home-assistant#19758), and a templated action, Home Assistant can run a shuffled slideshow of images on the frame.
The Depict art frame (https://depict.com) is a wall-mounted 49" 4K display that looks like a picture frame. It seems to be mostly intended to view curated art collections (most of which are paid subscriptions). The app that comes with it allows one-off uploading of photos, but has no slideshow support or similar. Home Assistant to the rescue! This component allows Home Assistant to turn the frame on and off, adjust brightness and contrast, and set what image is displayed on the frame. By combining this component with a [`random`](https://www.home-assistant.io/components/sensor.random/) sensor, a `webdav` sensor (home-assistant#19758), and a templated action, Home Assistant can run a shuffled slideshow of images on the frame.
The Depict art frame (https://depict.com) is a wall-mounted 49" 4K display that looks like a picture frame. It seems to be mostly intended to view curated art collections (most of which are paid subscriptions). The app that comes with it allows one-off uploading of photos, but has no slideshow support or similar. Home Assistant to the rescue! This component allows Home Assistant to turn the frame on and off, adjust brightness and contrast, and set what image is displayed on the frame. By combining this component with a [`random`](https://www.home-assistant.io/components/sensor.random/) sensor, a `webdav` sensor (home-assistant#19758), and a templated action, Home Assistant can run a shuffled slideshow of images on the frame.
If there are only two states then it should be a binary sensor. |
| @property | ||
| def unique_id(self): | ||
| """Return the URL for the share.""" | ||
| return self._get_url("") |
There was a problem hiding this comment.
Unique IDs should be truly unique. For example if the user changes the path of this sensor, it will have another unique ID and thus an entity_id with _2 added at the end. See https://developers.home-assistant.io/docs/en/entity_registry_index.html#unique-id-requirements for requirements.
There was a problem hiding this comment.
If the user changes the URL, the sensor is now monitoring a different share. Doesn't that make it a different sensor?
- `state_attributes` -> `device_state_attributes` - remove unnecessary `str` - try to connect in `setup_platform`
| from webdav3.client import Client | ||
| from webdav3.exceptions import WebDavException | ||
|
|
||
| name = config.get(CONF_NAME) |
There was a problem hiding this comment.
config[CONF_NAME] as CONF_NAME is required
| from webdav3.exceptions import WebDavException | ||
|
|
||
| name = config.get(CONF_NAME) | ||
| host = config.get(CONF_HOST) |
| return self._name | ||
|
|
||
| @property | ||
| def unique_id(self): |
There was a problem hiding this comment.
Really should be left out ... it's by no mean unique
There was a problem hiding this comment.
You're the second person to push back on this identifier, and I really don't understand it. As I read the wiki, the unique ID must be unique within the platform (i.e. sensor.webdav). The URL of the share is the identity of the thing being observed, just like a device serial number or MAC address (examples from the unique ID docs) identifies a device. I could enforce that people cannot configure multiple sensors for the same URL if you guys want, but I haven't seen other platforms prevent the same device from being referenced twice in configuration, even though they use device serial numbers for unique IDs. What am I missing?
There was a problem hiding this comment.
The thing with unique_id's is that they will live forever in HA (even after you remove the configuration). MAC, EUI, etc aren't user configurable, and that's what's set them apart.
Why don't you add a friendly_name configuration parameter instead?
| def device_state_attributes(self): | ||
| """Return the list of files on the share.""" | ||
| return { | ||
| "files": self._files, |
There was a problem hiding this comment.
I'm concerned this list can become very big and blow up the UI... can we have a limit on the number of files here at least ? say 10 ?
There was a problem hiding this comment.
It could become very large indeed. However, limiting the files, particularly to a number as small as 10, makes it useless for the scenario that's motivating this component for me (driving slideshows in a photo frame). Another alternative I considered was exposing a service that one would have to call to get the data somehow. The simplest thing would be to have that service populate this state field (instead of populating it all the time, so at least if it's blowing up the UI you have a way to make it not do so). Another approach would be to pass a template to the service, which it would evaluate against the file list and then pass to another service call. Would either of those be acceptable?
There was a problem hiding this comment.
OK, you described a use case that is by no means related to this PR.
This binary_sensor is about connectivity (see your DEVICE_CLASS). It should be just about availability of the webdav server an nothing more.
What you wan't is an entity that feeds you files into your photo frame, right ? I think you could model your use case through a camera, but I need to understand better your use-case, can you describe in more detail the end result you expect ?
There was a problem hiding this comment.
Camera... that's an interesting idea.
So I've got two kinds of photo frames I'm working with. The API for the Depict lets you give it a URL and the frame will download the photo. The other (the Samsung Frame TV) lets you upload the photo to the frame. Neither has slideshow support on the frame itself, so I'm looking to build that with HA.
What I have going with the Depict now is this webdav sensor listing available photos, a random sensor driving which photo should appear, and a template action using the value of the random sensor to pick a URL from the webdav sensor to send to the Depict. I haven't started on the Samsung yet but I imagine I'll drive it similarly, only have the HA component download the photo from the URL and then send it to the frame. Modeling the WebDAV share as a camera could simplify that stuff, and open up new possibilities like sending surveillance camera images to the frames in response to certain events, which would be cool.
This kind of setup works, and has the advantage of decoupling the image source from the photo frames -- one could add cameras for various cloud storage providers, social media sites, whatever, and use those just as easily as this WebDAV thing, without each different kind of frame having to have explicit support for each service. However, it's not ideal.
What would be really nice is if the photo frame media player entities could support play/pause/forward/backward/shuffle/etc... the way I have it set up right now (and the way I'm imagining a camera component would work), none of that is controllable by the media player since the media player is just given one image at a time. I think the existing media players each have their own intrinsic notion of a playlist, and I could add playlist support to depict-control, but I do really like this idea of being able to use Home Assistant to plumb images from any source to any display device. Is there a type of device that would make sense for providing a list of images that a media player could use as a playlist?
There was a problem hiding this comment.
Very long thread :)
IMHO I would split Depict from the Samsung Frame TV.
For Depict, you really just need a camera, you pass the camera URL to Depict and that's it. Don't call it camera.depict, call it camera.webdav. It would be nice to have such camera showing up family pictures in the middle of the interface :)
For samsung frame tv... definitely a media_player, ultimately that's what you're doing...
The issue now is the playlist.... for the camera.webdav, the playlist can be part of the component (that is something IMHO fits into the scope of the "camera"... but don't take my word for it). Another option would be to create a new component just for the purpose of the playlist's...
I think we should take baby steps and learn in the process, why don't you start with the camera.webdav ? I would use it :)
|
We should not merge this . This is clearly an integration built for a very specific purpose, which does not fit with the general theme of Home Assistant integrations. A webdav integration would be a component that fires events whenever a file has changed. We should not abuse our state machine to transfer data for automations. |
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.
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.
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.
Description:
This sensor monitors a WebDAV share. Its state is simply a boolean
of whether the share is available or not. It has a
filesattributethat lists all files in the share.
Related issue (if applicable): n/a
Pull request in home-assistant.io with documentation (if applicable): home-assistant/home-assistant.io#8038
Example entry for
configuration.yaml(if applicable):Checklist:
tox. Your PR cannot be merged unless tests passIf user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
REQUIREMENTSvariable (example).requirements_all.txtby runningscript/gen_requirements_all.py..coveragerc.If the code does not interact with devices: