Package io.openems.edge.batteryinverter.kaco.blueplanetgridsave

Class BatteryInverterKacoBlueplanetGridsaveImpl

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.bridge.modbus.api.AbstractOpenemsModbusComponent

io.openems.edge.bridge.modbus.sunspec.AbstractOpenemsSunSpecComponent

io.openems.edge.batteryinverter.sunspec.AbstractSunSpecBatteryInverter

io.openems.edge.batteryinverter.kaco.blueplanetgridsave.BatteryInverterKacoBlueplanetGridsaveImpl

All Implemented Interfaces:

ManagedSymmetricBatteryInverter, SymmetricBatteryInverter, BatteryInverterKacoBlueplanetGridsave, ModbusComponent, OpenemsComponent, StartStoppable, TimedataProvider

public class BatteryInverterKacoBlueplanetGridsaveImpl
extends AbstractSunSpecBatteryInverter
implements BatteryInverterKacoBlueplanetGridsave, ManagedSymmetricBatteryInverter, SymmetricBatteryInverter, ModbusComponent, OpenemsComponent, TimedataProvider, StartStoppable

Nested Class Summary

Nested classes/interfaces inherited from class io.openems.edge.bridge.modbus.api.AbstractOpenemsModbusComponent

AbstractOpenemsModbusComponent.BitConverter, AbstractOpenemsModbusComponent.ChannelMapper<ELEMENT extends ModbusElement>

Nested classes/interfaces inherited from interface io.openems.edge.batteryinverter.kaco.blueplanetgridsave.BatteryInverterKacoBlueplanetGridsave

BatteryInverterKacoBlueplanetGridsave.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.batteryinverter.api.ManagedSymmetricBatteryInverter

ManagedSymmetricBatteryInverter.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.bridge.modbus.api.ModbusComponent

ModbusComponent.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.common.component.OpenemsComponent

OpenemsComponent.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.common.startstop.StartStoppable

StartStoppable.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.batteryinverter.api.SymmetricBatteryInverter

SymmetricBatteryInverter.ChannelId

Field Summary

Fields inherited from interface io.openems.edge.batteryinverter.kaco.blueplanetgridsave.BatteryInverterKacoBlueplanetGridsave

WATCHDOG_TIMEOUT_SECONDS, WATCHDOG_TRIGGER_SECONDS

Fields inherited from interface io.openems.edge.batteryinverter.api.SymmetricBatteryInverter

POWER_DOC_TEXT

Constructor Summary

Constructors

Constructor	Description
BatteryInverterKacoBlueplanetGridsaveImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addBlock(int startAddress, SunSpecModel model, Priority priority)	Adds the block starting from startAddress.
protected void	deactivate()	Make sure to call this method from the inheriting OSGi Component.
String	debugLog()	Gets some output that is suitable for a continuous Debug log.
KacoSunSpecModel.S64201.S64201CurrentState	getCurrentState()	Gets the Current State.
int	getPowerPrecision()	Calculate the Power-Precision from the Max Apparent Power using the SetPoint scale-factor.
StartStop	getStartStopTarget()	Gets the target Start/Stop mode from config or StartStop-Channel.
BatteryInverterConstraint[]	getStaticConstraints()	Gets static Constraints for this Battery-Inverter.
<T extends Channel<?>> T	getSunSpecChannelOrError(SunSpecPoint point)	Get the Channel for the given Point or throw an error if it is not available.
protected SunSpecModel	getSunSpecModel(int blockId)	Overwrite to provide custom SunSpecModel.
Timedata	getTimedata()	Gets the Timedata service.
boolean	hasFailure()	Checks if the system is in a fault state.
boolean	isRunning()	Checks if the system is in a running state.
boolean	isShutdown()	Checks if the system is in a stop state.
protected void	onSunSpecInitializationCompleted()	Mark SunSpec initialization completed; this takes some time at startup.
void	run(Battery battery, int setActivePower, int setReactivePower)	Run the Battery-Inverter.
protected void	setModbus(BridgeModbus modbus)	Set the Modbus bridge.
void	setStartStop(StartStop value)	Starts or stops the device or service represented by this OpenEMS Component.

Methods inherited from class io.openems.edge.batteryinverter.sunspec.AbstractSunSpecBatteryInverter

activate

Methods inherited from class io.openems.edge.bridge.modbus.sunspec.AbstractOpenemsSunSpecComponent

