GitHub repository: mr-manuel/venus-os_dbus-enphase-envoy
I wrote this script for myself. I'm not responsible, if you damage something using my script.
You like the project and you want to support me?
Since v0.2.0 this script works with the D5.x.x and D7.x.x firmware on the Enphase Envoy-S. You can choose the firmware in the config.ini.
The firmware D7.x.x has another authentication mechanism and needs a token for the local API access. This token is automatically requested and updated. To achieve this you need to enter your Enphase Enlighten credentials and the Envoy serial number in the config.ini.
Currently it works only for self-installers, since they are able to request a token that has the installer user. You can request a token over https://entrez.enphaseenergy.com/ -> Login -> For commissioned gateway -> Enter the name of your site (at least three letters to start the search), select the Gateway and then press create access token. Copy the token and paste it on https://www.jstoolset.com/jwt.
- If the
enphaseUserisinstallerthen this should work for you. - If the
enphaseUserisownerthen this probably won't work for you.
I'm currently trying to find a solution with the Enphase Support for this.
UPDATE (2023.06.06): The needed API /stream/meter will be available with the owner token after the release of a firmware update at the end of June. See Make "/stream/meter" available with "owner" token. After this happen I release the next stable release of this driver.
🚨 UPDATE (2023.09.18): Enphase did nothing until now. Your help is requested! Please also comment under Make "/stream/meter" available with "owner" token. Additionally contact the Enphase support, by linking to the article above, tell them that you need this function and ask when it will be released.
This script adds the Enphase Microinverters as a single PV system in Venus OS. The data is fetched from the Enphase Envoy-S device and publishes on the dbus as the service com.victronenergy.pvinverter.enphase_envoy with the VRM instance 61. The number of phases are automatically recognized, so it displays automatically the number of phases you are using (one, two or three).
It is also possible to publish the following data as JSON to a MQTT topic for other use (can be enabled in config.ini). For each list element a different topic is needed:
-
Meters (PV, Grid, Consumption): Power, current, voltage, powerreact, powerappearent, powerfactor, frequency, whToday, vahToday, whLifetime, vahLifetime for total (except: powerfactor and frequency), L1, L2 and L3
Note: If the power of the PV meter is below 5 W the driver will display 0 W. This prevents that a very small production power is shown when no sun is shining. -
Devices (Microinverters, Q-Relay): Serial number, device status, producing, communicating, provisioned and operating. For Q-Relay additionaly: relay [opened/closed] and reason
-
Inverters: Last report date and last report watts
-
Events: Latest 10 events from the Enphase Envoy-S
If you also want to use the Enphase Envoy-S as grid meter in Venus OS, then install the mr-manuel/venus-os_dbus-mqtt-grid package and insert the same MQTT broker and topic_meters in the dbus-mqtt-grid/config.ini as in dbus-enphase-envoy/config.ini. Don't forget to enable MQTT in the dbus-enphase-envoy/config.ini.
Shoudn't you already have a MQTT broker, than you can enable the Venus OS integrated MQTT broker under Venus OS GUI -> Menu -> Services -> MQTT on LAN (SSL) and if desired MQTT on LAN (Plaintext). In the config.ini insert the IP address of the Venus OS device or 127.0.0.1.
The driver only works, if there is at least the production CT (Current Transformer) installed. Best would be, if you have a consumption and production CT installed. In nearly all cases it's possible to retrofit them. You can purchase the needed CT's as a pair in the Enphase Store or wherever you like. Ask your installer, if you don't know how to retrofit it by yourself.
Copy or rename the config.sample.ini to config.ini in the dbus-enphase-envoy folder and change it as you need it.
PV, Grid, Consumption
{
"pv": {
"L1": {
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"power_factor": 0.00,
"frequency": 0,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"L2": {
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"power_factor": 0.00,
"frequency": 0,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"L3": {
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"power_factor": 0.00,
"frequency": 0,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"grid": {
"L1": {
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"power_factor": 0.00,
"frequency": 0,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"L2": {
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"power_factor": 0.00,
"frequency": 0,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"L3": {
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"power_factor": 0.00,
"frequency": 0,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"consumption": {
"L1": {
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"power_factor": 0.00,
"frequency": 0,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"L2": {
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"power_factor": 0.00,
"frequency": 0,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"L3": {
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"power_factor": 0.00,
"frequency": 0,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
},
"power": 0.000,
"current": 0.000,
"voltage": 0.000,
"power_react": 0.00,
"power_appearent": 0.000,
"whToday": 0.000,
"vahToday": 0.000,
"whLifetime": 0.000,
"vahLifetime": 0.000
}
}Devices
{
"inverters": {
"122000000001": {
"status": [
"envoy.global.ok"
],
"producing": true,
"communicating": true,
"provisioned": true,
"operating": true
},
"122000000002": {
"status": [
"envoy.global.ok"
],
"producing": true,
"communicating": true,
"provisioned": true,
"operating": true
},
"122000000003": {
"status": [
"envoy.global.ok"
],
"producing": true,
"communicating": true,
"provisioned": true,
"operating": true
}
},
"batteries": {},
"relais": {
"122100000001": {
"status": [
"envoy.global.ok"
],
"producing": false,
"communicating": true,
"provisioned": true,
"operating": true,
"relay": "closed",
"reason": "ok"
}
}
}Inverters
{
"122000000001": {
"lastReportDate": 1667471311,
"lastReportWatts": 50
},
"122000000002": {
"lastReportDate": 1667471311,
"lastReportWatts": 60
},
"122000000003": {
"lastReportDate": 1667471311,
"lastReportWatts": 70
}
}Events
{
"3015": {
"message": "Microinverter failed to report: Set",
"serialNumber": "122000000001",
"type": "pcu ",
"datetime": "Wed Nov 02, 2022 04:53 PM CET"
},
"3016": {
"message": "Microinverter failed to report: Clear",
"serialNumber": "122000000002",
"type": "pcu ",
"datetime": "Wed Nov 02, 2022 04:54 PM CET"
},
"3017": {
"message": "Microinverter failed to report: Set",
"serialNumber": "122000000002",
"type": "pcu ",
"datetime": "Wed Nov 02, 2022 04:54 PM CET"
},
"3018": {
"message": "Microinverter failed to report: Clear",
"serialNumber": "122000000002",
"type": "pcu ",
"datetime": "Thu Nov 03, 2022 07:12 AM CET"
},
"3019": {
"message": "Microinverter failed to report: Clear",
"serialNumber": "122000000001",
"type": "pcu ",
"datetime": "Thu Nov 03, 2022 07:12 AM CET"
},
"3020": {
"message": "Power On Reset",
"serialNumber": "122000000002",
"type": "pcu ",
"datetime": "Thu Nov 03, 2022 07:12 AM CET"
},
"3021": {
"message": "DC Voltage Too Low: Clear",
"serialNumber": "122000000001",
"type": "pcu channel 1",
"datetime": "Thu Nov 03, 2022 07:42 AM CET"
},
"3022": {
"message": "Power On Reset",
"serialNumber": "122000000001",
"type": "pcu ",
"datetime": "Thu Nov 03, 2022 07:12 AM CET"
},
"3023": {
"message": "DC Power Too Low: Clear",
"serialNumber": "122000000002",
"type": "pcu ",
"datetime": "Thu Nov 03, 2022 08:01 AM CET"
},
"3024": {
"message": "DC Power Too Low: Clear",
"serialNumber": "122000000001",
"type": "pcu ",
"datetime": "Thu Nov 03, 2022 08:00 AM CET"
}
}-
Login to your Venus OS device via SSH. See Venus OS:Root Access for more details.
-
Execute this commands to download and extract the files:
# change to temp folder cd /tmp # download driver wget -O /tmp/venus-os_dbus-enphase-envoy.zip https://github.com/mr-manuel/venus-os_dbus-enphase-envoy/archive/refs/heads/master.zip # If updating: cleanup old folder rm -rf /tmp/venus-os_dbus-enphase-envoy-master # unzip folder unzip venus-os_dbus-enphase-envoy.zip # If updating: backup existing config file mv /data/etc/dbus-enphase-envoy/config.ini /data/etc/dbus-enphase-envoy_config.ini # If updating: cleanup existing driver rm -rf /data/etc/dbus-enphase-envoy # copy files cp -R /tmp/venus-os_dbus-enphase-envoy-master/dbus-enphase-envoy/ /data/etc/ # If updating: restore existing config file mv /data/etc/dbus-enphase-envoy_config.ini /data/etc/dbus-enphase-envoy/config.ini
-
Copy the sample config file, if you are installing the driver for the first time and edit it to your needs.
# copy default config file cp /data/etc/dbus-enphase-envoy/config.sample.ini /data/etc/dbus-enphase-envoy/config.ini # edit the config file with nano nano /data/etc/dbus-enphase-envoy/config.ini
-
Run
bash /data/etc/dbus-enphase-envoy/install.shto install the driver as service.The daemon-tools should start this service automatically within seconds.
Run /data/etc/dbus-enphase-envoy/uninstall.sh
Run /data/etc/dbus-enphase-envoy/restart.sh
The logs can be checked with tail -n 100 -f /data/log/dbus-enphase-envoy/current | tai64nlocal
The service status can be checked with svstat svstat /service/dbus-enphase-envoy
This will output somethink like /service/dbus-enphase-envoy: up (pid 5845) 185 seconds
If the seconds are under 5 then the service crashes and gets restarted all the time. If you do not see anything in the logs you can increase the log level in /data/etc/dbus-enphase-envoy/dbus-enphase-envoy.py by changing level=logging.WARNING to level=logging.INFO or level=logging.DEBUG
If the script stops with the message dbus.exceptions.NameExistsException: Bus name already exists: com.victronenergy.pvinverter.enphase_envoy" it means that the service is still running or another service is using that bus name.
It was tested on Venus OS Large v2.92 on the following devices:
- RaspberryPi 4b
- MultiPlus II (GX Version)
Power L1
Power L1 and L2
Power L1, L2 and L3
