FEMS Backport 2023-09-25 (OpenEMS#2368)

* SolarLog: fix setting/calculation of active production energy

Added missing event subscription for "TOPIC_CYCLE_AFTER_PROCESS_IMAGE" to calculate ActiveProductionEnergy & removed reading this value via modbus

* App Center: Refactor App.Api.ModbusTcp

* ElementToChannelConverter:  Add SET_NULL_FOR_DEFAULT

* GoodWe BatteryInverter: validate compatible FENECON Home Battery

- Check relation between goodwe inverter and fenecon home battery
- Calculate Number of Modules for GoodWe depending on the battery values

* AppCenter: Home 20 & 30

Implementation of Apps for Home 20 & 30

* GoodWe BatteryInverter: improve Warning/Error State descriptions

- Fixes mapping of Registers and bits.
- New format of the description:
[Fault English | Fault German | Suggested solution German]

* KACO: fit ActivePower set point percentage -100 to 100

The filter is from -100 to +100 factor.

* FENECON Home: fix switching Battery Start Up Relay ON

This fixes a bug, that keeps a Home Battery from getting started via the Battery Start Up Relay. The `ModbusCommunicationFailed` State has level FAULT. Because of this `battery.hasFaults()` is never true when the battery is turned off, so the State-Machine immediately goes to ERROR state and never enters GO_RUNNING when the `ModbusCommunicationFailed` State is set. It still works in many cases after a full cold-start (e.g. by restarting OpenEMS service), though, because then `ModbusCommunicationFailed` State is not set _yet_.

This fix handles `ModbusCommunicationFailed` State separately in UNDEFINED state and waits for modbus communication in GO_RUNNING. In case of an overall timeout - i.e. the battery cannot be started - `MaxStartAttemptsFailed` is still triggered.

In the process of refactoring the GO_RUNNING handler, I implemented a full Sub-State-Machine including nice debug log messages and a Mermaid chart.

I also touched the OpenEMS testing framework to force set a Channel (to cirumvent channel debounce settings)

* Modbus Bridge: hide error logs on first try (on configured low LogVerbosity)

This avoids unnecessary logs and resemble the logging behavour of the previous Modbus bridge

* UI: Fix notch color for all OEM's

Replace notch color with OEM's background-color

* App Center: return created dependencies

Necessarry for selecting AC-Meter in Home IBN and update it.

* Meter SDM630: calculate active production/consumption energy manually

* Battery: standardize debugLog

* UI: Splitting index into login and overview

* Solves Community Issue [OpenEMS](https://community.openems.io/t/setup-ide-for-openems-ui-not-working/1923/5?u=stefan.feilmeier)
* Due to lifecycle issues and routing issues after login, the `login` and the `edges-overview` get split into two components.
  * If only one `edge` assigned to the user -> the user logs in, the overview wont be shown, but because this is happening in the same component, routing forward creates a problem in `live`. The currentData is subscribed but not shown. Only on reload it worked again.
* This also fits the purpose of reducing unnecessary requests.

---------

Co-authored-by: Michael Grill <[email protected]>
Co-authored-by: Hueseyin Sahutoglu <[email protected]>
Co-authored-by: Sebastian Asen <[email protected]>
Co-authored-by: Pooran Chandrashekaraiah <[email protected]>
Co-authored-by: Anas Shetla <[email protected]>
Co-authored-by: Mohammadmahdi Ataei <[email protected]>

Author: 7 people

cnf/pom.xml

@@ -315,12 +315,6 @@
 			<artifactId>jsoup</artifactId>
 			<version>1.16.1</version>
 		</dependency>
-		<dependency>
-			<!-- Used by Apache Felix Web Management Console -->
-			<groupId>org.owasp.encoder</groupId>
-			<artifactId>encoder</artifactId>
-			<version>1.2.3</version>
-		</dependency>
 		<dependency>
 			<groupId>org.osgi</groupId>
 			<artifactId>osgi.annotation</artifactId>
@@ -396,6 +390,12 @@
 			<artifactId>org.osgi.util.promise</artifactId>
 			<version>1.3.0</version>
 		</dependency>
+		<dependency>
+			<!-- Used by Apache Felix Web Management Console -->
+			<groupId>org.owasp.encoder</groupId>
+			<artifactId>encoder</artifactId>
+			<version>1.2.3</version>
+		</dependency>
 		<dependency>
 			<!-- Used by io.openems.backend.metadata.odoo -->
 			<groupId>org.postgresql</groupId>

io.openems.backend.uiwebsocket/src/io/openems/backend/uiwebsocket/impl/OnRequest.java

@@ -42,7 +42,6 @@
 import io.openems.common.jsonrpc.response.EdgeRpcResponse;
 import io.openems.common.jsonrpc.response.GetEdgeResponse;
 import io.openems.common.jsonrpc.response.GetEdgesResponse;
-import io.openems.common.jsonrpc.response.GetEdgesResponse.EdgeMetadata;
 import io.openems.common.session.Role;
 import io.openems.common.utils.JsonUtils;
 

io.openems.common/src/io/openems/common/function/BooleanConsumer.java

@@ -0,0 +1,19 @@
+package io.openems.common.function;
+
+import java.util.function.Consumer;
+
+/**
+ * This interface is similar to the java.util interface {@link Consumer}.
+ * Difference is, that it limits the type to a primitive, non-nullable boolean.
+ */
+@FunctionalInterface
+public interface BooleanConsumer {
+
+	/**
+	 * Performs this operation on the given argument.
+	 *
+	 * @param value the input argument
+	 */
+	public void accept(boolean value);
+
+}

io.openems.edge.battery.api/src/io/openems/edge/battery/api/Battery.java

@@ -13,6 +13,7 @@
 import io.openems.edge.common.modbusslave.ModbusSlaveNatureTable;
 import io.openems.edge.common.modbusslave.ModbusType;
 import io.openems.edge.common.startstop.StartStoppable;
+import io.openems.edge.common.statemachine.AbstractStateMachine;
 
 /**
  * Represents a Battery.
@@ -734,4 +735,26 @@ public default void _setMaxCellVoltage(Integer value) {
 	public default void _setMaxCellVoltage(int value) {
 		this.getMaxCellVoltageChannel().setNextValue(value);
 	}
+
+	/**
+	 * Generates a default DebugLog message for {@link Battery} implementations with
+	 * a State-Machine.
+	 * 
+	 * @param battery      the {@link Battery}
+	 * @param stateMachine the actual StateMachine (extends
+	 *                     {@link AbstractStateMachine})
+	 * @return a debug log String
+	 */
+	public static String generateDebugLog(Battery battery, AbstractStateMachine<?, ?> stateMachine) {
+		return new StringBuilder() //
+				.append(stateMachine.debugLog()) //
+				.append("|SoC:").append(battery.getSoc()) //
+				.append("|Actual:").append(battery.getVoltage()) //
+				.append(";").append(battery.getCurrent()) //
+				.append("|Charge:").append(battery.getChargeMaxVoltage()) //
+				.append(";").append(battery.getChargeMaxCurrent()) //
+				.append("|Discharge:").append(battery.getDischargeMinVoltage()) //
+				.append(";").append(battery.getDischargeMaxCurrent()) //
+				.toString();
+	}
 }

io.openems.edge.battery.bydcommercial/src/io/openems/edge/battery/bydcommercial/BydBatteryBoxCommercialC130Impl.java

@@ -172,16 +172,7 @@ private void handleStateMachine() {
 
 	@Override
 	public String debugLog() {
-		return new StringBuilder() //
-				.append(this.stateMachine.debugLog()) //
-				.append("|SoC:").append(this.getSoc()) //
-				.append("|Actual:").append(this.getVoltage()) //
-				.append(";").append(this.getCurrent()) //
-				.append("|Charge:").append(this.getChargeMaxVoltage()) //
-				.append(";").append(this.getChargeMaxCurrent()) //
-				.append("|Discharge:").append(this.getDischargeMinVoltage()) //
-				.append(";").append(this.getDischargeMaxCurrent()) //
-				.toString();
+		return Battery.generateDebugLog(this, this.stateMachine);
 	}
 
 	@Override

io.openems.edge.battery.fenecon.commercial/src/io/openems/edge/battery/fenecon/commercial/BatteryFeneconCommercialImpl.java

@@ -1202,16 +1202,7 @@ protected synchronized void updateSoc() {
 
 	@Override
 	public String debugLog() {
-		return new StringBuilder() //
-				.append(this.stateMachine.debugLog()) //
-				.append("|SoC:").append(this.getSoc()) //
-				.append("|Actual:").append(this.getVoltage()) //
-				.append(";").append(this.getCurrent()) //
-				.append("|Charge:").append(this.getChargeMaxVoltage()) //
-				.append(";").append(this.getChargeMaxCurrent()) //
-				.append("|Discharge:").append(this.getDischargeMinVoltage()) //
-				.append(";").append(this.getDischargeMaxCurrent()) //
-				.toString();
+		return Battery.generateDebugLog(this, this.stateMachine);
 	}
 
 	@Override

io.openems.edge.battery.fenecon.home/doc/statemachine.md

@@ -0,0 +1,24 @@
+# State-Machine for GO_RUNNING
+
+```mermaid
+graph TD
+UNDEFINED -->|bmsControl==UNDEFINED| INITIAL_WAIT_FOR_BMS_CONTROL
+UNDEFINED -->|bmsControl==false| START_UP_RELAY_ON
+UNDEFINED -->|bmsControl==true| START_UP_RELAY_OFF
+
+INITIAL_WAIT_FOR_BMS_CONTROL -->|bmsControl==false or timeout| START_UP_RELAY_ON
+INITIAL_WAIT_FOR_BMS_CONTROL -->|bmsControl==true| START_UP_RELAY_OFF
+
+START_UP_RELAY_ON -->|startUpRelay==true| START_UP_RELAY_HOLD
+START_UP_RELAY_ON -->|timeout| RETRY_MODBUS_COMMUNICATION
+
+START_UP_RELAY_HOLD -->|wait 10s| START_UP_RELAY_OFF
+START_UP_RELAY_OFF -->|startUpRelay!=true| RETRY_MODBUS_COMMUNICATION
+
+RETRY_MODBUS_COMMUNICATION --> WAIT_FOR_BMS_CONTROL
+
+WAIT_FOR_BMS_CONTROL -->|bmsControl==true| WAIT_FOR_MODBUS_COMMUNICATION
+WAIT_FOR_MODBUS_COMMUNICATION -->|modbusCommunicationFailed==false| FINISHED
+```
+
+View using Mermaid, e.g. https://mermaid-js.github.io/mermaid-live-editor

io.openems.edge.battery.fenecon.home/src/io/openems/edge/battery/fenecon/home/BatteryFeneconHome.java

@@ -11,6 +11,7 @@
 import io.openems.edge.common.channel.Channel;
 import io.openems.edge.common.channel.Doc;
 import io.openems.edge.common.channel.IntegerDoc;
+import io.openems.edge.common.channel.IntegerReadChannel;
 import io.openems.edge.common.channel.value.Value;
 import io.openems.edge.common.component.OpenemsComponent;
 import io.openems.edge.common.startstop.StartStop;
@@ -29,21 +30,17 @@ public default Channel<Boolean> getBmsControlChannel() {
 
 	/**
 	 * Gets the BmsControl, see {@link ChannelId#BMS_CONTROL}.
+	 * 
+	 * <ul>
+	 * <li>true: is started
+	 * <li>false: is not started
+	 * <li>null: undefined (e.g. Modbus Communication Failed)
+	 * </ul>
 	 *
 	 * @return the Channel {@link Value}
 	 */
-	public default Value<Boolean> getBmsControl() {
-		return this.getBmsControlChannel().value();
-	}
-
-	/**
-	 * Internal method to set the 'nextValue' on {@link ChannelId#BMS_CONTROL}
-	 * Channel.
-	 *
-	 * @param value the next value
-	 */
-	public default void _setBmsControl(Boolean value) {
-		this.getBmsControlChannel().setNextValue(value);
+	public default Boolean getBmsControl() {
+		return this.getBmsControlChannel().value().get();
 	}
 
 	/**
@@ -64,6 +61,25 @@ public default BatteryFeneconHomeHardwareType getBatteryHardwareType() {
 		return this.getBatteryHardwareTypeChannel().value().asEnum();
 	}
 
+	/**
+	 * Gets the Channel for {@link ChannelId#NUMBER_OF_MODULES_PER_TOWER}.
+	 *
+	 * @return the Channel
+	 */
+	public default IntegerReadChannel getNumberOfModulesPerTowerChannel() {
+		return this.channel(BatteryFeneconHome.ChannelId.NUMBER_OF_MODULES_PER_TOWER);
+	}
+
+	/**
+	 * Gets the number of modules per tower. See
+	 * {@link ChannelId#NUMBER_OF_MODULES_PER_TOWER}.
+	 *
+	 * @return the Channel {@link Value}
+	 */
+	public default Value<Integer> getNumberOfModulesPerTower() {
+		return this.getNumberOfModulesPerTowerChannel().value();
+	}
+
 	/**
 	 * Gets the target Start/Stop mode from config or StartStop-Channel.
 	 *
@@ -633,8 +649,14 @@ public static enum ChannelId implements io.openems.edge.common.channel.ChannelId
 		BATTERY_HARDWARE_TYPE(Doc.of(BatteryFeneconHomeHardwareType.values()) //
 				.<BatteryFeneconHomeImpl>onChannelChange(BatteryFeneconHomeImpl::updateNumberOfTowersAndModules)),
 
-		BMS_CONTROL(Doc.of(OpenemsType.BOOLEAN) //
-				.text("BMS CONTROL(1: Shutdown, 0: no action)")),
+		/**
+		 * true: started; false: not-started.
+		 * 
+		 * <p>
+		 * NOTE that Modbus Bit is inverted: 1: is-not-started; 0: is-started
+		 */
+		BMS_CONTROL(Doc.of(OpenemsType.BOOLEAN)),
+		
 		STATE_MACHINE(Doc.of(State.values()) //
 				.text("Current State of State-Machine")), //
 		RUN_FAILED(Doc.of(Level.FAULT) //

io.openems.edge.battery.fenecon.home/src/io/openems/edge/battery/fenecon/home/BatteryFeneconHomeImpl.java

@@ -1,5 +1,6 @@
 package io.openems.edge.battery.fenecon.home;
 
+import static io.openems.edge.bridge.modbus.api.AbstractOpenemsModbusComponent.BitConverter.INVERT;
 import static io.openems.edge.bridge.modbus.api.ElementToChannelConverter.SCALE_FACTOR_MINUS_1;
 
 import java.util.Objects;
@@ -59,6 +60,7 @@
 import io.openems.edge.common.component.OpenemsComponent;
 import io.openems.edge.common.event.EdgeEventConstants;
 import io.openems.edge.common.modbusslave.ModbusSlave;
+import io.openems.edge.common.modbusslave.ModbusSlaveNatureTable;
 import io.openems.edge.common.modbusslave.ModbusSlaveTable;
 import io.openems.edge.common.startstop.StartStop;
 import io.openems.edge.common.startstop.StartStoppable;
@@ -81,8 +83,9 @@ public class BatteryFeneconHomeImpl extends AbstractOpenemsModbusComponent imple
 	private static final String SERIAL_NUMBER_PREFIX_BMS = "519100001009";
 	private static final String SERIAL_NUMBER_PREFIX_MODULE = "519110001210";
 
+	protected final StateMachine stateMachine = new StateMachine(State.UNDEFINED);
+
 	private final Logger log = LoggerFactory.getLogger(BatteryFeneconHomeImpl.class);
-	private final StateMachine stateMachine = new StateMachine(State.UNDEFINED);
 	private final AtomicReference<StartStop> startStopTarget = new AtomicReference<>(StartStop.UNDEFINED);
 
 	@Reference
@@ -98,7 +101,7 @@ protected void setModbus(BridgeModbus modbus) {
 	}
 
 	private Config config;
-	private BatteryProtection batteryProtection; // set in constructor
+	private BatteryProtection batteryProtection;
 
 	public BatteryFeneconHomeImpl() {
 		super(//
@@ -161,14 +164,14 @@ private void handleStateMachine() {
 		this._setStartStop(StartStop.UNDEFINED);
 
 		// Prepare Context
-		BooleanWriteChannel batteryStartUpRelayChannel;
-		try {
-			batteryStartUpRelayChannel = this.componentManager
-					.getChannel(ChannelAddress.fromString(this.config.batteryStartUpRelay()));
-		} catch (IllegalArgumentException | OpenemsNamedException e1) {
-			batteryStartUpRelayChannel = null;
-		}
-		var context = new Context(this, batteryStartUpRelayChannel);
+		var batteryStartUpRelayChannel = this.getBatteryStartUpRelayChannel();
+		var batteryStartUpRelay = batteryStartUpRelayChannel != null ? batteryStartUpRelayChannel.value().get() : null;
+		var context = new Context(this, this.componentManager.getClock(), //
+				batteryStartUpRelay,
+				(value) -> setBatteryStartUpRelay(batteryStartUpRelayChannel, value, this::logInfo, this::logWarn), //
+				this.getBmsControl(), //
+				this.getModbusCommunicationFailed(), //
+				() -> this.retryModbusCommunication());
 
 		// Call the StateMachine
 		try {
@@ -328,7 +331,7 @@ protected ModbusProtocol defineModbusProtocol() throws OpenemsException {
 						m(BatteryFeneconHome.ChannelId.NUMBER_OF_MODULES_PER_TOWER, new UnsignedWordElement(10024))), //
 				new FC3ReadRegistersTask(44000, Priority.HIGH, //
 						m(new BitsWordElement(44000, this) //
-								.bit(0, BatteryFeneconHome.ChannelId.BMS_CONTROL)) //
+								.bit(0, BatteryFeneconHome.ChannelId.BMS_CONTROL, INVERT)) //
 				));
 	}
 
@@ -418,24 +421,16 @@ private ChannelIdImpl generateTowerChannel(int tower, String channelIdSuffix, Le
 
 	@Override
 	public String debugLog() {
-		return new StringBuilder() //
-				.append(this.stateMachine.debugLog()) //
-				.append("|SoC:").append(this.getSoc()) //
-				.append("|Actual:").append(this.getVoltage()) //
-				.append(";").append(this.getCurrent()) //
-				.append("|Charge:").append(this.getChargeMaxVoltage()) //
-				.append(";").append(this.getChargeMaxCurrent()) //
-				.append("|Discharge:").append(this.getDischargeMinVoltage()) //
-				.append(";").append(this.getDischargeMaxCurrent()) //
-				.toString();
+		return Battery.generateDebugLog(this, this.stateMachine);
 	}
 
 	@Override
 	public ModbusSlaveTable getModbusSlaveTable(AccessMode accessMode) {
 		return new ModbusSlaveTable(//
 				OpenemsComponent.getModbusSlaveNatureTable(accessMode), //
-				Battery.getModbusSlaveNatureTable(accessMode) //
-		);
+				Battery.getModbusSlaveNatureTable(accessMode), //
+				ModbusSlaveNatureTable.of(BatteryFeneconHome.class, accessMode, 100) //
+						.build());
 	}
 
 	@Override
@@ -918,6 +913,61 @@ private static int extractNumber(int value, int length, int position) {
 		return (1 << length) - 1 & value >> position - 1;
 	}
 
+	private void logInfo(String message) {
+		this.logInfo(this.log, message);
+	}
+
+	private void logWarn(String message) {
+		this.logWarn(this.log, message);
+	}
+
+	/**
+	 * Gets the Battery-Start-Up-Relay Channel.
+	 * 
+	 * @return {@link BooleanWriteChannel} or null
+	 */
+	private BooleanWriteChannel getBatteryStartUpRelayChannel() {
+		try {
+			var channel = this.componentManager
+					.<BooleanWriteChannel>getChannel(ChannelAddress.fromString(this.config.batteryStartUpRelay()));
+			return channel;
+		} catch (Exception e) {
+			this.logWarn("Unable to get Battery-Start-Up-Relay: " + e.getMessage());
+			return null;
+		}
+	}
+
+	/**
+	 * Switch Battery-Start-Up-Relay ON or OFF.
+	 *
+	 * @param batteryStartUpRelayChannel the Battery-Start-Up-Relay
+	 *                                   {@link BooleanWriteChannel}; or null
+	 * @param value                      true to switch the relay on; <br/>
+	 *                                   false to switch the relay off
+	 * @param logInfo                    Consumer for log messages
+	 * @param logWarn                    Consumer for warn messages
+	 */
+	private static void setBatteryStartUpRelay(BooleanWriteChannel batteryStartUpRelayChannel, boolean value,
+			Consumer<String> logInfo, Consumer<String> logWarn) {
+		var valueString = value ? "ON" : "OFF";
+
+		// Validate availability of batteryStartUpRelay, otherwise ignore
+		if (batteryStartUpRelayChannel == null) {
+			logWarn.accept("Switching Battery Start Up Relay " + valueString + " failed. Relay is missing");
+			return;
+		}
+
+		// Switch StartUpRelay
+		try {
+			batteryStartUpRelayChannel.setNextWriteValue(value);
+			logInfo.accept("Switching Battery Start Up Relay " + valueString //
+					+ " [" + batteryStartUpRelayChannel.address() + "]");
+		} catch (OpenemsNamedException e) {
+			logWarn.accept("Switching Battery Start Up Relay " + valueString //
+					+ " failed [" + batteryStartUpRelayChannel.address() + "]: " + e.getMessage());
+		}
+	}
+
 	/**
 	 * Generates prefix for Channel-IDs for Cell Temperature and Voltage channels.
 	 *

io.openems.edge.battery.fenecon.home/src/io/openems/edge/battery/fenecon/home/package-info.java

@@ -0,0 +1,3 @@
+@org.osgi.annotation.versioning.Version("1.0.0")
+@org.osgi.annotation.bundle.Export
+package io.openems.edge.battery.fenecon.home;