activate, defineModbusProtocol, generateElementToChannelConverter, getSunSpecChannel, isSunSpecInitializationCompleted, mapFirstPointToChannel, preprocessModbusElements

Methods inherited from class io.openems.edge.bridge.modbus.api.AbstractOpenemsModbusComponent

activate, activate, getBridgeModbus, getModbusProtocol, getUnitId, m, m, m, m, m, m, modified, modified, retryModbusCommunication, unsetModbus

Methods inherited from class io.openems.edge.common.component.AbstractOpenemsComponent

_channel, addChannel, addChannels, addChannels, alias, channels, getComponentContext, id, isEnabled, logDebug, logError, logInfo, logWarn, removeChannel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.openems.edge.batteryinverter.kaco.blueplanetgridsave.BatteryInverterKacoBlueplanetGridsave

_setGridDisconnection, _setInverterCurrentStateFault, _setMaxStartTimeout, _setMaxStopTimeout, _setRunFailed, getGridDisconnectionChannel, getInverterCurrentStateFaultChannel, getMaxStartTimeout, getMaxStartTimeoutChannel, getMaxStopTimeout, getMaxStopTimeoutChannel, getRequestedStateChannel, getRunFailedChannel, setRequestedState

Methods inherited from interface io.openems.edge.batteryinverter.api.ManagedSymmetricBatteryInverter

isManaged, isOffGridPossible

Methods inherited from interface io.openems.edge.bridge.modbus.api.ModbusComponent

_setModbusCommunicationFailed, getModbusCommunicationFailed, getModbusCommunicationFailedChannel, retryModbusCommunication

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, getComponentContext, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid

Methods inherited from interface io.openems.edge.common.startstop.StartStoppable

_setStartStop, getStartStop, getStartStopChannel, isStarted, isStopped, start, stop

Methods inherited from interface io.openems.edge.batteryinverter.api.SymmetricBatteryInverter

_setActiveChargeEnergy, _setActiveChargeEnergy, _setActiveDischargeEnergy, _setActiveDischargeEnergy, _setActivePower, _setActivePower, _setGridMode, _setMaxApparentPower, _setMaxApparentPower, _setReactivePower, _setReactivePower, getActiveChargeEnergy, getActiveChargeEnergyChannel, getActiveDischargeEnergy, getActiveDischargeEnergyChannel, getActivePower, getActivePowerChannel, getGridMode, getGridModeChannel, getMaxApparentPower, getMaxApparentPowerChannel, getReactivePower, getReactivePowerChannel

Constructor Details

BatteryInverterKacoBlueplanetGridsaveImpl

public BatteryInverterKacoBlueplanetGridsaveImpl()

Method Details

setModbus

protected void setModbus(BridgeModbus modbus)

Description copied from class: AbstractOpenemsModbusComponent

Set the Modbus bridge. Should be called by @Reference

Overrides:

setModbus in class AbstractOpenemsModbusComponent

Parameters:

modbus - the BridgeModbus Reference

deactivate

protected void deactivate()

Description copied from class: AbstractSunSpecBatteryInverter

Make sure to call this method from the inheriting OSGi Component.

Overrides:

deactivate in class AbstractSunSpecBatteryInverter

run

public void run(Battery battery,
 int setActivePower,
 int setReactivePower)
         throws OpenemsError.OpenemsNamedException

Description copied from interface: ManagedSymmetricBatteryInverter

Run the Battery-Inverter.

• bring the Battery-Inverter in the desired state
• apply information from Battery as required
• set the target Active and Reactive Power.

This is called on ManagedSymmetricEss::applyPower()

Specified by:

run in interface ManagedSymmetricBatteryInverter

Parameters:

battery - the Battery

setActivePower - the active power setpoint

setReactivePower - the reactive power setpoint

Throws:

OpenemsError.OpenemsNamedException - on error

getStaticConstraints

public BatteryInverterConstraint[] getStaticConstraints()
                                                 throws OpenemsException

Description copied from interface: ManagedSymmetricBatteryInverter

Gets static Constraints for this Battery-Inverter. Override this method to provide specific Constraints for this Battery-Inverter on every Cycle.

Specified by:

getStaticConstraints in interface ManagedSymmetricBatteryInverter

Returns:

the Constraints

Throws:

OpenemsException - on error

onSunSpecInitializationCompleted

