Skip to content

Commit 0a2d613

Browse files
committed
Improve readme about bridge setup basaed on: tomer-w/victron_mqtt#37
1 parent 79d278e commit 0a2d613

1 file changed

Lines changed: 38 additions & 2 deletions

File tree

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,15 @@ This script will fetch the latest version of the integration directly from the r
6161

6262
## Configuration
6363

64-
The integration can be configured in two ways:
64+
The integration can be configured in three ways:
6565

6666
### Method 1: Automatic Discovery
6767
1. Your Victron device should be automatically discovered if it has MQTT enabled
6868
2. Go to Settings > Devices & Services
6969
3. Look for the "Victron MQTT Integration" in the discovered section
7070
4. Follow the configuration flow
7171

72-
### Method 2: Manual Configuration
72+
### Method 2: Manual Configuration (Direct Connection)
7373
1. Go to Settings > Devices & Services
7474
2. Click "Add Integration"
7575
3. Search for "Victron MQTT Integration"
@@ -80,6 +80,41 @@ The integration can be configured in two ways:
8080
- Password: (optional)
8181
- SSL: Enable/disable SSL connection
8282

83+
### Method 3: Using Home Assistant MQTT Broker (Bridged Configuration)
84+
Some users prefer to reduce the direct load on their Victron server and use bridge from the Venus device to a local mosquitto server running as add-on on the HAOS.
85+
86+
#### Prerequisites
87+
1. Install the [Mosquitto broker add-on](https://github.com/home-assistant/addons/tree/master/mosquitto) from the Home Assistant Add-on Store
88+
2. Configure a user and password for the MQTT broker in the add-on configuration
89+
90+
#### Configuration Steps
91+
1. **Configure the Mosquitto Bridge**: Edit the Mosquitto configuration file at `/share/mosquitto/mosquitto.conf` (accessible via File Editor add-on or SSH) and add:
92+
```
93+
connection victron
94+
address <YOUR_VENUS_IP>:1883
95+
topic N/# in 0
96+
# TO CHANGE settings via MQTT, one has to write to the "W/" topic!!
97+
topic W/# out 0
98+
topic R/# out 0
99+
start_type automatic
100+
allow_anonymous true
101+
```
102+
Replace `<YOUR_VENUS_IP>` with your Victron device's IP address.
103+
104+
2. **Restart the Mosquitto Add-on** to apply the bridge configuration
105+
106+
3. **Configure the Integration**: When setting up the Victron MQTT Integration:
107+
- Host: `core-mosquitto` (the internal hostname for the HA MQTT broker)
108+
- Port: `1883`
109+
- Username: Your MQTT broker username
110+
- Password: Your MQTT broker password
111+
- SSL: Disable (internal connection doesn't require SSL)
112+
113+
#### Benefits of Bridged Configuration
114+
- Reduces load on the Venus MQTT server
115+
- Provides a single MQTT broker for all your Home Assistant MQTT devices
116+
- Allows for better network traffic management
117+
83118
## Adding entities
84119
If you want to help the community and add more entities, please take a look at the [module](https://github.com/tomer-w/victron_mqtt) which drives this integration. It is very simple to extend this integration. I wrote a [document](https://github.com/tomer-w/victron_mqtt/blob/main/CONTRIBUTING.md) about it.
85120

@@ -101,6 +136,7 @@ If you want to help the community and add more entities, please take a look at t
101136
- enable SSL/TLS
102137
- use user root
103138
- use password that you have defined to protect the instance
139+
- **Alternative**: Consider using the bridged configuration (Method 3) if you're experiencing frequent connectivity issues or want to reduce load on your Venus device.
104140

105141
2. **Authentication Failed**
106142
- Double-check the username and password if authentication is enabled.

0 commit comments

Comments
 (0)