Merge pull request #260 from dermotduffy/static-image-refresh

Avoid caching of static images to ensure they are refreshed
This commit is contained in:
Dermot Duffy
2022-01-17 17:08:43 -08:00
committed by GitHub
3 changed files with 40 additions and 5 deletions
+19 -1
View File
@@ -336,7 +336,7 @@ image:
| Option | Default | Overridable | Description | | Option | Default | Overridable | Description |
| - | - | - | - | | - | - | - | - |
| `src` | | :heavy_multiplication_x: | [embedded image](https://www.flickr.com/photos/dianasch/47543120431) | A static image URL for use with the `image` [view](#views).| | `src` | | :heavy_multiplication_x: | [embedded image](https://www.flickr.com/photos/dianasch/47543120431) | A static image URL for use with the `image` [view](#views). Note that a `t=[timestsamp]` query parameter will be automatically added to this URL such that the image will not be cached by the browser. |
| `actions` | | :heavy_multiplication_x: | Actions to use for the `image` view. See [actions](#actions) below.| | `actions` | | :heavy_multiplication_x: | Actions to use for the `image` view. See [actions](#actions) below.|
### Dimension Options ### Dimension Options
@@ -1075,6 +1075,24 @@ overrides:
</details> </details>
### Refreshing a static image
<details>
<summary>Expand: Auto-refreshing a static image</summary>
This example fetches a static image every 10 seconds (in this case the latest image saved on the Frigate server for a given camera).
```yaml
[...]
view:
default: image
timeout: 10
update_force: true
image:
src: https://my-friage-server/api/living_room/latest.jpg
```
</details>
<a name="card-updates"></a> <a name="card-updates"></a>
## Card Refreshes ## Card Refreshes
+4 -1
View File
@@ -1184,7 +1184,10 @@ export class FrigateCard extends LitElement {
return html` return html`
${!this._message && this._view.is('image') ${!this._message && this._view.is('image')
? html` <frigate-card-image .imageConfig=${this._getConfig().image}> ? html` <frigate-card-image
.imageConfig=${this._getConfig().image}
.view=${this._view}
>
</frigate-card-image>` </frigate-card-image>`
: ``} : ``}
${!this._message && this._view.isGalleryView() ${!this._message && this._view.isGalleryView()
+17 -3
View File
@@ -4,22 +4,36 @@ import { customElement, property } from 'lit/decorators.js';
import { dispatchMediaShowEvent } from '../common.js'; import { dispatchMediaShowEvent } from '../common.js';
import type { ImageViewConfig } from '../types.js'; import type { ImageViewConfig } from '../types.js';
import defaultImage from '../images/frigate-bird-in-sky.jpg' import defaultImage from '../images/frigate-bird-in-sky.jpg';
import imageStyle from '../scss/image.scss'; import imageStyle from '../scss/image.scss';
import { View } from '../view.js';
@customElement('frigate-card-image') @customElement('frigate-card-image')
export class FrigateCardImage extends LitElement { export class FrigateCardImage extends LitElement {
@property({ attribute: false }) @property({ attribute: false })
protected imageConfig?: ImageViewConfig; protected imageConfig?: ImageViewConfig;
// A new view should trigger an image re-render.
@property({ attribute: false })
protected view?: Readonly<View>;
protected _getImageSource(): string {
if (this.imageConfig?.src) {
const url = new URL(this.imageConfig.src);
url.searchParams.append('t', String(Date.now()));
return url.toString();
}
return defaultImage;
}
protected render(): TemplateResult | void { protected render(): TemplateResult | void {
return html` <img return html` <img
src=${this.imageConfig?.src || defaultImage} src=${this._getImageSource()}
@load=${(e) => { @load=${(e) => {
dispatchMediaShowEvent(this, e); dispatchMediaShowEvent(this, e);
}} }}
>`; />`;
} }
static get styles(): CSSResultGroup { static get styles(): CSSResultGroup {