flan/advanced-camera-card
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #694 from felipecrs/devcontainers-doc

Browse Source 
Add Dev Container section on README
This commit is contained in:
Dermot Duffy
2022-06-19 21:11:31 -07:00
committed by GitHub
parent d46a4ed24d c667813579
commit af0c33192c
1 changed files with 63 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+30 -22
View File
@@ -2736,28 +2736,6 @@ rewind or fast-forward. Workarounds:
* Use a [Frigate Card Element](#frigate-card-elements) or menu icon to trigger * Use a [Frigate Card Element](#frigate-card-elements) or menu icon to trigger
the action instead. the action instead.
### Console shows 'Offset is out of bounds' / 'Out of bounds memory access'
This is an issue with the JSMPEG live provider and cameras with high-resolutions
/ high-bitrates. [This bug](https://github.com/dermotduffy/frigate-hass-card/issues/189) has much
more discussion on this topic. Some users report success in disabling the WASM-option for JSMPEG like so:
```yaml
live:
jsmpeg:
options:
disableWebAssembly: true
```
Lowering the camera bitrate, and/or increasing the `videoBufferSize` for JSMPEG may also help:
```yaml
live:
jsmpeg:
options:
videoBufferSize: 41943040
```
### Home Assistant iOS App not updating after card version change ### Home Assistant iOS App not updating after card version change
Try resetting the app frontend cache: Try resetting the app frontend cache:
@@ -2783,6 +2761,36 @@ $ yarn run build
Resultant build will be at `dist/frigate-hass-card.js`. This could be installed via the [manual installation instructions above](#manual-installation). Resultant build will be at `dist/frigate-hass-card.js`. This could be installed via the [manual installation instructions above](#manual-installation).
### Dev Container
[![Open in Remote - Containers](https://img.shields.io/static/v1?label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode&style=flat-square)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/dermotduffy/frigate-hass-card)
You can use the [VS Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers) extension to speed up the development environment creation. Simply:
1. Clone the repository to your machine
1. Open VS Code on it
1. Reopen the folder in the Dev Container
1. Once done, press `F5` to start debugging
Everything should just work without any additional configuration. Under the hood, the dev container setup takes care of bringing up:
* Home Assistant (port `48123:8123`)
* Frigate (ports `45000:5000`, `41935:1935`)
* MQTT (port `41883:1883`)
As docker-compose containers.
* The Frigate Home Assistant Integration is registered as a `git submodule` at `.devcontainer/frigate-hass-integration`, and VS Code will initialize/clone it for you before opening the dev container.
Some environment variables are supported in a `.env` file:
* `FRIGATE_VERSION`: The version of Frigate to use. Defaults to the latest stable version.
* `HA_VERSION`: The version of Home Assistant to use. Defaults to the latest stable version.
> **NOTE**: When not specifying any version, it's recommended that you `docker-compose pull` the stack from time to time to ensure you have the latest versions of the images.
The Home Assistant container will get preconfigured during first initialization, therefore, if you changed the Home Assistant configuration, you will need to remove the HA container and start another.
### Releasing ### Releasing
1. Merge a PR that contains only a `package.json` and `const.ts` version number bump (see [this example](https://github.com/dermotduffy/frigate-hass-card/commit/a854187d4a354f8841ad284d75b0afbed7b634c4)). 1. Merge a PR that contains only a `package.json` and `const.ts` version number bump (see [this example](https://github.com/dermotduffy/frigate-hass-card/commit/a854187d4a354f8841ad284d75b0afbed7b634c4)).