Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code
TrueChartsClone/charts/stable/ring-mqtt/docs/installation_notes.md

59 lines
2.3 KiB
Markdown
Raw Normal View History

fix(ring-mqtt): move to stable + docs (#3675) * fix(ring-mqtt): move to stable + docs * update files * Apply suggestions from code review * update md * lint * lint Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
2022-09-03 20:28:51 +00:00
# Installation Notes
- Follow the prerequisite guides below before attempting `Ring-MQTT` installation.
## MQTT setup
Update some links in the docs (#9839) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [x] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [x] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [x] 📄 I have made corresponding changes to the documentation - [x] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._
2023-06-23 06:53:11 +00:00
- I used the chart called `mosquitto` install it as normal and set `Authentication` to **true**. here's the [auth guide](https://truecharts.org/charts/stable/mosquitto/setup-guide).
fix(ring-mqtt): move to stable + docs (#3675) * fix(ring-mqtt): move to stable + docs * update files * Apply suggestions from code review * update md * lint * lint Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
2022-09-03 20:28:51 +00:00
## Ring-MQTT setup
fix(ring-mqtt) add config.json (#11905) **Description** a potential fix to manually create the config.json ⚒️ Fixes # <!--(issue)--> **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [X] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [X] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [X] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
2023-08-29 18:14:04 +00:00
Go to `http://SCALE_IP:55123`.
- Set `MQTT Url` to **mqtt://@mosquitto.ix-mosquitto.svc.cluster.local:1883** if not using mqtt auth or set the user/pass in the url like so: **mqtt://USER:PASS@mosquitto.ix-mosquitto.svc.cluster.local:1883**.
- Set `LiveStream User` to **user_name** for the RTSP user.
- Set `LiveStream Password` to **user_pass** for the RTSP user.
- Leave `Disarm Code` blank.
- Set `Enable Cameras` to **true** to enable cameras.
- Set `Enable Modes` to **false** to disable location modes.
- Set `Enable Panic` to **false** to disable panic button.
- Set `Hass Topic` to **homeassistant/status** for the topic to monitor for Home Assistant restarts.
- Leave `Location Ids` blank.
fix(ring-mqtt): move to stable + docs (#3675) * fix(ring-mqtt): move to stable + docs * update files * Apply suggestions from code review * update md * lint * lint Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
2022-09-03 20:28:51 +00:00
## Home-assistant setup
- Install the chart `home-assistant` if you have not done so.
- In home-assistant go to settings -> devices & integrations -> click add integration -> search for `mqtt`.
- Set `broker` to `mosquitto.ix-mosquitto.svc.cluster.local`.
- Set `port` to `1883`.
- Set `username` and `password` to the MQTT auth user and pass.
- Set the `MQTT options` as needed.
- Shell into home-assistant, use truetool.sh or other means to modify the file `/config/configuration.yaml`.
- Add the following code.
```yaml
shell_command:
ring_snap: "ffmpeg -y -i {{RTSP_URL}} -vframes 1 {{fileDirName}}"
```
- Create a new dir called `www` in `/config/`.
- Validate home-assistant configuration in `developer tools` and if passes; click on restart to use the service `ring_snap` in automations.
- Here's a sample on how to create a `live snapshot` automation.
- This will override the previous image if saved as `/config/www/snapshot.jpg`
```yaml
service: shell_command.ring_snap
data:
RTSP_URL: "{{ states.sensor.front_door_info.attributes.stream_Source }}"
fileDirName: "/config/www/snapshot.jpg"
```
- Note: You **must** save the file in `/config/www/` or set the option to allow other dirs for home-assistant to be used.
- Now you can create a live snapshot automation in `home-assistant`.