Tests: 
connects to products of Ecoflow ([https://www.ecoflow.com])
This adapter uses a non-offical communication with the devices. Wrong communication or setting wrong values can affect the functionality of the device and may lead to exclusion from the service.
The adapter is based on the work of:
- my own evaluation and research
- https://github.com/tolwi/hassio-ecoflow-cloud
- https://haus-automatisierung.com/hardware/2023/02/13/ecoflow-river-2-usv-batteriespeicher.html
- https://forum.iobroker.net/topic/66743/ecoflow-connector-script-zur-dynamischen-leistungsanpassung
- https://konkludenz.de/en/making-ecoflow-wave2-smart-home-capable-with-node-red-and-mqtt
In Admin Page (first tab) the mqqt credentials for the mqqt Broker need to be inserted.
- UserName - something like "app-...."
- UserID - a 19 digit number
- UserPassword - an alphanumeric
- ClientID - a string starting with "ANDROID_...."
There are 3 possibilities:
- by script https://github.com/mmiller7/ecoflow-withoutflow/blob/main/cloud-mqtt/ecoflow_get_mqtt_login.sh
- by website https://energychain.github.io/site_ecoflow_mqtt_credentials/
- by adapters own alogorithm (pressing the button), for this the ecoflow username and password is necessary.
The mqqt Broker settings are default and usually need no modification.
!!! In cases where the mqtt-server refuses the connection it might be helpfull to check with option #2 the output of that website, in some cases it will return a different mqtt-broker address !!!
Use the tab "Device(s) Configuration" for adding your equipment.
Parametrizing the Powerstream or STREAM
- add a new row
- set the deviceID of (Power)Stream as shown in the app, something like "HW51..../BK...."
- give it a name
- select the version
Parametrizing the Powerstation
- add a new row
- set the deviceID of Powerstation as shown in the app, string varies by type of device
- give it a name
- select the device type
- if additional battery pack is connected, check the port number where it is connected
Parametrizing the Smart Plug
- add a new row
- set the deviceID of Smart Plug as shown in the app, something like "HW52...."
- give it a name
- set the type to "plug"
Parametrizing the Smartmeter
- add a new row
- set the deviceID of Smartmeter (Shelly or EF) as shown in the app, if Shelly please be aware that the ID is different to the Shelly device itself
- give it a name
- set the type to "Shelly3EM" or "EF smartmeter"
Parametrizing the Generator
- add a new row
- set the deviceID of Generator as shown in the app, something like "DGEB...."
- give it a name
- set the type to "Generator"
Parametrizing the Smart Home Panel
- add a new row
- set the deviceID of Generator as shown in the app, something like "SP10...."
- give it a name
- set the type to "SHP" or "SHP2"
Parametrizing the Power Kit & Hub
- add a new row
- set the deviceID of power kit as shown in the app, something like "M10...."
- give it a name
- set the type to "Power Kit BP2000" or "Power Kit BP5000"
- if there is a second or third battery connected, then check it as slave1 or slave2
Parametrizing the Power Ocean DC fit
- add a new row
- set the deviceID of Generator as shown in the app, something like "HJ31...."
- give it a name
- set the type to "Power Ocean"
- if there is a second or third battery connected, then check it as slave1 or slave2
Parametrizing the Wave
- add a new row
- set the deviceID of Smart Plug as shown in the app, something like "KT21ZCH..."
- give it a name
- set the type to "Wave2"
Parametrizing the Glacier
- add a new row
- set the deviceID of Smart Plug as shown in the app, something like "BX11ZCB..."
- give it a name
- set the type to "Glacier"
Parametrizing the Alternator
- add a new row
- set the deviceID of Smart Plug as shown in the app, something like "F371ZE..."
- give it a name
- set the type to "Alternator 800W"
Use the tab "Homeassistant" for setup of MQTT connection to HA
Parametrizing Homeassistant Connector
- enable the service
- set the user settings of the MQTT Broker of HA
- set the connection parameter of the MQTT Broker of HA
- select debug settings if required
Modification at HA side:
- The adapter uses the discovery function in HA, no configuration of datapoints in HA is needed.
- MQTT add-on ...
Usually it is enough to install the next version on top of the old one. In some cases (e.g. 1.0.0) it might be needed to erase the whole object tree. If datapoint related values are changed, like min or max of the range, the you have to:
- stop the adapter
- deleted the concerned datapoints
- start the adapter After this the new ranges are taken over.
- the defined devices are connected to the adapter via mqtt
- the adapter filters the incomming messages of the devices. only changed values are stored internally
- if the App prevents adjusting at a certain condition, when known it is replicated (e.g. inverter ON when below minimum battery charge is prevented, you can see a warning in the log )
- not everything is known, so information to status interpretation may be uncertain, this is mostly marked with trailing "?"
If settings to a data point are changed in the new version of adapter (e.g. name, unit, max value) the change is not effective until you:
- stop the adapter instance
- delete the respective datapoint or the whole object structure of the adapter instance
- start the adapter instance
During startup the datapoints are created, but not changed when existing.
Some occurances in the adapter are tagged as warning or error in order to appear in the log when the loglevel is in info mode. This is not necessarily a failure or an indicator for not working adapter, it is more a sign for a not expected behaviour. The cause might not be in the adapter itself, but the attention is set.
- the MQTT discovery function in HA enables an elegant way of information exchange
- the MQTT discovery function may not be activated when MQTT broker is already running in HA, it needs to be enabled during reconfiguration of MQTT service
- at each start of iobroker adapter all discovery objects are transmitted to HA (even they should retain in HA)
- iobroker adapter filters the incomming messages of the devices. only changed values are stored internally and transferred to HA.
- if a value is not set by device data update, it will appear as unknown in HA
- if the device is reachable, then the availability will be shown in the device connectivity, this is inherited to the "sub-devices" (unavailability is precessed in the same way)
- Due to to the asynchronity of information updates and command transfer sometimes race conditions may be visible. So a switch is commanded and its toggling back and forth before it stays, can be observed.
some explanation to the device data
- number -> data point with numeric value
- level -> adjustable data point with numeric value, sometimes also selections which have numeric representation
- switch -> adjustable data point boolean
- diagnostic -> boolean or multi state data point transferred to text
- string -> datapoint as text only
- array -> datapoint with array
- value to text conversion might use a non-validated text (feedback is welcome), this is indicated be "?" at the end of text
Dual Fuel generator is not available, could be implemented, if data is available.
The 800W version is also implemented and only difference is the 800W maximum power. supply priority -> 0/false = prioritized grid supply; -> 1/true = prioritized battery supply (charging)
Wave is not available, could be implemented, if data is available.
for debugging purpose this section is created, please select the device (delta pro3, delta3, delta3 plus) und put the serial in the added line it is anticipated that the unknown device is using protobuf it creates [PROTOBUF unknown] messages in th log, they contain the raw hex telegram
- check forgotten boundary conditions for commands (inhibit cmd, or additional value)
- check beep command if reversing needed
- SlaveBattery DM, outWatts multiplication by 10
- more getCmds for SHP values
- (foxthefox) new datapoints Delta2max
- (foxthefox) new device Glacier Classic 55L support
- (foxthefox) new device Delta 3 Max Plus support
- (foxthefox) new device Stream AC support
- (foxthefox) new device Rapid Pro 320W support
- (foxthefox) enhancements on wave3
- (foxthefox) corrections in river3plus for data processing
- (foxthefox) corrections in D2M for command inv.cfgAcEnabled #340
- (foxthefox) poweroceanplus set hrPwr/fromPv/romBat/fromGrid values to 0 for non transmitted datapoints in HeatingRodEnergyStreamShow
- (foxthefox) poweroceanplus pcsActPwr max 20kW, pcsXPhase_amp max 60A
- (foxthefox) corrections in BMSHeartBeatReport for river3/river3plus
- (foxthefox) powGetSysLoad for streamAC/ACPro/Ultra set to 10kW, powGetSchuko 2100W
- (foxthefox) new msg counter for received telegrams from EF-cloud (within 10s)
- (foxthefox) correction of enBeep (dataLen=2) for Delta3/+/max+/pro
- (foxthefox) correction of AC1/2/3 switching on SHP2 (issue #312)
- (foxthefox) Stream AC timetask58x exclude
- (foxthefox) correction of powerocean / powerocean+ (issue #378), new ENERGY_STREAM_DETAIL and switch for missing datapoint -> value = 0
- (foxthefox) dev dependencies cleanup
MIT License
Copyright (c) 2023-2026 foxthefox foxthefox@wysiwis.net
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This open-source software is not affiliated with or endorsed by the company Ecoflow in any way. Use of the software is at your own risk and discretion, and I assume no liability for any potential damages or issues that may arise from using the software. It is important to be aware that using this open-source software comes without direct support or guarantees from the company Ecoflow.