Dashcast add-on

2020-04-02 18:17:01 -04:00
parent 292c1a0ba9
commit 9d4d704ffa
4 changed files with 167 additions and 0 deletions
@@ -0,0 +1,113 @@
+# 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.
+
+## 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
+```
+
+### 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.
+
+
+## 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/addon-php/issues
@@ -0,0 +1,54 @@
+{
+  "name": "Dashcast",
+  "version": "0.0.1",
+  "slug": "dashcast",
+  "description": "Display dashboard web pages on your Chromecast device",
+  "url": "https://github.com/ragingcomputer/dashcast-docker-MQTT",
+  "startup": "application",
+  "arch": ["aarch64", "amd64", "armhf", "armv7", "i386"],
+  "webui": "[PROTO:ssl]://[HOST]:[PORT:80]",
+  "ingress": true,
+  "ingress_port": 1337,
+  "panel_icon": "mdi:chart-areaspline",
+  "homeassistant": "0.92.0b2",
+  "map": ["share:rw", "ssl"],
+  "boot": "auto",
+  "host_network": true,
+  "environment": {
+    "DEFAULT_DASHBOARD_URL": "",
+    "DEFAULT_DASHBOARD_URL_FORCE": "False",
+    "DISPLAY_NAME": "Dashcast Chromecast",
+    "IGNORE_CEC": "True",
+    "MQTT_SERVER": "",
+    "MQTT_USERNAME": "",
+    "MQTT_PASSWORD": ""
+  },
+  "image": "ragingcomputer/dashcast-docker-mqtt",
+  "options": {
+    "log_level": "info",
+    "DEFAULT_DASHBOARD_URL": null,
+    "MQTT_SERVER": "127.0.0.1", 
+    "MQTT_USERNAME": null,
+    "MQTT_PASSWORD": null
+  },
+  "schema": {
+    "log_level": "list(trace|debug|info|notice|warning|error|fatal)",
+    "DEFAULT_DASHBOARD_URL": "str", 
+    "MQTT_SERVER":"str",
+    "MQTT_USERNAME":"str",
+    "MQTT_PASSWORD":"str"
+  },
+  "ports": {
+    "80/tcp": null,
+    "80/tcp": 8880
+  },
+  "ports_description": {
+    "80/tcp": "Web interface (Not required for Ingress)",
+    "8088/tcp": "PHP server"
+  },
+  "hassio_api": true,
+  "auth_api": true,
+  "hassio_role": "default",
+  "homeassistant_api": false
+}
+