Feature/reverse power relay

io.openems.edge.controller.pvinverter.reversepowerrelay/.gitignore

@@ -0,0 +1,2 @@
+/bin_test/
+/generated/

io.openems.edge.controller.pvinverter.reversepowerrelay/bnd.bnd

@@ -0,0 +1,17 @@
+Bundle-Name: OpenEMS Edge Controller io.openems.edge.controller.pvinverter.reversepowerrelay
+Bundle-Vendor: OpenEMS Association e.V.
+Bundle-License: https://opensource.org/licenses/EPL-2.0
+Bundle-Version: 1.0.0.${tstamp}
+
+-buildpath: \
+ ${buildpath},\
+ io.openems.common,\
+ io.openems.edge.common,\
+ io.openems.edge.controller.api,\
+ io.openems.edge.meter.api,\
+ io.openems.edge.pvinverter.api
+
+-testpath: \
+ ${testpath},\
+ org.mockito.mockito-core,\
+ io.openems.edge.io.api

io.openems.edge.controller.pvinverter.reversepowerrelay/readme.adoc

@@ -0,0 +1,18 @@
+= io.openems.edge.controller.pvinverter.reversepowerrelay
+
+Limits pv production according to current state of reverse power relay (short: rpr, german: "Rundsteuerempfaenger").
+Usually rpr as four defined states which are defined by it�s relays:
+- K1 -> 0% limit pv production to 0
+- K2 -> 30% limit pv production to 30%
+- K3 -> 60% limit pv production to 60%
+- K4 -> 100% no limitation
+
+You have to define a network input which has rpr output as input, e.g. a Siemens Logo!
+
+Be careful: if there is an undefined state (e.g. two relays active at the same time or no relay active at all) then pv production is limited to 0%!
+Usually only K4 should be active and your pv is not limited
+
+Tested with Siemens LOGO!8 and managed symmetric pv inverter.
+Remember to configure a high priority for this controller.
+
+https://github.com/OpenEMS/openems/tree/develop/io.openems.edge.controller.pvinverter.reversepowerrelay[Source Code icon:github[]]

io.openems.edge.controller.pvinverter.reversepowerrelay/src/io/openems/edge/controller/pvinverter/reversepowerrelay/Config.java

@@ -0,0 +1,42 @@
+package io.openems.edge.controller.pvinverter.reversepowerrelay;
+
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
+
+@ObjectClassDefinition(//
+ name = "Controller PV-Inverter Reverse Power Relay (Rundsteuerempf�nger)", //
+ description = "Defines a reverse power relay to limit PV inverter.")
+@interface Config {
+
+ @AttributeDefinition(name = "Component-ID", description = "Unique ID of this Component")
+ String id() default "ctrlPvInverterReversePowerRelay0";
+
+ @AttributeDefinition(name = "Alias", description = "Human-readable name of this Component; defaults to Component-ID")
+ String alias() default "";
+
+ @AttributeDefinition(name = "Is enabled?", description = "Is this Component enabled?")
+ boolean enabled() default true;
+
+ @AttributeDefinition(name = "PV-Inverter-ID", description = "ID of PV-Inverter device.")
+ String pvInverter_id();
+
+ @AttributeDefinition(name = "Input Channel 0%", description = "Address of the input channel. If this channel is active the inverter is limited to 0%. i.e. 'myRelay/Input1")
+ String inputChannelAddress0Percent();
+
+ @AttributeDefinition(name = "Input Channel 30%", description = "Address of the input channel. If this channel is active the inverter is limited to 30%. i.e. 'myRelay/Input2")
+ String inputChannelAddress30Percent();
+
+ @AttributeDefinition(name = "Input Channel 60%", description = "Address of the input channel. If this channel is active the inverter is limited to 60%. i.e. 'myRelay/Input3")
+ String inputChannelAddress60Percent();
+
+ @AttributeDefinition(name = "Input Channel 100%", description = "Address of the input channel. If this channel is active the inverter is limited to 100%. i.e. 'myRelay/Input4")
+ String inputChannelAddress100Percent();
+
+ @AttributeDefinition(name = "Power Limit 30% step [W]", description = "")
+ int powerLimit30();
+
+ @AttributeDefinition(name = "Power Limit 60% step [W]", description = "")
+ int powerLimit60();
+
+ String webconsole_configurationFactory_nameHint() default "Controller PV-Inverter Reverse Power Relay Limitation [{id}]";
+}

io.openems.edge.controller.pvinverter.reversepowerrelay/src/io/openems/edge/controller/pvinverter/reversepowerrelay/ReversePowerRelay.java

@@ -0,0 +1,24 @@
+package io.openems.edge.controller.pvinverter.reversepowerrelay;
+
+import io.openems.edge.common.channel.Doc;
+import io.openems.edge.common.component.OpenemsComponent;
+import io.openems.edge.controller.api.Controller;
+
+public interface ReversePowerRelay extends Controller, OpenemsComponent {
+
+ public enum ChannelId implements io.openems.edge.common.channel.ChannelId {
+ ;
+
+ private final Doc doc;
+
+ private ChannelId(Doc doc) {
+ this.doc = doc;
+ }
+
+ @Override
+ public Doc doc() {
+ return this.doc;
+ }
+ }
+
+}

io.openems.edge.controller.pvinverter.reversepowerrelay/src/io/openems/edge/controller/pvinverter/reversepowerrelay/ReversePowerRelayImpl.java

