beinbearded / addon-control-panel

Home Assistant Control Panel - Community Hass.io Add-on for Home Assistant

Community Hass.io Add-ons: Home Assistant Control Panel

Simple to use control panel for the ultimate home automation setup.

Deprecation warning

This add-on is in a deprecated state!

This add-on is no longer supported or maintained.

You can still install this control panel manually or use the hosted version offered by the author. For more information see:

https://reformedreality.com/home-assistant-control-panel

About

Using a phone or tablet device, you can hook into your Home Assistant server and get access to a simple to use Control Panel. Mount the device on your wall to create the ultimate home automation accessory and unlock the true potential of your Smart devices.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

1. Add our Hass.io add-ons repository to your Hass.io instance.
2. Install the "Home Assistant Control Panel" add-on
3. Start the "Home Assistant Control Panel" add-on
4. Check the logs of the "Home Assistant Control Panel" if it is error-free
5. Ensure you Home Assistant installation has set an API password.
6. Allow CORS access to your Home Assistant installation from this add-on.

The last 2 requirements/steps would need changes to your Home Assistant configuration.yaml file:

http:
  api_password: YOUR_PASSWORD
  cors_allowed_origins:
    - http://addres.to.your.hass.io:7080

In case you updated your configuration.yaml file, be sure to restart Home Assistant to apply these changes.

NOTE: Do not add this repository to Hass.io, please use: https://github.com/hassio-addons/repository.

Docker status

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

{
  "log_level": "info",
  "ssl": false,
  "certfile": "fullchain.pem",
  "keyfile": "privkey.pem",
  "ipv6": true
}

Note: This is just an example, don't copy and past it! Create your own!

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: ssl

Enables/Disables SSL (HTTPS) on the web interface of Home Assistant Control Panel. Set it true to enable it, false otherwise.

Note: Enabling SSL on Home Assistant Control Panel may have side effects, which may cause ads not to transform into blank ads correctly.

Option: certfile

The certificate file to use for SSL.

Note: The file MUST be stored in /ssl/, which is the default for Hass.io

Option: keyfile

The private key file to use for SSL.

Note: The file MUST be stored in /ssl/, which is the default for Hass.io

Option: ipv6

Set this option too false to disable IPv6 support.

Embedding into Home Assistant

It is possible to embed the Home Assistant Control Panel admin directly into Home Assistant, allowing you to access your terminal through the Home Assistant frontend.

Home Assistant provides the panel_iframe component, for these purposes.

Example configuration:

panel_iframe:
  controlpanel:
    title: Control Panel
    icon: mdi:tablet-ipad
    url: http://addres.to.your.hass.io:7080

Why this add-on was created

So, why was this add-on created? The Home Assistant Control Panel is a single static HTML file that could easily installed, without the need for an add-on right?

Right! There are, however, some small advantages:

• The control panel file itself won't be mixed into your configuration files.
• Updates would be clearly visible and applied with a single click.
• The add-on could make the control panel available on your home network exclusively, since exposing it to the outside world would require port forwardings.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, 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 Forum, we have a dedicated topic on that forum regarding this add-on.
• The Home Assistant Discord Chat Server for general Home Assistant discussions and questions.
• Join the Reddit subreddit in /r/homeassistant

You could also open an issue here 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.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

We have got some Hass.io add-ons for you

Want some more functionality to your Hass.io Home Assistant instance?

We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.

License

MIT License

Copyright (c) 2018 Franck Nijhof

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.