Skip to content

Commit 4eb1387

Browse files
dm82mthecem
authored andcommitted
restructure documentation to official evcc.io website and just linking to it
1 parent f6a994f commit 4eb1387

20 files changed

+25
-652
lines changed

evcc/LICENSE renamed to LICENSE

File renamed without changes.

README.md

Lines changed: 3 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -1,112 +1,6 @@
1-
# evcc 🚘☀️ Home Assistant Addon
1+
# evcc 🚘☀️ Home Assistant Addons
22

33
> [!NOTE]
4-
>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
5-
>Addon is the simplest ways.
6-
7-
> [!IMPORTANT]
8-
>
9-
>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).
4+
>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.
105
>
11-
>What exactly has changed?
12-
>- Your configuration file i.e. `evcc.yaml` which was previously saved within `/homeassistant/`is now transfered to `/addon_configs/<slug>_evcc/`.
13-
>- 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/`.
14-
>- If you used subfolders, we are keeping them. If you used custom naming of your configuration or database file, we are also keeping them.
15-
>- 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`.
16-
>
17-
>Can I stay with my files in `/homeassistant/`?
18-
>- Basically you can but we do not suggest that! Why? Cause backups of evcc are then not containing your configuration and/or db.
19-
>- 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.
20-
21-
## Installation Guide
22-
23-
1. Click -> Add-on Store under Settings - Addons.
24-
2. Click -> three dots -> Repositories.
25-
3. Copy https://github.com/evcc-io/hassio-addon Click -> Add
26-
4. Reload the WebSite (CTRL+R or CTRL+F5 or CTRL+Fn+F5)
27-
5. Find the "evcc" add-on and click it.
28-
6. Click on the "INSTALL" button.
29-
30-
### Configuration
31-
32-
Go to Information menu in the "evcc" Addon and activate "show in side bar" (evcc UI http://your-ha-instance-ip-address:7070)
33-
34-
Go to Configuration menu and select your working directory (example):
35-
<!---
36-
<Screenshot
37-
name="screenshots/ha_configuration_ui"
38-
caption="Screenshot der Arbeitsverzeichnisse und Dateinamen in der Konfiguration."
39-
/>
40-
--->
41-
42-
```sh
43-
- config_file: /config/evcc.yaml
44-
- sqlite_file: /data/evcc.db
45-
```
46-
47-
Leave the Network section unchanged.
48-
49-
Create an evcc configuration file _evcc.yaml_ in your Home Assistant root folder (`/addon_configs/<slug>_evcc`).
50-
To access and edit the configuration file, you have plenty options:
51-
- [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`
52-
- [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`
53-
- [SSH](https://github.com/hassio-addons/addon-ssh), navigate to `/addon_configs/<slug>_evcc` and use nano to edit the file
54-
55-
Copy the content of this [Template](evcc/ha_evcc_template.yaml) to your _evcc.yaml_ file you just created.
56-
The template creates a default configuration with static demo entities.
57-
58-
> [!NOTE]
59-
>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.
60-
61-
- Now you are ready to go and to start the addon.
62-
- Check the installation by opening the WebUI. You should see the evcc web interface in demo mode.
63-
- If this runs well you can start to edit the _evcc.yaml_ file and creating your own setup (only with the static template possible).
64-
65-
>[!TIP]
66-
>If you struggle with the manual configuration you might consider to install a standalone evcc Windows or Linux system and using the Configuration wizard.
67-
>
68-
>The Configuration wizard is not available under the Home Assistant environment!!!
69-
>
70-
>You will find it easier to use `evcc configure` there, and then copy the generated _evcc.yaml_ to the desired system.
71-
72-
> [!IMPORTANT]
73-
>**Advanced users** (those with evcc experience & some technical know-how) might want to use the advanced configurator:
74-
>- Test each new added device to make sure your new configuration works.
75-
>- Once all devices are configured, you can continue on to the setup via the UI.
76-
77-
## Installation of the evcc Integration
78-
79-
Proceed with installation process of the evcc Integration for Home Assistant as described in this section [Integrations](https://github.com/marq24/ha-evcc)
80-
81-
## Upgrades
82-
83-
The upgrade to the latest version of evcc, is included in the Home Assistant update process.
84-
85-
> [!TIP]
86-
>## How to find and copy /data/evcc.db
87-
>
88-
>Create a folder e.g. /evcc in homeassitant config directory (/homeassistant or /config).
89-
>
90-
>- Install "Advanced SSH & Web Terminal"
91-
>- switch off "secure mode"
92-
>- restart addon
93-
>- start UI
94-
>
95-
>```sh
96-
>docker -ps a
97-
>```
98-
>save the CONTAINER ID of evcc/evcc:0.130.12 -> e.g. 6d0b4119b012 (CONTAINER ID of EVCC)
99-
>
100-
>List the files in /data:
101-
>```sh
102-
>docker exec 6d0b4119b012 ls -la /data
103-
>```
104-
>Copy your evcc to /config/evcc:
105-
>```sh
106-
>docker cp 6d0b4119b012:/data/evcc.db /homeassistant/evcc/
107-
>```
108-
109-
## Configuration of [evcc](https://github.com/evcc-io/evcc)
110-
111-
- https://docs.evcc.io/docs/guides/setup
112-
6+
>If you want to know more about evcc, continue reading [here](https://docs.evcc.io/en/docs/Home).

docs/4_evcc_tablet_standard_light.png

-135 KB
Binary file not shown.

docs/addonstore.png

-23 KB
Binary file not shown.

docs/addonstore2.png

-6.3 KB
Binary file not shown.

docs/addonstore3.png

-16.8 KB
Binary file not shown.

docs/addonstore4.png

-26.4 KB
Binary file not shown.

docs/addonstore5.png

-21.7 KB
Binary file not shown.

docs/notify.png

-175 KB
Binary file not shown.

0 commit comments

Comments
 (0)