diff --git a/README.md b/README.md index 4250e639..d7afb435 100644 --- a/README.md +++ b/README.md @@ -700,10 +700,10 @@ SOFTWARE. [airsonos-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [airsonos-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [airsonos-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-appdaemon]: https://github.com/hassio-addons/addon-appdaemon/tree/v0.8.1 -[addon-doc-appdaemon]: https://github.com/hassio-addons/addon-appdaemon/blob/v0.8.1/README.md +[addon-appdaemon]: https://github.com/hassio-addons/addon-appdaemon/tree/v0.8.2 +[addon-doc-appdaemon]: https://github.com/hassio-addons/addon-appdaemon/blob/v0.8.2/README.md [appdaemon-issue]: https://github.com/hassio-addons/addon-appdaemon/issues -[appdaemon-version-shield]: https://img.shields.io/badge/version-v0.8.1-blue.svg +[appdaemon-version-shield]: https://img.shields.io/badge/version-v0.8.2-blue.svg [appdaemon-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [appdaemon-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [appdaemon-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg diff --git a/appdaemon/CHANGELOG.md b/appdaemon/CHANGELOG.md index dc2a2a7b..406c4ca9 100644 --- a/appdaemon/CHANGELOG.md +++ b/appdaemon/CHANGELOG.md @@ -1,5 +1,15 @@ ## What’s changed +## πŸš€ Enhancements + +- πŸ”¨ Rename add-on to just 'AppDaemon' @frenck (#194) +- πŸ”’ Sign add-on with Codenotary Community Attestation Service (CAS) @frenck (#192) + +## πŸ“š Documentation + +- πŸ“š Add My buttons to documentation @frenck (#193) + ## ⬆️ Dependency updates -- ⬆️ Upgrades AppDaemon to 4.2.1 @frenck (#189) +- ⬆️ Upgrades add-on base image to 11.1.0 @frenck (#191) + diff --git a/appdaemon/DOCS.md b/appdaemon/DOCS.md index 0eccaa68..57756320 100644 --- a/appdaemon/DOCS.md +++ b/appdaemon/DOCS.md @@ -1,27 +1,38 @@ -# Home Assistant Community Add-on: AppDaemon 4 +# Home Assistant Community Add-on: AppDaemon -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. +[AppDaemon][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. ## 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 "AppDaemon 4" add-on in the Supervisor add-on store and - install it. -1. Start the "AppDaemon 4" add-on -1. Check the logs of the "AppDaemon 4" add-on to see if everything went well. +1. Click the Home Assistant My button below to open the add-on on your Home + Assistant instance. + + [![Open this add-on in your Home Assistant instance.][addon-badge]][addon] + +1. Click the "Install" button to install the add-on. +1. Start the "AppDaemon" add-on +1. Check the logs of the "AppDaemon" add-on to see if everything went well. :information_source: Please note, the add-on is pre-configured to connect with Home Assistant. There is no need to create access tokens or to set your Home Assistant URL in the AppDaemon configuration. -This automatic handling of the URL and token conflicts with the AppDaemon -official documentation. The official documentation will state `ha_url` and -`token` options are required. For the add-on, however, this isn't needed. +This automatic handling of the URL and token conflicts with the +[AppDaemon official documentation][appdaemon]. The official documentation +will state `ha_url` and `token` options are required. For the add-on, however, +this isn't needed. + +Home Assistant, by default, ships with the Community Add-ons store installed. +However, if it is missing (for any reason), you can add it by clicking the +button My button below. + +[![Add repository to your Home Assitant instance.][repository-badge]][repository] ## Configuration @@ -110,45 +121,6 @@ official documentation. The official documentation will state `ha_url` and However, you are free to set them if you want to override, however, in general usage, that should not be needed and is not recommended for this add-on. -## Upgrading from AppDaemon 3.x - -If you have previously ran AppDaemon 3.x (e.g., via an add-on), these steps -will help you getting upgraded to AppDaemon 4.x. - -- After installing this add-on, stop the current running AppDaemon 3.x add-on. -- Open your `/config/appdaemon/appdaemon.yaml` file in an editor. - - Remove the `log`. - - Remove`threads`, `api_port`, `app_dir`, `ha_url` and `token`. - - Add the following to the `appdaemon` section: `latitude`, `longitude`, - `elevation` and `time_zone`. - - Add a `http` section with `url: http://127.0.0.1:5050` in it. - - At the end of the file add `admin:` and `api:`. - - Remove everthing under `hadashboard:`, leaving just that. - -The result should look something like this: - -```yaml ---- -secrets: /config/secrets.yaml -appdaemon: - latitude: 52.379189 - longitude: 4.899431 - elevation: 2 - time_zone: Europe/Amsterdam - plugins: - HASS: - type: hass -http: - url: http://127.0.0.1:5050 -hadashboard: -admin: -api: -``` - -Be sure to check the "Upgrading from 3.x" on the AppDaemon website: - - - ## Changelog & Releases This repository keeps a change log using [GitHub's releases][releases] @@ -208,7 +180,10 @@ 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. +[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg +[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_appdaemon [alpine-packages]: https://pkgs.alpinelinux.org/packages +[appdaemon]: https://appdaemon.readthedocs.io [contributors]: https://github.com/hassio-addons/addon-appdaemon/graphs/contributors [discord-ha]: https://discord.gg/c5DvZ4e [discord]: https://discord.me/hassioaddons @@ -218,4 +193,6 @@ SOFTWARE. [python-packages]: https://pypi.org/ [reddit]: https://reddit.com/r/homeassistant [releases]: https://github.com/hassio-addons/addon-appdaemon/releases +[repository-badge]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg +[repository]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository [semver]: http://semver.org/spec/v2.0.0.htm diff --git a/appdaemon/README.md b/appdaemon/README.md index 7213b501..9eb915a1 100644 --- a/appdaemon/README.md +++ b/appdaemon/README.md @@ -1,4 +1,4 @@ -# Home Assistant Community Add-on: AppDaemon 4 +# Home Assistant Community Add-on: AppDaemon [![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] @@ -12,10 +12,10 @@ Python Apps and HADashboard for Home Assistant ## About -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. +[AppDaemon][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. ![HADashboard screenshot][screenshot] @@ -35,6 +35,7 @@ If you are more interested in stable releases of our add-ons: +[appdaemon]: https://appdaemon.readthedocs.io [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg @@ -45,6 +46,6 @@ If you are more interested in stable releases of our add-ons: [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png [patreon]: https://www.patreon.com/frenck [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg -[release-shield]: https://img.shields.io/badge/version-v0.8.1-blue.svg -[release]: https://github.com/hassio-addons/addon-appdaemon/tree/v0.8.1 +[release-shield]: https://img.shields.io/badge/version-v0.8.2-blue.svg +[release]: https://github.com/hassio-addons/addon-appdaemon/tree/v0.8.2 [screenshot]: https://github.com/hassio-addons/addon-appdaemon/raw/main/images/screenshot.png \ No newline at end of file diff --git a/appdaemon/config.yaml b/appdaemon/config.yaml index 07a4aca7..7820c529 100644 --- a/appdaemon/config.yaml +++ b/appdaemon/config.yaml @@ -4,6 +4,7 @@ arch: - armhf - armv7 - i386 +codenotary: codenotary@frenck.dev description: Python Apps and Dashboard using AppDaemon 4.x for Home Assistant homeassistant_api: true image: ghcr.io/hassio-addons/appdaemon/{arch} @@ -12,7 +13,7 @@ map: - config:rw - share:rw - ssl -name: AppDaemon 4 +name: AppDaemon options: init_commands: [] python_packages: [] @@ -32,5 +33,5 @@ schema: slug: appdaemon uart: true url: https://github.com/hassio-addons/addon-appdaemon -version: 0.8.1 +version: 0.8.2 webui: http://[HOST]:[PORT:5050]