You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,25 +11,25 @@ If a breaking change were to be introduced expect the release notes to reflect t
11
11
If you are missing a feature or experience any issues please report them in the issue tracker.
12
12
13
13
## Limitations
14
-
The current state of this integration provides the following limitations regarding it's use:
14
+
The current state of this integration provides the following limitations regarding its use:
15
15
- Configuring the integration will be relatively slow if a discovery scan is required.
16
-
- This integration wasn't tested with a threephase system. Although basic functionality should work minor bugs could have gone unnoticed
16
+
- This integration wasn't tested with a three-phase system. Although basic functionality should work minor bugs could have gone unnoticed
17
17
18
18
## Important Note
19
19
This integration was written an tested with the latest victron firmware running.
20
20
GX version: v3.10 (support validated from v2.92)
21
21
Multiplus version: 492
22
22
23
23
Victron continuously improves upon the modbus implementation by adding new registers.
24
-
Therefore older firmware versions might not expose all registers this integration expects to be present.
24
+
Therefore, older firmware versions might not expose all registers this integration expects to be present.
25
25
This might (depending on your firmware and connected devices) cause odd behaviour where some but not all devices connected to your GX device will be correctly detected by this integration.
26
26
27
27
The best solution for this issue is to upgrade to the latest firmware.
28
28
You can also open an issue to get your firmware version supported.
29
29
This issue should contain the following information:
30
30
- Connected devices
31
31
- Firmware versions of the connected devices
32
-
- Missing device type (grid, vebus, bms can etc)
32
+
- Missing device type (grid, vebus, bms can etc.)
33
33
- Missing unit id (among other 30, 100, 227, 228)
34
34
35
35
Please note that it might take some time for older firmware versions to get full support (after a ticket is opened).
@@ -49,21 +49,22 @@ As of november 2022 the built-in home assistant modbus integration runs on a ver
49
49
If you install this integration the built-in modbus integration will stop to work due to breaking changes between 2.x.x and 3.0.0
50
50
51
51
## Important announcement:
52
-
Starting from homeassistant core version 2025.1.x the built-in modbus integration now uses pymodbus version 3.7.4.
52
+
Starting from home assistant core version 2025.1.x the built-in modbus integration now uses pymodbus version 3.7.4.
53
53
Version 0.4.0 (and up) of this integration will also use the 3.7.4 pymodbus version.
54
54
55
55
Although core version >= 2023.2 and previous versions of this integration should be compatible it is recommended that all users update both core and this integration in the same patch round.
56
56
Since having multiple library version requirements might cause the built-in 3.1.1 library to be overwritten by 3.0.2 reference of versions 0.0.6 and earlier.
57
57
This could cause issues if you are using specific configuration options of the built-in modbus integration that weren't working with pymodbus 3.0.2 and were fixed in 3.1.1
58
58
59
59
## Manual
60
-
1. Clone the repository to your machine.
61
-
2. Copy the contents of custom_components/ to your machine running home assistant.
62
-
3. Restart home assistant
63
-
4. goto "settings -> devices and services -> integration"
64
-
5. click on "add integration"
65
-
6. Search for "victron"
66
-
7. Fill in the correct options and submit
60
+
1. Clone the repository to your machine running home assistant: `git clone https://github.com/sfstar/hass-victron.git`
61
+
2. Create the custom_components folder in your home assistant home folder if it doesn't exist: `mkdir homeassitant/custom_components`
62
+
3. Copy the custom_components/victron folder (from step 1.) into the homeassistant/custom_components folder on your machine: `cp custom_components/victron homeassitant/custom_components`
63
+
4. Restart home assistant
64
+
5. Goto `Settings -> Devices and Services -> Integration`
65
+
6. Click on `Add Integration`
66
+
7. Search for `victron`
67
+
8. Fill in the correct options and submit
67
68
68
69
## HACS
69
70
@@ -96,7 +97,7 @@ The integration provides end users with the following configuration options.
96
97
97
98
## Host
98
99
The IP address of the victron GX device running the modbusTCP service.
99
-
It's only configureable during setup and it's recommended to make the GX device static in your router
100
+
It's only configurable during setup and it's recommended to make the GX device static in your router
100
101
101
102
## Port
102
103
The port on which victron exposes the modbusTCP service.
@@ -115,9 +116,9 @@ Since you can't accidentally change any setting that might cause damage (i.e. to
115
116
116
117
It is currently unknown and untested if the ModbusTCP server write registers are guard-railed. (Have protections/limits in place that prevent damage)
117
118
Therefore, this integration offers users the ability to set "soft" guard rails by requiring current and voltage settings and limits to be specified by the end user.
118
-
Although this make the integration safer, one should always doublecheck if the provided write entities aren't capable of going to high / low for your system.
119
+
Although this make the integration safer, one should always double-check if the provided write entities aren't capable of going to high / low for your system.
119
120
120
-
Currently the options are tailored to the US / EU base settings and lifepo4 battery voltages.
121
+
Currently, the options are tailored to the US / EU base settings and lifepo4 battery voltages.
121
122
If you use another grid specification or battery type you can submit an issue to have them included.
122
123
123
124
### AC Current
@@ -135,10 +136,10 @@ The voltage profile to use in order to calculate the voltage boundaries (i.e. 4s
135
136
136
137
### AC Voltage
137
138
The AC voltage for a single phase in your region (currently supported is US: 120v and EU: 230v)
138
-
This setting is used in combination with AC current to automatically calcultate the max wattage for applicable wattage settings.
139
+
This setting is used in combination with AC current to automatically calculate the max wattage for applicable wattage settings.
139
140
140
141
# Resources
141
-
The following links can be helpfull resources:
142
+
The following links can be helpful resources:
142
143
-[setting up modbusTCP on the gx device](https://www.victronenergy.com/live/ccgx:modbustcp_faq)
143
144
-[Great UI card for the gx device data](https://github.com/flyrmyr/system-flow-card)
0 commit comments