Python Apps and HADashboard for Home Assistant
This add-on is in a deprecated state!
This add-on is powered by AppDaemon 3.x, which has been replaced by AppDaemon 4.x.
Are you looking for installing AppDaemon or upgrading to the new AppDaemon 4.x add-on?
https://github.com/hassio-addons/addon-appdaemon
Or search for "AppDaemon" in the Supervisor add-on store.
AppDaemon is a loosely coupled, multithreaded, sandboxed python execution environment for writing automation apps for Home Assistant home automation software. It also provides a configurable dashboard (HADashboard) suitable for wall mounted tablets.
The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.
- Search for the "AppDaemon3" add-on in the Supervisor add-on store and install it.
- Start the "AppDaemon3" add-on
- Check the logs of the "AppDaemon3" add-on to see if everything went well.
Note: Remember to restart the add-on when the configuration is changed.
Example add-on configuration:
log_level: info
disable_auto_token: false
system_packages:
- ffmpeg
python_packages:
- PyMySQL
- Pillow
Note: This is just an example, don't copy and past it! Create your own!
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.
These log level also affects the log levels of the AppDaemon.
By default, this add-on will update tokens used inside the appdaemon.yaml
configuration file, each time the add-on start. There are cases where this
is not wished for, for example, when storing the configuration publicly in Git
and are using a !secret value for the token.
Setting this option to true, will cause the add-on to stop updating files
automatically.
Allows you to specify additional Alpine packages to be
installed to your AppDaemon setup (e.g., g++. make, ffmpeg).
Note: Adding many packages will result in a longer start-up time for the add-on.
Allows you to specify additional Python packages to be
installed to your AppDaemon setup (e.g., PyMySQL. Requests, Pillow).
Note: Adding many packages will result in a longer start-up time for the add-on.
Customize your environment even more with the init_commands option.
Add one or more shell commands to the list, and they will be executed every
single time this add-on starts.
This add-on does not configure the AppDaemon or HADashboard for you. It does, however, create some sample files to get you started on the first run.
The configuration of the AppDaemon can be found in the /config/appdaemon
directory.
For more information about configuring AppDaemon, please refer to the extensive documentation they offer:
http://appdaemon.readthedocs.io/en/latest/
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.
Got questions?
You have several options to get them answered:
- The Home Assistant Community Add-ons Discord chat server for add-on support and feature requests.
- The Home Assistant Discord chat server for general Home Assistant discussions and questions.
- The Home Assistant Community Forum.
- Join the Reddit subreddit in /r/homeassistant
You could also open an issue here GitHub.
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! 😍
The original setup of this repository is by Franck Nijhof.
For a full list of all authors and contributors, check the contributor's page.
Want some more functionality to your Home Assistant instance?
We have created multiple add-ons for Home Assistant. For a full list, check out our GitHub Repository.
MIT License
Copyright (c) 2018-2020 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.