108 lines
3.4 KiB
Markdown
108 lines
3.4 KiB
Markdown
|
# venstar2mqtt
|
||
|
|
|
||
|
|
Simple Chart that allows MQTT to be used to view data and push settings to the Venstar Local API Thermostats. Local API needs to be enabled on the thermostat. No Web UI or appdata folder necessary.
|
||
|
|
|
||
|
|
TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE.
|
||
|
|
|
||
|
|
This readme is just an automatically generated general guide on installing our Helm Charts and Apps.
|
||
|
|
For more information, please click here: [venstar2mqtt](https://truecharts.org/docs/charts/incubator/venstar2mqtt)
|
||
|
|
|
||
|
|
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
||
|
|
|
||
|
|
## Source Code
|
||
|
|
|
||
|
|
* <https://github.com/truecharts/charts/tree/master/charts/incubator/venstar2mqtt>
|
||
|
|
* <https://github.com/terafin/mqtt-venstar-bridge>
|
||
|
|
* <https://hub.docker.com/r/terafin/mqtt-venstar-bridge/>
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
Kubernetes: `>=1.16.0-0`
|
||
|
|
|
||
|
|
## Dependencies
|
||
|
|
|
||
|
|
| Repository | Name | Version |
|
||
|
|
|------------|------|---------|
|
||
|
|
| https://library-charts.truecharts.org | common | 10.9.4 |
|
||
|
|
|
||
|
|
## Installing the Chart
|
||
|
|
|
||
|
|
### TrueNAS SCALE
|
||
|
|
|
||
|
|
To install this Chart on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Installing-an-App).
|
||
|
|
|
||
|
|
### Helm
|
||
|
|
|
||
|
|
To install the chart with the release name `venstar2mqtt`
|
||
|
|
|
||
|
|
```console
|
||
|
|
helm repo add TrueCharts https://charts.truecharts.org
|
||
|
|
helm repo update
|
||
|
|
helm install venstar2mqtt TrueCharts/venstar2mqtt
|
||
|
|
```
|
||
|
|
|
||
|
|
## Uninstall
|
||
|
|
|
||
|
|
### TrueNAS SCALE
|
||
|
|
|
||
|
|
**Upgrading, Rolling Back and Uninstalling the Chart**
|
||
|
|
|
||
|
|
To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Upgrade-rollback-delete-an-App).
|
||
|
|
|
||
|
|
### Helm
|
||
|
|
|
||
|
|
To uninstall the `venstar2mqtt` deployment
|
||
|
|
|
||
|
|
```console
|
||
|
|
helm uninstall venstar2mqtt
|
||
|
|
```
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
### Helm
|
||
|
|
|
||
|
|
#### Available Settings
|
||
|
|
|
||
|
|
Read through the values.yaml file. It has several commented out suggested values.
|
||
|
|
Other values may be used from the [values.yaml](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/truecharts/library-charts/tree/main/charts/common).
|
||
|
|
|
||
|
|
#### Configure using the command line
|
||
|
|
|
||
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
||
|
|
|
||
|
|
```console
|
||
|
|
helm install venstar2mqtt \
|
||
|
|
--set env.TZ="America/New York" \
|
||
|
|
TrueCharts/venstar2mqtt
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Configure using a yaml file
|
||
|
|
|
||
|
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
||
|
|
|
||
|
|
```console
|
||
|
|
helm install venstar2mqtt TrueCharts/venstar2mqtt -f values.yaml
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Connecting to other charts
|
||
|
|
|
||
|
|
If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Charts Internally](https://truecharts.org/docs/manual/SCALE%20Apps/linking-apps) quick-start guide.
|
||
|
|
|
||
|
|
## Support
|
||
|
|
|
||
|
|
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/docs/manual/SCALE%20Apps/Important-MUST-READ).
|
||
|
|
- See the [Website](https://truecharts.org)
|
||
|
|
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
|
||
|
|
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Sponsor TrueCharts
|
||
|
|
|
||
|
|
TrueCharts can only exist due to the incredible effort of our staff.
|
||
|
|
Please consider making a [donation](https://truecharts.org/sponsor) or contributing back to the project any way you can!
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
All Rights Reserved - The TrueCharts Project
|