@@ -0,0 +1,169 @@
+package io.openems.edge.controller.pvinverter.reversepowerrelay;
+
+import org.osgi.service.component.ComponentContext;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.ConfigurationPolicy;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.metatype.annotations.Designate;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.openems.common.exceptions.OpenemsError.OpenemsNamedException;
+import io.openems.common.types.ChannelAddress;
+import io.openems.edge.common.component.AbstractOpenemsComponent;
+import io.openems.edge.common.component.ComponentManager;
+import io.openems.edge.common.component.OpenemsComponent;
+import io.openems.edge.controller.api.Controller;
+import io.openems.edge.pvinverter.api.ManagedSymmetricPvInverter;
+import io.openems.edge.common.channel.BooleanReadChannel;
+
+@Designate(ocd = Config.class, factory = true)
+@Component(//
+ name = "Controller.PvInverter.ReversePowerRelay", //
+ immediate = true, //
+ configurationPolicy = ConfigurationPolicy.REQUIRE //
+)
+public class ReversePowerRelayImpl extends AbstractOpenemsComponent
+ implements ReversePowerRelay, Controller, OpenemsComponent {
+
+ private final Logger log = LoggerFactory.getLogger(ReversePowerRelayImpl.class);
+
+ @Reference
+ private ComponentManager componentManager;
+
+ private String pvInverterId;
+
+ private int powerLimit30Percent = 0;
+ private int powerLimit60Percent = 0;
+
+ private ChannelAddress inputChannelAddress0Percent = null;
+ private ChannelAddress inputChannelAddress30Percent = null;
+ private ChannelAddress inputChannelAddress60Percent = null;
+ private ChannelAddress inputChannelAddress100Percent = null;
+
+ private ManagedSymmetricPvInverter pvInverter;
+
+ public ReversePowerRelayImpl() {
+ super(//
+ OpenemsComponent.ChannelId.values(), //
+ Controller.ChannelId.values(), //
+ ReversePowerRelay.ChannelId.values() //
+ );
+ }
+
+ @Activate
+ private void activate(ComponentContext context, Config config) {
+ super.activate(context, config.id(), config.alias(), config.enabled());
+ this.pvInverterId = config.pvInverter_id();
+
+ this.powerLimit30Percent = config.powerLimit30();
+ this.powerLimit60Percent = config.powerLimit60();
+
+ try {
+ this.inputChannelAddress0Percent = ChannelAddress.fromString(config.inputChannelAddress0Percent());
+ this.inputChannelAddress30Percent = ChannelAddress.fromString(config.inputChannelAddress30Percent());
+
+ this.inputChannelAddress60Percent = ChannelAddress.fromString(config.inputChannelAddress60Percent());
+ this.inputChannelAddress100Percent = ChannelAddress.fromString(config.inputChannelAddress100Percent());
+
+ } catch (OpenemsNamedException e) {
+ this.log.error("Error parsing channel addresses", e);
+ }
+ }
+
+ @Deactivate
+ protected void deactivate() {
+ // Reset limit
+ ManagedSymmetricPvInverter pvInverter;
+ try {
+ pvInverter = this.componentManager.getComponent(this.pvInverterId);
+ pvInverter.setActivePowerLimit(null);
+ } catch (OpenemsNamedException e) {
+ this.logError(this.log, e.getMessage());
+ }
+ super.deactivate();
+ }
+
+ private void setPvLimit(Integer powerLimit) {
+
+ try {
+ this.pvInverter = this.componentManager.getComponent(this.pvInverterId);
+ if (this.pvInverter != null) {
+ this.pvInverter.setActivePowerLimit(powerLimit);
+ if (powerLimit != null) {
+ this.log.warn("Setting PV limit: " + powerLimit + "W for " + this.pvInverterId);
+ } else {
+ this.log.info("No limit for " + this.pvInverterId);
+ }
+
+ }
+ } catch (OpenemsNamedException e) {
+ this.log.error("Error setting PV limit", e);
+ }
+
+ }
+
+ private Boolean getChannelValue(ChannelAddress address) throws OpenemsNamedException {
+ if (address == null) {
+ return null;
+ }
+ try {
+ BooleanReadChannel channel = this.componentManager.getChannel(address);
+ return channel.value().orElse(null);
+ } catch (OpenemsNamedException e) {
+ this.log.error("Error reading channel value", e);
+ return null;
+ }
+ }
+
+ @Override
+ public void run() throws OpenemsNamedException {
+
+ try {
+ Boolean value0Percent = this.getChannelValue(this.inputChannelAddress0Percent);
+ Boolean value30Percent = this.getChannelValue(this.inputChannelAddress30Percent);
+ Boolean value60Percent = this.getChannelValue(this.inputChannelAddress60Percent);
+ Boolean value100Percent = this.getChannelValue(this.inputChannelAddress100Percent);
+
+ if (value0Percent == null || value30Percent == null || value60Percent == null || value100Percent == null) {
+ this.log.warn("Skipping logic in run() due to null channel values");
+ this.setPvLimit(0); 
+ return;
+ }
+ //
+ if (value0Percent == true) {
+ this.setPvLimit(0);
+ } else if (value0Percent == false && value30Percent == true && value60Percent == false
+ && value100Percent == false) {
+ this.setPvLimit(this.powerLimit30Percent);
+ } else if (value0Percent == false && value30Percent == false && value60Percent == true
+ && value100Percent == false) {
+ this.setPvLimit(this.powerLimit60Percent);
+ } else if (value0Percent == false && value30Percent == false && value60Percent == false
+ && value100Percent == true) {
+ this.setPvLimit(null);
+ } else {
+ this.setPvLimit(0);
+ }
+
+ } catch (OpenemsNamedException e) {
+ this.log.error("No values from modbus channels yet", e);
+ return;
+ }
+
+ }
+
+ public String getPvInverterId() {
+ return this.pvInverterId;
+ }
+
+ public int getPowerLimit30Percent() {
+ return this.powerLimit30Percent;
+ }
+
+ public int getPowerLimit60Percent() {
+ return this.powerLimit60Percent;
+ }
+}