diff --git a/README.md b/README.md index 9237fa7..57567fb 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,16 @@ +EMHASS + # EMHASS Add-on ### A Home Assistant Add-on for the EMHASS module: Energy Management for Home Assistant + + GitHub release (latest by date) + + + GitHub +
@@ -48,11 +56,37 @@ For any Issues/Feature Requests for the EMHASS core module, create a new issue h The steps to install EMHASS as an Home Assistant addon: +1) Add the EMHASS-Add-on repository to the HAOS add-on store +Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled. + +2) Install the EMHASS Add-on +Open your Home Assistant instance and show the dashboard of an add-on. +Click on `install`, the installation may take some time depending on your hardware. + +4) Start the EMHASS addon + - Once installed, head into the EMHASS addon + - click `start` to start the EMHASS web server + - For consistent use, it is recommended that you enable: `Show in sidebar`,`Watchdog` and `Start on boot ` + +5) Open the EMHASS web interface, and configure parameters + - Click `OPEN WEB UI` to enter the EMHASS web server + - Click the cog icon ⚙️ to enter the emhass configuration page + - Insert your user specific parameters + - For users who wish to use `Solcast` or `Forecast.Solar` insert your secrets in the Home Assistant EMHASS configuration page, under `Show unused optional configuration options`. (E.g: `localhost:8123/hassio/addon/emhass/config`) + + +
+ Manual install steps + +## Installation Method 1 1) Add the EMHASS-Add-on repository to the HAOS add-on store - To install add the EMHASS Add-on repository in the Home Assistant store, follow [these steps](https://www.home-assistant.io/common-tasks/os/#installing-third-party-add-ons) - - This will be: Configuration > Add-ons & Backups open the add-on store > Add the URL of the repository (e.g https://github.com/davidusb-geek/emhass-add-on) and then press "Add". + - This will be: Open the add-on store with the button below, or go to settings in HA, select add-on and the add-on store. + Open your Home Assistant instance and show the add-on store. + - Press the 3 dots and choose repository. + - Add the URL of the repository (e.g https://github.com/davidusb-geek/emhass-add-on) and then press "Add". 2) Install the EMHASS Add-on - Look for the EMHASS Add-on tab and when inside the Add-on click on `install`. @@ -99,6 +133,7 @@ _Warning: This method will override the Docker image tag, and therefore will req - From here a new Addon Source under the name `Local add-ons` should appear _(if not repeat step 4)_ - Install the EMHASS addon, Note: after clicking the EMHASS addon, the `Current version: ` Tag on the top left of the EMHASS card. +
## Developing EMHASS/EMHASS-Add-on