restructure documentation to official evcc.io website and just linkin…

…g to it
evcc-io · Feb 19, 2025 · 4eb1387 · 4eb1387
1 parent f6a994f
commit 4eb1387
Show file tree

Hide file tree

Showing 20 changed files with 25 additions and 652 deletions.
diff --git a/evcc/LICENSE → LICENSE b/evcc/LICENSE → LICENSE
diff --git a/README.md b/README.md
@@ -1,112 +1,6 @@
-# evcc 🚘☀️ Home Assistant Addon
+# evcc 🚘☀️ Home Assistant Addons
 
 > [!NOTE]
->This guide is aimed for users running Home Assistant. Of course it is possible to run EVCC outside Home Assistant too, but as is has a very low footprint running EVCC as an
->Addon is the simplest ways.
-
-> [!IMPORTANT]
->
->On 16.02.2025 with evcc version 0.200.1 we followed the [Home Assistant approach](https://developers.home-assistant.io/blog/2023/11/06/public-addon-config/) on how to store user configuration data hold by addons. We are handling this for you, so you should not face any issues. If you need help, ask [here](https://github.com/evcc-io/hassio-addon/issues/75).
+>This repository holds both evcc Home Assistant Addons, the **evcc** and **evcc (nightly)**. Please refer to the [official documentation](https://docs.evcc.io/en/docs/installation/home-assistant) for instructions on how to install and configure the Addons.
 >
->What exactly has changed?
->- Your configuration file i.e. `evcc.yaml` which was previously saved within `/homeassistant/`is now transfered to `/addon_configs/<slug>_evcc/`.
->- Your database file i.e. `evcc.db` is only transfered to `/addon_configs/<slug>_evcc/` if you manually moved it to `/homeassistant/` before, otherwise it will stay untouched in `/data/`.
->- If you used subfolders, we are keeping them. If you used custom naming of your configuration or database file, we are also keeping them.
->- Your old file `/homeassistant/evcc.yaml` will be renamed to `/homeassistant/evcc.yaml.migrated` and can be manually deleted. The same applies to the `evcc.db` if you had it under `/homeassistant`.
->
->Can I stay with my files in `/homeassistant/`?
->- Basically you can but we do not suggest that! Why? Cause backups of evcc are then not containing your configuration and/or db.
->- If you want to ignore that and do it, you need to manually move your files from `/addon_configs/<slug>_evcc/` to `/homeassistant/` and change the paths in your evcc addon configuration to the new path, i.e. `/homeassistant/evcc.yaml`and restart the evcc addon.
-
-## Installation Guide
-
-1. Click -> Add-on Store under Settings - Addons.
-2. Click -> three dots -> Repositories.
-3. Copy https://github.com/evcc-io/hassio-addon Click -> Add
-4. Reload the WebSite (CTRL+R or CTRL+F5 or CTRL+Fn+F5)
-5. Find the "evcc" add-on and click it.
-6. Click on the "INSTALL" button.
-
-### Configuration
-
-Go to Information menu in the "evcc" Addon and activate "show in side bar" (evcc UI http://your-ha-instance-ip-address:7070)
-
-Go to Configuration menu and select your working directory (example):
-<!---
-<Screenshot
-  name="screenshots/ha_configuration_ui"
-  caption="Screenshot der Arbeitsverzeichnisse und Dateinamen in der Konfiguration."
-/>
---->
-
-```sh
-- config_file: /config/evcc.yaml
-- sqlite_file: /data/evcc.db
-```
-
-Leave the Network section unchanged.
-
-Create an evcc configuration file _evcc.yaml_ in your Home Assistant root folder (`/addon_configs/<slug>_evcc`).
-To access and edit the configuration file, you have plenty options:
-- [Visual Studio Code](https://github.com/hassio-addons/addon-vscode), within Visual Studio Code just click the hamburger menu in the upper left and select "File", "Open Folder...", select `/addon_configs/<slug>_evcc`
-- [File Editor](https://github.com/home-assistant/addons/tree/master/configurator), ensure that you disabled the option "Enforce Basepath" under File editor addon configuration and restart the File editor addon afterwards, then navigate to `/addon_configs/<slug>_evcc`
-- [SSH](https://github.com/hassio-addons/addon-ssh), navigate to `/addon_configs/<slug>_evcc` and use nano to edit the file
-
-Copy the content of this [Template](evcc/ha_evcc_template.yaml) to your _evcc.yaml_ file you just created.
-The template creates a default configuration with static demo entities.
-
-> [!NOTE]
->If you want to see evcc how it is running in dynamic demo instead, copy the content of https://github.com/evcc-io/evcc/blob/master/cmd/demo.yaml into your _evcc.yaml_ file.
-
-- Now you are ready to go and to start the addon.
-- Check the installation by opening the WebUI. You should see the evcc web interface in demo mode.
-- If this runs well you can start to edit the _evcc.yaml_ file and creating your own setup (only with the static template possible).
-
->[!TIP]
->If you struggle with the manual configuration you might consider to install a standalone evcc Windows or Linux system and using the Configuration wizard.
->
->The Configuration wizard is not available under the Home Assistant environment!!!
->
->You will find it easier to use `evcc configure` there, and then copy the generated _evcc.yaml_ to the desired system.
-
-> [!IMPORTANT]
->**Advanced users** (those with evcc experience & some technical know-how) might want to use the advanced configurator:
->- Test each new added device to make sure your new configuration works.
->- Once all devices are configured, you can continue on to the setup via the UI.
-
-## Installation of the evcc Integration
-
-Proceed with installation process of the evcc Integration for Home Assistant as described in this section [Integrations](https://github.com/marq24/ha-evcc)
-
-## Upgrades
-
-The upgrade to the latest version of evcc, is included in the Home Assistant update process.
-
-> [!TIP]
->## How to find and copy /data/evcc.db
->
->Create a folder e.g. /evcc in homeassitant config directory (/homeassistant or /config).
->
->- Install "Advanced SSH & Web Terminal"
->- switch off "secure mode"
->- restart addon
->- start UI
->
->```sh
->docker -ps a
->```
->save the CONTAINER ID of evcc/evcc:0.130.12 -> e.g. 6d0b4119b012 (CONTAINER ID of EVCC)
->
->List the files in /data:
->```sh
->docker exec 6d0b4119b012 ls -la /data
->```
->Copy your evcc to /config/evcc:
->```sh
->docker cp 6d0b4119b012:/data/evcc.db /homeassistant/evcc/
->```
-
-## Configuration of [evcc](https://github.com/evcc-io/evcc)
-
-   - https://docs.evcc.io/docs/guides/setup
-
+>If you want to know more about evcc, continue reading [here](https://docs.evcc.io/en/docs/Home).
diff --git a/docs/4_evcc_tablet_standard_light.png b/docs/4_evcc_tablet_standard_light.png
diff --git a/docs/addonstore.png b/docs/addonstore.png
diff --git a/docs/addonstore2.png b/docs/addonstore2.png
diff --git a/docs/addonstore3.png b/docs/addonstore3.png
diff --git a/docs/addonstore4.png b/docs/addonstore4.png
diff --git a/docs/addonstore5.png b/docs/addonstore5.png
diff --git a/docs/notify.png b/docs/notify.png
diff --git a/docs/evcc_addon_config_and_db_file_logic.png → ...v/evcc_addon_config_and_db_file_logic.png b/docs/evcc_addon_config_and_db_file_logic.png → ...v/evcc_addon_config_and_db_file_logic.png
diff --git a/evcc-nightly/CHANGELOG.md b/evcc-nightly/CHANGELOG.md
@@ -4,4 +4,4 @@ https://github.com/evcc-io/evcc/releases
 
 ## [nightly.20250216-d3814b1] - 2025-02-16
 
-IMPORTANT: Starting with this release we followed the Home Assistant approach on how to store user configuration data hold by addons. Please read the _Important_ section [here](https://github.com/evcc-io/hassio-addon/blob/main/evcc/DOCS.md) to understand the changes we are automatically applying for you.
+IMPORTANT: Starting with this release we followed the Home Assistant approach on how to store user configuration data hold by addons. Please read the _Important_ section [here](https://docs.evcc.io/en/docs/installation/home-assistant) to understand the changes we are automatically applying for you.
diff --git a/evcc-nightly/DOCS.md b/evcc-nightly/DOCS.md
@@ -1 +1,6 @@
-Please refer to the [documentation](../evcc/DOCS.md) of the main addon.
+# evcc 🚘☀️ Home Assistant Addon: evcc (nightly)
+
+> [!NOTE]
+>This is the **evcc (nightly)** Home Assistant Addon. Please refer to the [official documentation](https://docs.evcc.io/en/docs/installation/home-assistant) for instructions on how to install and configure the Addon.
+>
+>If you want to know more about evcc, continue reading [here](https://docs.evcc.io/en/docs/Home).
diff --git a/evcc-nightly/README.md b/evcc-nightly/README.md
@@ -0,0 +1,6 @@
+# evcc 🚘☀️ Home Assistant Addon: evcc (nightly)
+
+> [!NOTE]
+>This is the **evcc (nightly)** Home Assistant Addon. Please refer to the [official documentation](https://docs.evcc.io/en/docs/installation/home-assistant) for instructions on how to install and configure the Addon.
+>
+>If you want to know more about evcc, continue reading [here](https://docs.evcc.io/en/docs/Home).
diff --git a/evcc-nightly/icon.png b/evcc-nightly/icon.png
diff --git a/evcc-nightly/logo.png b/evcc-nightly/logo.png
diff --git a/evcc/CHANGELOG.md b/evcc/CHANGELOG.md
@@ -4,4 +4,4 @@ https://github.com/evcc-io/evcc/releases
 
 ## [0.200.1] - 2025-02-16
 
-IMPORTANT: Starting with this release we followed the Home Assistant approach on how to store user configuration data hold by addons. Please read the _Important_ section [here](https://github.com/evcc-io/hassio-addon/blob/main/evcc/DOCS.md) to understand the changes we are automatically applying for you.
+IMPORTANT: Starting with this release we followed the Home Assistant approach on how to store user configuration data hold by addons. Please read the _Important_ section [here](https://docs.evcc.io/en/docs/installation/home-assistant) to understand the changes we are automatically applying for you.
diff --git a/evcc/DOCS.md b/evcc/DOCS.md
@@ -1,158 +1,6 @@
-# evcc 🚘☀️ Home Assistant Addon
+# evcc 🚘☀️ Home Assistant Addon: evcc
 
 > [!NOTE]
->This guide is aimed for users running Home Assistant. Of course it is possible to run EVCC outside Home Assistant too, but as is has a very low footprint running EVCC as an
->Addon is the simplest ways.
-
-> [!IMPORTANT]
->
->On 16.02.2025 with evcc version 0.200.1 we followed the [Home Assistant approach](https://developers.home-assistant.io/blog/2023/11/06/public-addon-config/) on how to store user configuration data hold by addons. We are handling this for you, so you should not face any issues. If you need help, ask [here](https://github.com/evcc-io/hassio-addon/issues/75).
->
->What exactly has changed?
->- Your configuration file i.e. `evcc.yaml` which was previously saved within `/homeassistant/`is now transfered to `/addon_configs/<slug>_evcc/`.
->- Your database file i.e. `evcc.db` is only transfered to `/addon_configs/<slug>_evcc/` if you manually moved it to `/homeassistant/` before, otherwise it will stay untouched in `/data/`.
->- If you used subfolders, we are keeping them. If you used custom naming of your configuration or database file, we are also keeping them.
->- Your old file `/homeassistant/evcc.yaml` will be renamed to `/homeassistant/evcc.yaml.migrated` and can be manually deleted. The same applies to the `evcc.db` if you had it under `/homeassistant`.
->
->Can I stay with my files in `/homeassistant/`?
->- Basically you can but we do not suggest that! Why? Cause backups of evcc are then not containing your configuration and/or db.
->- If you want to ignore that and do it, you need to manually move your files from `/addon_configs/<slug>_evcc/` to `/homeassistant/` and change the paths in your evcc addon configuration to the new path, i.e. `/homeassistant/evcc.yaml`and restart the evcc addon.
-
-## Installation Guide
-
-1. Click -> Add-on Store under Settings - Addons.
-2. Click -> three dots -> Repositories.
-3. Copy https://github.com/evcc-io/hassio-addon Click -> Add
-4. Reload the WebSite (CTRL+R or CTRL+F5 or CTRL+Fn+F5)
-5. Find the "evcc" add-on and click it.
-6. Click on the "INSTALL" button.
-
-### Configuration
-
-Go to Information menu in the "evcc" Addon and activate "show in side bar" (evcc UI http://your-ha-instance-ip-address:7070)
-
-Go to Configuration menu and select your working directory (example):
-<!---
-<Screenshot
-  name="screenshots/ha_configuration_ui"
-  caption="Screenshot der Arbeitsverzeichnisse und Dateinamen in der Konfiguration."
-/>
---->
-
-```sh
-- config_file: /config/evcc.yaml
-- sqlite_file: /data/evcc.db
-```
-
-Leave the Network section unchanged.
-
-Create an evcc configuration file _evcc.yaml_ in your Home Assistant root folder (`/addon_configs/<slug>_evcc`).
-To access and edit the configuration file, you have plenty options:
-- [Visual Studio Code](https://github.com/hassio-addons/addon-vscode), within Visual Studio Code just click the hamburger menu in the upper left and select "File", "Open Folder...", select `/addon_configs/<slug>_evcc`
-- [File Editor](https://github.com/home-assistant/addons/tree/master/configurator), ensure that you disabled the option "Enforce Basepath" under File editor addon configuration and restart the File editor addon afterwards, then navigate to `/addon_configs/<slug>_evcc`
-- [SSH](https://github.com/hassio-addons/addon-ssh), navigate to `/addon_configs/<slug>_evcc` and use nano to edit the file
-
-Copy the content of this [Template](evcc/ha_evcc_template.yaml) to your _evcc.yaml_ file you just created.
-The template creates a default configuration with static demo entities.
-
-> [!NOTE]
->If you want to see evcc how it is running in dynamic demo instead, copy the content of https://github.com/evcc-io/evcc/blob/master/cmd/demo.yaml into your _evcc.yaml_ file.
-
-- Now you are ready to go and to start the addon.
-- Check the installation by opening the WebUI. You should see the evcc web interface in demo mode.
-- If this runs well you can start to edit the _evcc.yaml_ file and creating your own setup (only with the static template possible).
-
->[!TIP]
->If you struggle with the manual configuration you might consider to install a standalone evcc Windows or Linux system and using the Configuration wizard.
->
->The Configuration wizard is not available under the Home Assistant environment!!!
->
->You will find it easier to use `evcc configure` there, and then copy the generated _evcc.yaml_ to the desired system.
-
-> [!IMPORTANT]
->**Advanced users** (those with evcc experience & some technical know-how) might want to use the advanced configurator:
->- Test each new added device to make sure your new configuration works.
->- Once all devices are configured, you can continue on to the setup via the UI.
-
-## Installation of the evcc Integration
-
-Proceed with installation process of the evcc Integration for Home Assistant as described in this section [Integrations](../integrations/home-assistant)
-
-## Upgrades
-
-The upgrade to the latest version of evcc, is included in the Home Assistant update process.
-
-## Messages and Notifications
-
-Evcc is able to send you cloudless messages and notification via the [Home Assistant app](https://companion.home-assistant.io/download/).
-With this [tutorial](https://github.com/evcc-io/evcc/discussions/15531) you are able to get nice status messages.
-
-
-<img src="../docs/notify.png" alt="evcc Home Assistatnt App Notify in IOS" width="400" >
-
-
-> [!TIP]
->## How to find and copy /data/evcc.db
+>This is the **evcc** Home Assistant Addon. Please refer to the [official documentation](https://docs.evcc.io/en/docs/installation/home-assistant) for instructions on how to install and configure the Addon.
 >
->Create a folder e.g. /evcc in homeassitant config directory (/homeassistant or /config).
->
->- Install "Advanced SSH & Web Terminal"
->- switch off "secure mode"
->- restart addon
->- start UI
->
->```sh
->docker -ps a
->```
->save the CONTAINER ID of evcc/evcc:0.130.12 -> e.g. 6d0b4119b012 (CONTAINER ID of EVCC)
->
->List the files in /data:
->```sh
->docker exec 6d0b4119b012 ls -la /data
->```
->Copy your evcc to /config/evcc:
->```sh
->docker cp 6d0b4119b012:/data/evcc.db /homeassistant/evcc/
->```
-
-## Configuration of [evcc](https://github.com/evcc-io/evcc)
-
-   - https://docs.evcc.io/docs/guides/setup
-
-## Support
-
-Got questions?
-
-Please [open an issue](https://github.com/evcc-io/evcc/issues) in Github
-
-## Authors & contributors
-
-evcc is maintained by [andig](https://github.com/evcc-io/evcc).
-
-Home Assistant Add-On created by [cathiele](https://github.com/cathiele) and maintained by [thecem](https://github.com/thecem) .
-
-Contributions by [Tscherno](https://github.com/Tscherno).
-
-## License
-
-MIT License
-
-Copyright (c) 2020 [andig](https://github.com/evcc-io/evcc)
-
-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.
+>If you want to know more about evcc, continue reading [here](https://docs.evcc.io/en/docs/Home).
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,4 @@ https://github.com/evcc-io/evcc/releases

		## [nightly.20250216-d3814b1] - 2025-02-16

		IMPORTANT: Starting with this release we followed the Home Assistant approach on how to store user configuration data hold by addons. Please read the _Important_ section [here](https://github.com/evcc-io/hassio-addon/blob/main/evcc/DOCS.md) to understand the changes we are automatically applying for you.
		IMPORTANT: Starting with this release we followed the Home Assistant approach on how to store user configuration data hold by addons. Please read the _Important_ section [here](https://docs.evcc.io/en/docs/installation/home-assistant) to understand the changes we are automatically applying for you.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,4 @@ https://github.com/evcc-io/evcc/releases

		## [0.200.1] - 2025-02-16

		IMPORTANT: Starting with this release we followed the Home Assistant approach on how to store user configuration data hold by addons. Please read the _Important_ section [here](https://github.com/evcc-io/hassio-addon/blob/main/evcc/DOCS.md) to understand the changes we are automatically applying for you.
		IMPORTANT: Starting with this release we followed the Home Assistant approach on how to store user configuration data hold by addons. Please read the _Important_ section [here](https://docs.evcc.io/en/docs/installation/home-assistant) to understand the changes we are automatically applying for you.