diff --git a/docs/first_steps.md b/docs/first_steps.md deleted file mode 100644 index 22e93fd1..00000000 --- a/docs/first_steps.md +++ /dev/null @@ -1 +0,0 @@ -# First steps diff --git a/docs/setup_ha.md b/docs/setup_ha.md index 22e93fd1..85b9ea1b 100644 --- a/docs/setup_ha.md +++ b/docs/setup_ha.md @@ -1 +1,72 @@ -# First steps +# Setup Home Assistant + +## Installing AppDaemon + +The backend application for HomeAssistant is written in a python for [AppDaemon](https://github.com/AppDaemon/appdaemon). +This means it requires a working and running installation of AppDaemon. + +The easiest way to install it is through Home Assistant's Supervisor Add-on Store, it will be automaticly connected to your Home Assistant Instance. + +![hass-add-on-store](img/hass-add-on-store.png) + +### Add babel package to AppDaemon Container (Optional) + +For localisation (date in your local language) you need to add the python package babel to your AppDaemon Installation. + +![appdaemon-babel](img/appdaemon-babel.png) + + +## Installing Studio Code Server (optional, recommended) + +You will need a way to edit the `apps.yaml` config file in the Appdaemon folder. +Install Studio Code Server from Home Assistant's Supervisor Add-on Store to easily edit configuration Files on your HomeAssistant Instance. + +

+ + +
2. Installing HomeAssistant Community Store +

+ +## Installing HACS + +HACS is the Home Assistant Community Store and allows for community integrations and +automations to be updated cleanly and easily from the Home Assistant web user interface. +It's simple to install the AppDaemon app without HACS, but keeping up to date requires +manual steps that HACS will handle for you: you will be notified of updates, and they +can be installed by a click on a button. + +If you want to use HACS, you will have to follow [their documentation on how to install HACS](https://hacs.xyz/docs/setup/download). + +

+
+ +
3. Installing Lovelace AppDaemon Backend Application +

+ +## Installing AppDaemon Backend Application + +To install Lovelace UI Backend App with HACS, you will need to make sure that you enabled +AppDaemon automations in HACS, as these are not enabled by default: + +1. Click on `Configuration` on the left menu bar in Home Assistant Web UI +2. Select `Devices & Services` +3. Select `Integrations` +4. Find `HACS` and click on `Configure` +5. In the window that opens, make sure that `Enable AppDaemon apps discovery & tracking` + is checked, or check it and click `Submit` +6. If you just enabled this (or just installed HACS), you might have to wait a few minutes + as all repositories are being fetched; you might hit a GitHub rate limit, which might + then require you to wait a few hours for HACS to be fully configured. In this case, + you won't be able to proceed to the next steps until HACS is ready. + +Now, to install NSPanel Lovelace UI Backend with HACS, follow these steps: + +1. Click on `HACS` on the left menu bar in Home Assistant Web UI +2. Click on `Automations` in the right panel +3. Click on `Explore & download repositories` in the bottom right corner +4. Search for `NSPanel`, and click on `NSPanel Lovelace UI Backend` in the list that appears +5. In the bottom right corner of the panel that appears, click on + `Download this repository with HACS` +6. A confirmation panel will appear, click on `Download`, and wait for HACS to + proceed with the download +7. The Backend Application is now installed, and HACS will inform you when updates are available diff --git a/mkdocs.yml b/mkdocs.yml index 7a1425cc..fb65ca8d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -60,7 +60,7 @@ plugins: nav: - "Getting started": - - "First steps": first_steps.md + - "First steps": - "Prepare NsPanel": prepare_nspanel.md - "Setup Home Assistant": setup_ha.md - "FAQ": faq.md