Skip to content

Commit 5293da8

Browse files
authored
Update README.md
1 parent 14f5555 commit 5293da8

File tree

1 file changed

+32
-7
lines changed

1 file changed

+32
-7
lines changed

README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[![Validate with hassfest](https://github.com/HAEdwin/homeassistant-apsystems_ecu_proxy/actions/workflows/hassfest.yaml/badge.svg)](https://github.com/HAEdwin/homeassistant-apsystems_ecu_proxy/actions/workflows/hassfest.yaml)
22
[![Validate with HACS](https://github.com/HAEdwin/homeassistant-apsystems_ecu_proxy/actions/workflows/validatewithhacs.yml/badge.svg)](https://github.com/HAEdwin/homeassistant-apsystems_ecu_proxy/actions/workflows/validatewithhacs.yml)
3-
![Home Assistant Dashboard](https://github.com/HAEdwin/homeassistant-apsystems_ecu_proxy/blob/main/impression.jpg)
3+
4+
![Home Assistant Dashboard](https://github.com/HAEdwin/homeassistant-apsystems_ecu_proxy/blob/main/Capture.PNG)
45
# APsystems ECU Proxy
56
Works and tested with the ECU-R (2160....) if the integration works for your ECU model, please let me know which model you own!
67
The integration is not compatible with the ECU-C https://github.com/HAEdwin/homeassistant-apsystems_ecu_proxy/issues/2.
@@ -12,26 +13,50 @@ Any returned data from EMA is directly sent back to the ECU. After this, the opt
1213
This custom integration was made possible by the hard work and excellent knowledge of @msp1974 - thank you for your creativity in solving the new challenges that this integration presented!
1314

1415
## Prerequisites
15-
- An APsystems ECU device starting with ECU-ID 2160 (might be compatible with other ECU types except for the ECU-C https://github.com/HAEdwin/homeassistant-apsystems_ecu_proxy/issues/2)
16+
- An APsystems ECU device starting with ECU-ID 2160 (might be compatible with other ECU types except for the ECU-C https://github.com/HAEdwin/homeassistant-apsystems_ecu_proxy/issues/2).
1617
- PiHole, AdGuard running as add-on installed on Home Assistant or something else like Unifi controller (from version 8.2.93) to rewrite DNS.
18+
- Working HACS installation and GitHub account (manual installation is possible).
1719

1820
## Install the integration
21+
_Note for pre-v1.1.0 users:
22+
Take into account the changed workflow in which no migration provision has been made.
23+
It is best to remove and reinstall the integration via HACS._
24+
25+
The installation of custom integrations is done in three steps (assuming HACS is already installed):
26+
27+
**1. Downloading the custom integration**
28+
- Navigate to HACS and choose the overflow menu in the top right corner of the Home Assistant Community Store.
29+
- Choose Custom repositories and paste the url: https://github.com/HAEdwin/homeassistant-apsystems_ecu_proxy in the Repository field.
30+
- Choose Type > Integration and select the [Add]-button.
31+
From this point it might allready have been added to the personal store repository.
32+
- In HACS search for APsystems and the APsystems ECU Proxy will be listed in de Available for download section.
33+
- From the overflow menu on the right select [Download] and automatically the latest version will be listed for download so choose [Download].
34+
- HA Settings will now show the repair action that a Restart is required, submit the action and HA will restart.
35+
36+
After HA's restart the downloaded custom integration will be detected by HA.
37+
The integration will need to be configured in order to fully integrate it in HA and make it work.
1938

20-
## Rewrite DNS traffic
39+
**2. Integrating the custom integration into Home Assistant**
40+
- Navigate to [Settings] > [Devices & services] and choose the button [+ ADD INTEGRATION].
41+
- In Search for a brand name, choose APsystems and the APsystems ECY Proxy will be listed.
42+
- Select it and the Configuration diaglog will show, defaults are fine right now so choose [SUBMIT].
43+
44+
In worst case scenario you will have to wait for 10 minutes before all the devices and entities will show up. After that you can start the fun part of adding the entities to the dashboard.
45+
46+
**3. Rewrite DNS traffic**
2147
Use PiHole, AdGuard of Unifi (or any other preferred method) to rewrite DNS. For example in AdGuard: Navigate to > Filters > DNS Rewrites > Add DNS rewrite > For domain name enter: ecu.apsystemsema.com > for IP-address enter: IP-address where the integration runs.
2248
Within 6 minutes data should be received by the integration and entities will appear.
2349

2450
## Available sensors
2551
- ECU: Current Power, Daily Max Power, Lifetime Max Power, Hourly Energy Production, Daily Energy Production, Lifetime Energy Production, Inverters Online, Lifetime Energy, Last Update
2652
- Inverters: Temperature, Frequency, Power per channel, Current per channel, Voltage per channel
27-
- Calculated: Hourly Energy produced, Daily Energy produced, Lifetime Energy produced, Daily Max Power, Lifetime Max Power.
53+
54+
_Note that the sensors ending with "Production" are calculated sensors and results may differ from EMA._
2855

2956
## Q & A
3057
- Q: I see different results from the integration and at EMA, why is that?
31-
A: Partly it depends on when you compare the results. If the inverters are offline, the ECU will start a maintenance cycle. The completeness of data transfer is checked and missed data at EMA is resent to EMA. This means that the results may not match each other better until the next day. Values ​​may differ because the time span over which results are calculated is different. However, differences should not be large because both the integration and EMA use the same data.
58+
A: Partly it depends on when you compare the results. If the inverters are offline, the ECU will start a maintenance cycle. The completeness of data transfer is checked and missed data at EMA is resent to EMA. This means that the results may not match each other better until the next day. Values ​​may differ because the time span over which results are calculated is different. However, differences should not be large because both the custom integration and EMA use the same data supplied by the ECU.
3259
- Q: I get the message "No devices or entities" after installing the integration?
3360
A: The inverters are off-line, without them the integration is unable to determen what hardware is connected to the ECU.
3461
- Q: Will deleting the integration make me loose all the data (like Lifetime Energy)?
3562
A: Yes, deleting the integration will remove the entities and their most current values - history data however is kept in de HA database.
36-
- Q: On what day does the new week start?
37-
A: It starts on monday.

0 commit comments

Comments
 (0)