protected void onSunSpecInitializationCompleted()

Mark SunSpec initialization completed; this takes some time at startup.

Overrides:

onSunSpecInitializationCompleted in class AbstractSunSpecBatteryInverter

getCurrentState

public KacoSunSpecModel.S64201.S64201CurrentState getCurrentState()

Description copied from interface: BatteryInverterKacoBlueplanetGridsave

Gets the Current State.

Specified by:

getCurrentState in interface BatteryInverterKacoBlueplanetGridsave

Returns:

the KacoSunSpecModel.S64201.S64201CurrentState

getSunSpecModel

protected SunSpecModel getSunSpecModel(int blockId)
                                throws IllegalArgumentException

Description copied from class: AbstractOpenemsSunSpecComponent

Overwrite to provide custom SunSpecModel.

Overrides:

getSunSpecModel in class AbstractOpenemsSunSpecComponent

Parameters:

blockId - the Block-Id

Returns:

the SunSpecModel

Throws:

IllegalArgumentException - on error

getPowerPrecision

public int getPowerPrecision()

Calculate the Power-Precision from the Max Apparent Power using the SetPoint scale-factor.

Specified by:

getPowerPrecision in interface ManagedSymmetricBatteryInverter

Returns:

the power precision

debugLog

public String debugLog()

Description copied from interface: OpenemsComponent

Gets some output that is suitable for a continuous Debug log. Returns 'null' by default which causes no output.

Specified by:

debugLog in interface OpenemsComponent

Returns:

the debug log output

setStartStop

public void setStartStop(StartStop value)

Description copied from interface: StartStoppable

Starts or stops the device or service represented by this OpenEMS Component.

Specified by:

setStartStop in interface StartStoppable

Parameters:

value - target StartStop state

getStartStopTarget

public StartStop getStartStopTarget()

Description copied from interface: BatteryInverterKacoBlueplanetGridsave

Gets the target Start/Stop mode from config or StartStop-Channel.

Specified by:

getStartStopTarget in interface BatteryInverterKacoBlueplanetGridsave

Returns:

StartStop

getSunSpecChannelOrError

public <T extends Channel<?>> T getSunSpecChannelOrError(SunSpecPoint point)
                                                  throws OpenemsException

Description copied from class: AbstractOpenemsSunSpecComponent

Get the Channel for the given Point or throw an error if it is not available.

Specified by:

getSunSpecChannelOrError in interface BatteryInverterKacoBlueplanetGridsave

Overrides:

getSunSpecChannelOrError in class AbstractOpenemsSunSpecComponent

Type Parameters:

T - the Channel type

Parameters:

point - the SunSpec Point

Returns:

the optional Channel

Throws:

OpenemsException - if Channel is not available

getTimedata

public Timedata getTimedata()

Description copied from interface: TimedataProvider

Gets the Timedata service.

Specified by:

getTimedata in interface TimedataProvider

Returns:

the service or null if it is not (yet) available.

addBlock

protected void addBlock(int startAddress,
 SunSpecModel model,
 Priority priority)

Description copied from class: AbstractOpenemsSunSpecComponent

Adds the block starting from startAddress.

Overrides:

addBlock in class AbstractOpenemsSunSpecComponent

Parameters:

startAddress - the address to start reading from

model - the SunSpecModel

priority - the reading priority

isRunning

public boolean isRunning()

Description copied from interface: BatteryInverterKacoBlueplanetGridsave

Checks if the system is in a running state. This method retrieves the system's global state and determines whether the system is in a running state.

Specified by:

isRunning in interface BatteryInverterKacoBlueplanetGridsave

Returns:

true if the system is in a running state, false otherwise.

isShutdown

public boolean isShutdown()

Description copied from interface: BatteryInverterKacoBlueplanetGridsave

Checks if the system is in a stop state. This method retrieves the system's global state and determines whether the system is in a stop state.

Specified by:

isShutdown in interface BatteryInverterKacoBlueplanetGridsave

Returns:

true if the system is in a stop state, false otherwise.

hasFailure

public boolean hasFailure()

Description copied from interface: BatteryInverterKacoBlueplanetGridsave

Checks if the system is in a fault state. This method retrieves the system's global state and determines whether the system is in a fault state.

Specified by:

hasFailure in interface BatteryInverterKacoBlueplanetGridsave

Returns:

true if the system is in a fault state, false otherwise.