Dermot Duffy
cc376a8be1
Whilst the Frigate support in this card is the best among camera engines, the name incorrectly suggests that Frigate is a requirement. Instead, to broaden the appeal, change to more camera agnostic name. This does not suggest any change in priority, role or support for Frigate. This change is likely to be bug prone, due to the size of the rename -- the code contains 1500+ references to "Frigate" most of which make sense to rename, some which do not, all of which needed human assessment. - Closes #1298 BREAKING CHANGE: References to `frigate-card` in all kinds of configuration need to be updated to `advanced-camera-card`. An automated config upgrade should take care of the majority of usecases (click `Edit -> Upgrade -> Save`), though may not be perfect.
266 lines
11 KiB
Markdown
266 lines
11 KiB
Markdown
# Troubleshooting
|
|
|
|
## Highlighted Issues
|
|
|
|
### Stream does not load
|
|
|
|
Stream not loading? Permanent "loading circle"?
|
|
|
|
A stream not loading is a relatively common error, but can be caused by any
|
|
number of issues (e.g. installation problems, networking problems, video/codec
|
|
problems, a Home Assistant bug or card bug).
|
|
|
|
During the stream load, the card will show a "loading circle" icon and, for
|
|
cameras with a `camera_entity` configured, will show images refreshing once per
|
|
second until the stream has fully loaded (unless `live.show_image_during_load`
|
|
is set to false).
|
|
|
|
Debugging broken streams:
|
|
|
|
1. If you're using the default `auto` live provider, or explicitly setting the
|
|
`ha` live provider, try opening the `camera_entity` in Home Assistant and
|
|
verifying whether the stream loads there. You can press the `e` key on any
|
|
Home Assistant dashboard, choose the relevant entity, and see if the stream
|
|
loads. If it does not, you have a upstream installation issue with your
|
|
camera / the integration for the camera, and need to resolve that first.
|
|
Your issue is not related to the card itself.
|
|
1. Check whether any URLs specified in your card configuration are accessible
|
|
_from the network of the browser_.
|
|
1. Check whether or not there are helpful clues shown on your Javascript
|
|
console (`F12` in many browsers) that might indicate the source of the
|
|
issue.
|
|
1. Check you are using the latest version of all relevant camera integrations
|
|
(e.g.
|
|
[Frigate](https://github.com/blakeblackshear/frigate-hass-integration)).
|
|
1. If you're using a Frigate camera and are requesting a `webrtc` stream,
|
|
ensure [you have configured Frigate
|
|
accordingly](https://docs.frigate.video/configuration/live/#webrtc-extra-configuration).
|
|
1. Search for your symptoms on the [card issues
|
|
page](https://github.com/dermotduffy/advanced-camera-card/issues) and see if
|
|
you find any prior relevant discussions.
|
|
|
|
If you're happy with just using an image stream but want the small circle to go
|
|
away, use the [`image live provider`](./configuration/cameras/live-provider.md?id=image) .
|
|
|
|
### Unknown Command
|
|
|
|
`Camera initialization failed: Unknown command`
|
|
|
|
Your Frigate integration may not be up to date. Check [the latest Frigate
|
|
Integration
|
|
releases](https://github.com/blakeblackshear/frigate-hass-integration/releases/tag/v5.7.0).
|
|
|
|
## Other Issues
|
|
|
|
### 2-way audio doesn't work
|
|
|
|
There are many requirements for 2-way audio to work. See [Using 2-way
|
|
audio](usage/2-way-audio.md) for more information about these. If your
|
|
microphone still does not work and you believe you meet all the requirements try
|
|
eliminating the card from the picture by going directly to the `go2rtc` UI,
|
|
navigating to `links` for your given stream, then to `webrtc.html` with a
|
|
microphone. If this does not work correctly with 2-way audio then your issue is
|
|
with `go2rtc` not with the card. In this case, you could file an issue in [that
|
|
repo](https://github.com/AlexxIT/go2rtc/issues) with debugging information as
|
|
appropriate.
|
|
|
|
### Android will not render >4 JSMPEG live views
|
|
|
|
Android Webview (as used by Android Chrome / Android Home Assistant Companion)
|
|
appears to severely limit the number of simultaneous OpenGL contexts that can be
|
|
opened. The JSMPEG player (that this card uses), consumes 1 OpenGL context per
|
|
rendering.
|
|
|
|
This limitation may be worked around (at a performance penalty) by disabling
|
|
OpenGL for JSMPEG live views:
|
|
|
|
```yaml
|
|
live:
|
|
jsmpeg:
|
|
options:
|
|
disableGl: true
|
|
```
|
|
|
|
[This bug](https://github.com/dermotduffy/advanced-camera-card/issues/191) has some
|
|
more discussion on this topic. New ideas to address this underlying limitation
|
|
most welcome!
|
|
|
|
### Autoplay in Chrome when a tab becomes visible again
|
|
|
|
Even if `live.auto_play` or `media_viewer.auto_play` is set to `[]`, Chrome
|
|
itself will still auto play a video that was previously playing prior to the tab
|
|
being hidden, once that tab is visible again. This behavior cannot be influenced
|
|
by the card. Other browsers (e.g. Firefox, Safari) do not exhibit this behavior.
|
|
|
|
### Blank white image on `live` view
|
|
|
|
For some slowly loading cameras, for which [Home Assistant stream
|
|
preloading](https://www.home-assistant.io/integrations/camera/) is not enabled,
|
|
Home Assistant may return a blank white image when asked for a still. These
|
|
stills are used during initial Advanced Camera Card load of the `live` view if the
|
|
`live.show_image_during_load` option is enabled. Disabling this option should
|
|
show the default media loading controls (e.g. a spinner or empty video player)
|
|
instead of the blank white image.
|
|
|
|
### Casting to Chromecast broken
|
|
|
|
This could be for any number of reasons. Chromecast devices can be quite picky
|
|
on network, DNS and certificate issues, as well as audio and video codecs. Check
|
|
your Home Assistant log as there may be more information in there.
|
|
|
|
!> In particular, for Frigate to support casting of clips, the default ffmpeg
|
|
settings for Frigate must be modified, i.e. Frigate does not encode clips in a
|
|
Chromecast compatible format out of the box (specifically: audio must be enabled
|
|
in the AAC codec, whether your camera supports audio or not). See the [Frigate
|
|
Home Assistant
|
|
documentation](https://docs.frigate.video/integrations/home-assistant) or [this
|
|
issue](https://github.com/blakeblackshear/frigate/issues/3175) for more.
|
|
|
|
### Custom element does not exist
|
|
|
|
This is usually a sign that the card is not correctly installed (i.e. the
|
|
browser cannot find the Javascript). In cases where it works in some browsers /
|
|
devices but not in others it may simply be an old browser / webview that does
|
|
not support modern Javascript (this is occasionally seen on old Android
|
|
hardware). In this latter case, you are out of luck.
|
|
|
|
### `double_tap` does not work in Android
|
|
|
|
The Android video player swallows `double_tap` interactions in order to
|
|
rewind or fast-forward. Workarounds:
|
|
|
|
- Use `hold` instead of `double_tap` for your card-wide action.
|
|
- Use an [Advanced Camera Card Element](configuration/elements/README.md) or menu icon to
|
|
trigger the action instead.
|
|
|
|
### Dragging in carousels broken in Firefox
|
|
|
|
The Firefox video player swallows mouse interactions, so dragging is not
|
|
possible in carousels that use the Firefox video player (e.g. `clips` carousel,
|
|
or live views that use the `frigate` or `webrtc-card` provider). The next and
|
|
previous buttons may be used to navigate in these instances.
|
|
|
|
Dragging works as expected for snapshots, or for the `jsmpeg` provider.
|
|
|
|
### Dragging video control doesn't work in Safari
|
|
|
|
Dragging the Safari video controls "progress bar" conflicts with carousel
|
|
"dragging", meaning the video controls progress bar cannot be moved left or
|
|
right. Turning off carousel dragging (and using next/previous controls) will
|
|
return full video controls in Safari:
|
|
|
|
```yaml
|
|
live:
|
|
draggable: false
|
|
media_viewer:
|
|
draggable: false
|
|
```
|
|
|
|
### Downloads don't work
|
|
|
|
Downloads are assembled by the Frigate backend out of ~10s segment files. You
|
|
must have enough cache space in your Frigate instance to allow this assembly to
|
|
happen -- if large downloads don't work, especially for recordings, check your
|
|
Frigate backend logs to see if it's running out of space. You can increase your
|
|
cache size with the `tmpfs` `size` argument, see [Frigate
|
|
documentation](https://docs.frigate.video/frigate/installation#docker).
|
|
|
|
Large downloads may take a few seconds to assemble, so there may be a delay
|
|
between clicking the download button and the download starting.
|
|
|
|
### `Forbidden media source identifier`
|
|
|
|
- If you are using a custom `client_id` setting in your `frigate.yml` file (the
|
|
configuration file for the Frigate backend itself), you must tell the card
|
|
about it. See [Frigate engine
|
|
configuration](configuration/cameras/engine.md?id=frigate).
|
|
- You must have the `Enable the media browser` option enabled for the Frigate
|
|
integration, in order for media fetches to work for the card. Media fetches
|
|
are used to fetch events / clips / snapshots, etc. If you just wish to use
|
|
live streams without media fetches, you can use the following configuration:
|
|
|
|
```yaml
|
|
live:
|
|
controls:
|
|
thumbnails:
|
|
mode: none
|
|
```
|
|
|
|
### Fullscreen doesn't work on iPhone
|
|
|
|
Unfortunately, [iOS does not support the Javascript fullscreen
|
|
API](https://caniuse.com/fullscreen) on the iPhone, which severely limits the
|
|
fullscreen functionality available. On iPhone, fullscreen is only possible of
|
|
the selected video element. As a result, there will be no menu, status bar, grid
|
|
support, gallery / timeline support, nor support for non-video based [live
|
|
providers](./configuration/cameras/live-provider.md) such as `image` or `jsmpeg`
|
|
-- exclusively viewing a selected live video or media video in fullscreen.
|
|
|
|
The card will only show the fullscreen menu button when fullscreen can usefully
|
|
be activated, which means for certain views on the iPhone it will be absent.
|
|
|
|
### iOS App not updating after card version change
|
|
|
|
Try resetting the app frontend cache:
|
|
|
|
- `Configuration -> Companion App -> Debugging -> Reset frontend cache`
|
|
|
|
### Javascript console errors
|
|
|
|
#### `[Violation] Added non-passive event listener to a scroll-blocking [...] event`
|
|
|
|
This card uses [visjs](https://github.com/visjs/vis-timeline) -- a timeline
|
|
library -- to show camera timelines. This library currently uses non-passive
|
|
event-listeners. These warnings can be safely ignored in this instance and
|
|
cannot easily be fixed in the underlying library.
|
|
|
|
### Microphone menu button not shown
|
|
|
|
The microphone menu button will only appear if both enabled (see [Menu Button
|
|
configuration](configuration/menu.md?id=available-buttons)) and if the media
|
|
that is currently loaded supports 2-way audio. See [Using 2-way
|
|
audio](usage/2-way-audio.md) for more information about the requirements that
|
|
must be followed.
|
|
|
|
### New version not working in Chrome
|
|
|
|
When upgrading the card it's recommended to reset the frontend cache. Sometimes
|
|
clearing site data in Chrome settings isn't enough.
|
|
|
|
- Press F12 to display `Dev Console` in Chrome then right click on the refresh
|
|
icon and select `Empty Cache and Hard Reload`
|
|
|
|
### Static image URL with credentials doesn't load
|
|
|
|
Your browser will not allow a page/script (like this card) to pass credentials
|
|
to a cross-origin (different host) image URL for security reasons. There is no
|
|
way around this unless you could also control the webserver that is serving the
|
|
image to specifically allow `crossorigin` requests (which is typically not the
|
|
case for an image served from a camera, for example). The stock Home Assistant
|
|
Picture Glance card has the same limitation, for the same reasons.
|
|
|
|
### Status "popup" continually popping up
|
|
|
|
Status popup can be disabled with this configuration:
|
|
|
|
```yaml
|
|
status_bar:
|
|
style: none
|
|
```
|
|
|
|
### `webrtc_card` unloads in the background
|
|
|
|
[AlexxIT's WebRTC Card](https://github.com/AlexxIT/WebRTC) which is embedded by
|
|
the `webrtc_card` live provider internally disconnects the stream when the
|
|
browser tab is changed (regardless of any Advanced Camera Card configuration settings,
|
|
e.g. `lazy_unload`). To allow the stream to continue running in the background,
|
|
pass the `background` argument to the `webrtc_card` live provider as shown
|
|
below. This effectively allows the Advanced Camera Card to decide whether or not to
|
|
unload the stream.
|
|
|
|
```yaml
|
|
live:
|
|
webrtc_card:
|
|
background: true
|
|
```
|