s/human/user/
This commit is contained in:
@@ -135,9 +135,9 @@ view:
|
|||||||
| Option | Default | Overridable | Description |
|
| Option | Default | Overridable | Description |
|
||||||
| - | - | - | - |
|
| - | - | - | - |
|
||||||
| `default` | `live` | :heavy_multiplication_x: | The view to show in the card by default. See [views](#views) below.|
|
| `default` | `live` | :heavy_multiplication_x: | The view to show in the card by default. See [views](#views) below.|
|
||||||
| `timeout_seconds` | `300` | :heavy_multiplication_x: | A numbers of seconds of inactivity after human interaction, after which the card will reset to the default configured view (i.e. 'screensaver' functionality). Inactivity is defined as lack of mouse/touch interaction with the Frigate card. If the default view occurs sooner (e.g. via `update_seconds` or manually) the timer will be stopped. `0` means disable this functionality. |
|
| `timeout_seconds` | `300` | :heavy_multiplication_x: | A numbers of seconds of inactivity after user interaction, after which the card will reset to the default configured view (i.e. 'screensaver' functionality). Inactivity is defined as lack of mouse/touch interaction with the Frigate card. If the default view occurs sooner (e.g. via `update_seconds` or manually) the timer will be stopped. `0` means disable this functionality. |
|
||||||
| `update_seconds` | `0` | :heavy_multiplication_x: | A number of seconds after which to automatically update/refresh the default view. See [card updates](#card-updates) below for behavior and usecases. If the default view occurs sooner (e.g. manually) the timer will start over. `0` disables this functionality.|
|
| `update_seconds` | `0` | :heavy_multiplication_x: | A number of seconds after which to automatically update/refresh the default view. See [card updates](#card-updates) below for behavior and usecases. If the default view occurs sooner (e.g. manually) the timer will start over. `0` disables this functionality.|
|
||||||
| `update_force` | `false` | :heavy_multiplication_x: | Whether automated card updates/refreshes should ignore human interaction. See [card updates](#card-updates) below for behavior and usecases.|
|
| `update_force` | `false` | :heavy_multiplication_x: | Whether automated card updates/refreshes should ignore user interaction. See [card updates](#card-updates) below for behavior and usecases.|
|
||||||
| `update_entities` | | :heavy_multiplication_x: | **YAML only**: A list of entity ids that should cause the view to reset to the default. See [card updates](#card-updates) below for behavior and usecases.|
|
| `update_entities` | | :heavy_multiplication_x: | **YAML only**: A list of entity ids that should cause the view to reset to the default. See [card updates](#card-updates) below for behavior and usecases.|
|
||||||
| `update_cycle_camera` | `false` | :heavy_multiplication_x: | When set to `true` the selected camera is cycled on each default view change. |
|
| `update_cycle_camera` | `false` | :heavy_multiplication_x: | When set to `true` the selected camera is cycled on each default view change. |
|
||||||
| `actions` | | :heavy_multiplication_x: | Actions to use for all views, individual actions may be overriden by view-specific actions. See [actions](#actions) below.|
|
| `actions` | | :heavy_multiplication_x: | Actions to use for all views, individual actions may be overriden by view-specific actions. See [actions](#actions) below.|
|
||||||
@@ -603,7 +603,7 @@ format](https://www.home-assistant.io/lovelace/actions/#tap-action) as well as
|
|||||||
the custom [Frigate card action](#frigate-card-action) to trigger Frigate card
|
the custom [Frigate card action](#frigate-card-action) to trigger Frigate card
|
||||||
changes.
|
changes.
|
||||||
|
|
||||||
**Note:** The card itself obviously relies on human interactions to function
|
**Note:** The card itself obviously relies on user interactions to function
|
||||||
(e.g. `tap` on the menu should activate that button, `tap` on a gallery thumbnail
|
(e.g. `tap` on the menu should activate that button, `tap` on a gallery thumbnail
|
||||||
should open that piece of media, etc). These internal actions are executed
|
should open that piece of media, etc). These internal actions are executed
|
||||||
_also_, which means that a card-wide `tap` action probably isn't that useful as
|
_also_, which means that a card-wide `tap` action probably isn't that useful as
|
||||||
@@ -1098,7 +1098,7 @@ image:
|
|||||||
## Card Refreshes
|
## Card Refreshes
|
||||||
|
|
||||||
Four sets of flags govern when the card will automatically refresh in the
|
Four sets of flags govern when the card will automatically refresh in the
|
||||||
absence of human interaction.
|
absence of user interaction.
|
||||||
|
|
||||||
The following table describes the behavior these flags have.
|
The following table describes the behavior these flags have.
|
||||||
|
|
||||||
@@ -1108,15 +1108,15 @@ The following table describes the behavior these flags have.
|
|||||||
| :-: | :-: | :-: | :-: | - |
|
| :-: | :-: | :-: | :-: | - |
|
||||||
| `0` | `0` | *(Any value)* | Unset | Card will not automatically refresh. |
|
| `0` | `0` | *(Any value)* | Unset | Card will not automatically refresh. |
|
||||||
| `0` | `0` | *(Any value)* | *(Any entity)* | Card will reload default view when entity state changes. |
|
| `0` | `0` | *(Any value)* | *(Any entity)* | Card will reload default view when entity state changes. |
|
||||||
| `0` | `X` seconds | *(Any value)* | Unset | Card will reload default view `X` seconds after human interaction stops. |
|
| `0` | `X` seconds | *(Any value)* | Unset | Card will reload default view `X` seconds after user interaction stops. |
|
||||||
| `0` | `X` seconds | `false` | *(Any entity)* | Card will reload default view `X` seconds after human interaction stops, or when entity state changes (as long as human interaction has not occurred in the last `X` seconds). |
|
| `0` | `X` seconds | `false` | *(Any entity)* | Card will reload default view `X` seconds after user interaction stops, or when entity state changes (as long as user interaction has not occurred in the last `X` seconds). |
|
||||||
| `0` | `X` seconds | `true` | *(Any entity)* | Card will reload default view `X` seconds after human interaction stops or when entity state changes. |
|
| `0` | `X` seconds | `true` | *(Any entity)* | Card will reload default view `X` seconds after user interaction stops or when entity state changes. |
|
||||||
| `Y` seconds | `0` | *(Any value)* | Unset | Card will reload default view every `Y` seconds. |
|
| `Y` seconds | `0` | *(Any value)* | Unset | Card will reload default view every `Y` seconds. |
|
||||||
| `Y` seconds | `0` | *(Any value)* | *(Any entity)* | Card will reload default view every `Y` seconds, or whenever entity state changes. |
|
| `Y` seconds | `0` | *(Any value)* | *(Any entity)* | Card will reload default view every `Y` seconds, or whenever entity state changes. |
|
||||||
| `Y` seconds | `X` seconds | `false` | Unset | Card will reload default view `X` seconds after human interaction stops, and every `Y` seconds (as long as there hasn't been human interaction in the last `X` seconds). |
|
| `Y` seconds | `X` seconds | `false` | Unset | Card will reload default view `X` seconds after user interaction stops, and every `Y` seconds (as long as there hasn't been user interaction in the last `X` seconds). |
|
||||||
| `Y` seconds | `X` seconds | `false` | *(Any entity)* | Card will reload default view `X` seconds after human interaction stops, and every `Y` seconds or whenever entity state changes (in both cases -- as long as there hasn't been human interaction in the last `X` seconds). |
|
| `Y` seconds | `X` seconds | `false` | *(Any entity)* | Card will reload default view `X` seconds after user interaction stops, and every `Y` seconds or whenever entity state changes (in both cases -- as long as there hasn't been user interaction in the last `X` seconds). |
|
||||||
| `Y` seconds | `X` seconds | `true` | Unset | Card will reload default view `X` seconds after human interaction stops, and every `Y` seconds. |
|
| `Y` seconds | `X` seconds | `true` | Unset | Card will reload default view `X` seconds after user interaction stops, and every `Y` seconds. |
|
||||||
| `Y` seconds | `X` seconds | `true` | *(Any entity)* | Card will reload default view `X` seconds after human interaction stops, and every `Y` seconds or whenever entity state changes. |
|
| `Y` seconds | `X` seconds | `true` | *(Any entity)* | Card will reload default view `X` seconds after user interaction stops, and every `Y` seconds or whenever entity state changes. |
|
||||||
|
|
||||||
### Usecases For Automated Refreshes
|
### Usecases For Automated Refreshes
|
||||||
|
|
||||||
@@ -1142,7 +1142,7 @@ view:
|
|||||||
update_cycle_camera: true
|
update_cycle_camera: true
|
||||||
update_seconds: 60
|
update_seconds: 60
|
||||||
```
|
```
|
||||||
* Return to the most recent clip of the default camera 30 seconds after human
|
* Return to the most recent clip of the default camera 30 seconds after user
|
||||||
interaction with the card stops.
|
interaction with the card stops.
|
||||||
```yaml
|
```yaml
|
||||||
view:
|
view:
|
||||||
|
|||||||
+7
-7
@@ -151,8 +151,8 @@ export class FrigateCard extends LitElement {
|
|||||||
@query('frigate-card-elements')
|
@query('frigate-card-elements')
|
||||||
_elements?: FrigateCardElements;
|
_elements?: FrigateCardElements;
|
||||||
|
|
||||||
// Human interaction timer ("screensaver" functionality, return to default
|
// user interaction timer ("screensaver" functionality, return to default
|
||||||
// view after human interaction).
|
// view after user interaction).
|
||||||
protected _interactionTimerID: number | null = null;
|
protected _interactionTimerID: number | null = null;
|
||||||
|
|
||||||
// Automated refreshes of the default view.
|
// Automated refreshes of the default view.
|
||||||
@@ -533,7 +533,7 @@ export class FrigateCard extends LitElement {
|
|||||||
* where the 'real' error is vs simply a union option not matching. This
|
* where the 'real' error is vs simply a union option not matching. This
|
||||||
* function finds all ZodError "issues" that don't have an error with 'type'
|
* function finds all ZodError "issues" that don't have an error with 'type'
|
||||||
* in that object ('type' is the union discriminator for picture elements,
|
* in that object ('type' is the union discriminator for picture elements,
|
||||||
* the major union in the schema). An array of human-readable error
|
* the major union in the schema). An array of user-readable error
|
||||||
* locations is returned, or an empty list if none is available. None being
|
* locations is returned, or an empty list if none is available. None being
|
||||||
* available suggests the configuration has an error, but we can't tell
|
* available suggests the configuration has an error, but we can't tell
|
||||||
* exactly why (or rather Zod simply says it doesn't match any of the
|
* exactly why (or rather Zod simply says it doesn't match any of the
|
||||||
@@ -565,7 +565,7 @@ export class FrigateCard extends LitElement {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Convert an array of strings and indices into a more human readable string,
|
* Convert an array of strings and indices into a more user readable string,
|
||||||
* e.g. [a, 1, b, 2] => 'a[1] -> b[2]'
|
* e.g. [a, 1, b, 2] => 'a[1] -> b[2]'
|
||||||
* @param path An array of strings and numbers.
|
* @param path An array of strings and numbers.
|
||||||
* @returns A single string.
|
* @returns A single string.
|
||||||
@@ -901,7 +901,7 @@ export class FrigateCard extends LitElement {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Clear the human interaction ('screensaver') timer.
|
* Clear the user interaction ('screensaver') timer.
|
||||||
*/
|
*/
|
||||||
protected _clearInteractionTimer(): void {
|
protected _clearInteractionTimer(): void {
|
||||||
if (this._interactionTimerID) {
|
if (this._interactionTimerID) {
|
||||||
@@ -911,8 +911,8 @@ export class FrigateCard extends LitElement {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Start the human interaction ('screensaver') timer to reset the view to
|
* Start the user interaction ('screensaver') timer to reset the view to
|
||||||
* default `view.timeout_seconds` after human interaction.
|
* default `view.timeout_seconds` after user interaction.
|
||||||
*/
|
*/
|
||||||
protected _startInteractionTimer(): void {
|
protected _startInteractionTimer(): void {
|
||||||
this._clearInteractionTimer();
|
this._clearInteractionTimer();
|
||||||
|
|||||||
@@ -43,7 +43,7 @@
|
|||||||
},
|
},
|
||||||
"timeout_seconds": "Reset to default view X seconds after user action (0=never)",
|
"timeout_seconds": "Reset to default view X seconds after user action (0=never)",
|
||||||
"update_cycle_camera": "Cycle through cameras when default view updates",
|
"update_cycle_camera": "Cycle through cameras when default view updates",
|
||||||
"update_force": "Force card updates (ignore human interaction)",
|
"update_force": "Force card updates (ignore user interaction)",
|
||||||
"update_seconds": "Refresh default view every X seconds (0=never)"
|
"update_seconds": "Refresh default view every X seconds (0=never)"
|
||||||
},
|
},
|
||||||
"event_gallery": {
|
"event_gallery": {
|
||||||
|
|||||||
Reference in New Issue
Block a user