141 lines
4.5 KiB
Markdown
Executable File
141 lines
4.5 KiB
Markdown
Executable File
# Home Assistant Add-on: Dashcast
|
|
|
|
## About
|
|
|
|
This is a Dashcast add-on for Home Assistant.
|
|
Dascast is an app that displays dashboard web pages on your Chromecast device.
|
|
|
|
Credit to [ragingcomputer/dashcast-docker-MQTT](https://github.com/ragingcomputer/dashcast-docker-MQTT) for the docker/mqtt implementation.
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in
|
|
comparison to installing any other Home Assistant add-on.
|
|
|
|
1. Search for the "Dashcast" add-on in the Supervisor add-on store and install it.
|
|
1. Start the "Dashcast" add-on.
|
|
1. Check the logs of the "Dashcast" add-on to see it in action.
|
|
|
|
## Configuration
|
|
|
|
Dashcast add-on configuration:
|
|
|
|
```yaml
|
|
log_level: info
|
|
chromecast_name: "Livingroom Chromecast",
|
|
dashboard_url: "https://news.google.com",
|
|
mqtt_host: "127.0.0.1",
|
|
mqtt_user: "mqtt",
|
|
mqtt_pass: "yourmqttpassword"
|
|
```
|
|
|
|
### Option: `log_level`
|
|
|
|
The `log_level` option controls the level of log output by the addon and can
|
|
be changed to be more or less verbose, which might be useful when you are
|
|
dealing with an unknown issue. Possible values are:
|
|
|
|
- `trace`: Show every detail, like all called internal functions.
|
|
- `debug`: Shows detailed debug information.
|
|
- `info`: Normal (usually) interesting events.
|
|
- `warning`: Exceptional occurrences that are not errors.
|
|
- `error`: Runtime errors that do not require immediate action.
|
|
- `fatal`: Something went terribly wrong. Add-on becomes unusable.
|
|
|
|
Please note that each level automatically includes log messages from a
|
|
more severe level, e.g., `debug` also shows `info` messages. By default,
|
|
the `log_level` is set to `info`, which is the recommended setting unless
|
|
you are troubleshooting.
|
|
|
|
### Option: `chromecast_name`
|
|
|
|
The name of the Chromecast device to control
|
|
|
|
### Option: `dashboard_url`
|
|
|
|
The URL to be shown on the Chromecast after starting this container
|
|
|
|
### Option: `mqtt_host`
|
|
|
|
The host or IP address of MQTT server
|
|
|
|
### Option: `mqtt_user`
|
|
|
|
The username for the MQTT server
|
|
|
|
### Option: `mqtt_pass`
|
|
|
|
The password for the MQTT server
|
|
|
|
|
|
## Changelog & Releases
|
|
|
|
This repository keeps a change log using [GitHub's releases][releases]
|
|
functionality. The format of the log is based on
|
|
[Keep a Changelog][keepchangelog].
|
|
|
|
Releases are based on [Semantic Versioning][semver], and use the format
|
|
of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
|
|
based on the following:
|
|
|
|
- ``MAJOR``: Incompatible or major changes.
|
|
- ``MINOR``: Backwards-compatible new features and enhancements.
|
|
- ``PATCH``: Backwards-compatible bugfixes and package updates.
|
|
|
|
## Support
|
|
|
|
Got questions?
|
|
|
|
You have several options to get them answered:
|
|
|
|
- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on
|
|
support and feature requests.
|
|
- The [Home Assistant Discord chat server][discord-ha] for general Home
|
|
Assistant discussions and questions.
|
|
- The Home Assistant [Community Forum][forum].
|
|
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
|
|
|
|
You could also [open an issue here][issue] GitHub.
|
|
|
|
## Contributing
|
|
|
|
This is an active open-source project. We are always open to people who want to
|
|
use the code or contribute to it.
|
|
|
|
We have set up a separate document containing our
|
|
[contribution guidelines](CONTRIBUTING.md).
|
|
|
|
Thank you for being involved! :heart_eyes:
|
|
|
|
## Authors & contributors
|
|
|
|
The original setup of this repository is by [Bogdan Vlaicu][bvlaicu].
|
|
|
|
|
|
## License
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2019-2020 Bogdan Vlaicu
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
|
|
[bvlaicu]: https://github.com/bvlaicu
|
|
[issue]: https://github.com/bvlaicu/home-assistant-addons/issues
|