You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-20Lines changed: 21 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Imagedirectory
2
-
Homeassistant custom component for serveral operations on snapshots images and display the images in a **native homeassistant camera** entity.
2
+
Homeassistant custom component for serveral operations on snapshots images and display the images in a **homeassistant camera** entity.
3
3
4
4
Supported operations:
5
5
- compose an animated GIF or MP4 of selected snapshot (PNG, JPEG)
@@ -15,9 +15,9 @@ This integration provides 3 methods for this:
15
15
- display the snapshots with a camera entity within homeassistant
16
16
The camera is using the selected snapshots directly from files **without** a intermediate format
17
17
18
-
The platform is designed for general use of converting snapshot to GIF or MP4, so it is useful for everyone who has to handle or deal with snapshots created by cameras of image processing software. The component can also be used to create a slideshow of pictures or create a timelaps video/camera from pictures in a directory
18
+
The platform is designed for general use of converting snapshots to animated GIF or MP4, so it is useful for everyone who has to handle or deal with snapshots created by cameras of image processing software. The component can also be used to create a slideshow of pictures or create a timelaps video/camera from pictures in a directory
19
19
20
-
Platform setup
20
+
# Platform setup
21
21
22
22
To use this component, copy the directory `imagedirectory`and it contents to the `custom_components` directory of your homeassistant.
23
23
@@ -53,13 +53,13 @@ This service has to be called with the following calll-parameters:
53
53
| destinationpath | path of the directory where the GIF should be created | mandatory, directory must exist |
54
54
| filename | Name for gif/mp3 file (without extension) | optional, default=latest |
55
55
| format | `gif` or `mp4` | optional, default='gif' |
56
-
| excludelist | list of files to exclude in conversion |optional |
56
+
| exclude | list of files to exclude in conversion |optional |
57
57
| begintimestamp | begin timestamp | optional, format 'mm/dd/yyyy hh:mm:ss' |
58
58
| endtimestamp | end timestamp | optional, format 'mm/dd/yyyy hh:mm:ss' |
59
59
60
60
## File selection
61
61
62
-
With the parameter `excludelist` you could **exclude** certain files that should not be added in the created output file (gif or mp4)
62
+
With the parameter `exclude` you could **exclude** certain files that should not be added in the created output file (gif or mp4)
63
63
64
64
Most solutions create a timestamped snapshot file and also a snapshot file with a fixed filename (for exampe: deepstack_object_xxxx_latest.jpg). In most cases you want to exclude such a file in the output file.
65
65
@@ -161,21 +161,22 @@ For example the event, in case of the service call: ` imagedirectort.create_gif_
161
161
```
162
162
# Camera entity
163
163
164
-
Altough the generated gif or mp4 could be easyli displayed using the existing available camera entities in homeassistant, the availbilty of a camera component that is capable of directly serving the images to a camera component is much easier, more flexible and more user friendly.
164
+
Altough the generated gif or mp4 could be easily displayed using the existing available camera entities in homeassistant, the availbilty of a camera component that is capable of directly serving the images to a camera component is much easier, more flexible and more user friendly.
165
165
166
166
## Configuration
167
167
To enable this camera in your installation, you must first have an existing directory with images files
168
-
Next, add the following to your `configuration.yaml` file:
169
-
168
+
Next, add the following to your `configuration.yaml` file in the camera section:
The example above selects only the files, from the last 2 hours, since the time of the latest file in the directory `/config/snapshots/oprit` to display in the camera with a default delay of 1 sec between the images.
The example above selects only the files, from the last 2 hours, since the time of the latest file in the directory `/config/snapshots/achtertuin` to display in the camera with a default delay of 1 sec between the images.
179
180
180
181
181
182
## Configuration variables
@@ -192,9 +193,9 @@ The example above selects only the files, from the last 2 hours, since the time
192
193
193
194
The file selection function defined by exclude and the timestamps are identical as in the use with `imagedirectory.create_gif_mp4` service.
194
195
195
-
The only addition is the `lasthours` parameter that allows you to select only the latest `x` hours from the latest images within the given timerange. This parameters allows you to only include the snapshots that are made for example the last 2 hours to display in the camera.
196
+
The only addition is the `lasthours` parameter that allows you to select only the latest `x.x` hours from the latest images within the given timerange. This parameters allows you to only include the snapshots that are made (for example) the last 2 hours to display in the camera.
196
197
197
-
The No. of files and the selected files that the camera is using is available as Attribute and could be examind under the developer tools unde the STATES tab.
198
+
The No. of files and the selected files that the camera is using are available as Attribute and could be examined under the developer tools under the STATES tab.
198
199
199
200
## Camera services
200
201
@@ -358,12 +359,12 @@ mode: single
358
359
359
360
```
360
361
361
-
#### Example 2: Script to archive snapshot from the past day to a mp4
362
+
### Example 2: Script to archive snapshots from the past day to a mp4
362
363
363
-
This example shows an script to archive the created snaphots that a made during the previous automating. I schedule this script for example at 00:05:00
364
+
This example shows an script to archive the created snaphots, that a made during the previous automation. I schedule this script for example at 00:05:00
364
365
365
366
**Step 1**
366
-
Create begintime and endtime for the imagedirectory services. With the variable daysback you can control from which day you want to archive the snapshots. In mycase i want to archive the previous day. The file that is created will have a date in its filename included
367
+
Create begintime and endtime for the imagedirectory services. With the variable `daysback` you can control from which day you want to archive the snapshots. In mycase i want to archive the previous day. The file that is created will have a date in its filename included
0 commit comments