io.openems.edge.evcs.api

Interface ManagedEvcs

All Superinterfaces:

Evcs, OpenemsComponent

All Known Implementing Classes:

Abl, DummyManagedEvcs, IesKeywattSingleCcs, KebaKeContact, SimulatedEvcs

@ProviderType
public interface ManagedEvcs
extends Evcs

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ManagedEvcs.ChannelId

Method Summary

Modifier and Type	Method and Description
default void	_setIsClustered(boolean value) Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.IS_CLUSTERED Channel.
default void	_setSetChargePowerLimit(int value) Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT Channel.
default void	_setSetChargePowerLimit(java.lang.Integer value) Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT Channel.
default void	_setSetChargePowerLimitWithPid(int value) Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT_WITH_PID Channel.
default void	_setSetChargePowerLimitWithPid(java.lang.Integer value) Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT_WITH_PID Channel.
default void	_setSetChargePowerRequest(int value) Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_REQUEST Channel.
default void	_setSetChargePowerRequest(java.lang.Integer value) Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_REQUEST Channel.
default void	_setSetDisplayText(java.lang.String value) Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_DISPLAY_TEXT Channel.
default void	_setSetEnergyLimit(int value) Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_ENERGY_LIMIT Channel.
default void	_setSetEnergyLimit(java.lang.Integer value) Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_ENERGY_LIMIT Channel.
EvcsPower	getEvcsPower()
default Value<java.lang.Boolean>	getIsClustered() Gets the Is true if the EVCS is in a EVCS-Cluster.
default BooleanReadChannel	getIsClusteredChannel() Gets the Channel for ManagedEvcs.ChannelId.IS_CLUSTERED.
static ModbusSlaveNatureTable	getModbusSlaveNatureTable(AccessMode accessMode) Returns the modbus table for this nature.
default Value<java.lang.Integer>	getSetChargePowerLimit() Gets the set charge power limit of the EVCS in [W].
default IntegerWriteChannel	getSetChargePowerLimitChannel() Gets the Channel for ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT.
default Value<java.lang.Integer>	getSetChargePowerLimitWithPid() Gets the set charge power limit of the EVCS in [W] with applied PID filter.
default IntegerWriteChannel	getSetChargePowerLimitWithPidChannel() Gets the Channel for ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT_WITH_PID.
default Value<java.lang.Integer>	getSetChargePowerRequest() Gets the request for a charge power in [W].
default IntegerWriteChannel	getSetChargePowerRequestChannel() Gets the Channel for ManagedEvcs.ChannelId.SET_CHARGE_POWER_REQUEST.
default Value<java.lang.String>	getSetDisplayText() Gets the Text that is shown on the display of the EVCS.
default StringWriteChannel	getSetDisplayTextChannel() Gets the Channel for ManagedEvcs.ChannelId.SET_DISPLAY_TEXT.
default Value<java.lang.Integer>	getSetEnergyLimit() Gets the energy limit for the current or next session in [Wh]..
default IntegerWriteChannel	getSetEnergyLimitChannel() Gets the Channel for ManagedEvcs.ChannelId.SET_ENERGY_LIMIT.
default void	setChargePowerLimit(java.lang.Integer value) Sets the charge power limit of the EVCS in [W].
default void	setChargePowerLimitWithPid(java.lang.Integer value) Sets the charge power limit of the EVCS in [W] with applied PID filter.
default void	setChargePowerRequest(java.lang.Integer value) Sets the request for a charge power in [W].
default void	setDisplayText(java.lang.String value) Sets a Text that is shown on the display of the EVCS.
default void	setEnergyLimit(java.lang.Integer value) Sets the energy limit for the current or next session in [Wh].

Methods inherited from interface io.openems.edge.evcs.api.Evcs

_setActiveConsumptionEnergy, _setActiveConsumptionEnergy, _setChargePower, _setChargePower, _setChargingstationCommunicationFailed, _setChargingType, _setEnergySession, _setEnergySession, _setMaximumHardwarePower, _setMaximumHardwarePower, _setMaximumPower, _setMaximumPower, _setMinimumHardwarePower, _setMinimumHardwarePower, _setMinimumPower, _setMinimumPower, _setPhases, _setPhases, _setStatus, getActiveConsumptionEnergy, getActiveConsumptionEnergyChannel, getChargePower, getChargePowerChannel, getChargingstationCommunicationFailed, getChargingstationCommunicationFailedChannel, getChargingType, getChargingTypeChannel, getEnergySession, getEnergySessionChannel, getMaximumHardwarePower, getMaximumHardwarePowerChannel, getMaximumPower, getMaximumPowerChannel, getMinimumHardwarePower, getMinimumHardwarePowerChannel, getMinimumPower, getMinimumPowerChannel, getPhases, getPhasesChannel, getStatus, getStatusChannel

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

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

Method Detail

getEvcsPower

EvcsPower getEvcsPower()

getSetChargePowerLimitChannel

default IntegerWriteChannel getSetChargePowerLimitChannel()

Gets the Channel for ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT.

Returns:

the Channel

getSetChargePowerLimit

default Value<java.lang.Integer> getSetChargePowerLimit()

Gets the set charge power limit of the EVCS in [W]. See ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT.

Returns:

the Channel Value

_setSetChargePowerLimit

default void _setSetChargePowerLimit(java.lang.Integer value)

Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT Channel.

Parameters:

value - the next value

_setSetChargePowerLimit

default void _setSetChargePowerLimit(int value)

Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT Channel.

Parameters:

value - the next value

setChargePowerLimit

default void setChargePowerLimit(java.lang.Integer value)
                          throws OpenemsError.OpenemsNamedException

Sets the charge power limit of the EVCS in [W]. See ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT.

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getSetChargePowerLimitWithPidChannel

default IntegerWriteChannel getSetChargePowerLimitWithPidChannel()

Gets the Channel for ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT_WITH_PID.

Returns:

the Channel

getSetChargePowerLimitWithPid

default Value<java.lang.Integer> getSetChargePowerLimitWithPid()

Gets the set charge power limit of the EVCS in [W] with applied PID filter. See ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT_WITH_PID.

Returns:

the Channel Value

_setSetChargePowerLimitWithPid

default void _setSetChargePowerLimitWithPid(java.lang.Integer value)

Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT_WITH_PID Channel.

Parameters:

value - the next value

_setSetChargePowerLimitWithPid

default void _setSetChargePowerLimitWithPid(int value)

Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT_WITH_PID Channel.

Parameters:

value - the next value

setChargePowerLimitWithPid

default void setChargePowerLimitWithPid(java.lang.Integer value)
                                 throws OpenemsError.OpenemsNamedException

Sets the charge power limit of the EVCS in [W] with applied PID filter. See ManagedEvcs.ChannelId.SET_CHARGE_POWER_LIMIT_WITH_PID.

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getIsClusteredChannel

default BooleanReadChannel getIsClusteredChannel()

Gets the Channel for ManagedEvcs.ChannelId.IS_CLUSTERED.

Returns:

the Channel

getIsClustered

default Value<java.lang.Boolean> getIsClustered()

Gets the Is true if the EVCS is in a EVCS-Cluster. See ManagedEvcs.ChannelId.IS_CLUSTERED.

Returns:

the Channel Value

_setIsClustered

default void _setIsClustered(boolean value)

Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.IS_CLUSTERED Channel.

Parameters:

value - the next value

getSetDisplayTextChannel

default StringWriteChannel getSetDisplayTextChannel()

Gets the Channel for ManagedEvcs.ChannelId.SET_DISPLAY_TEXT.

Returns:

the Channel

getSetDisplayText

default Value<java.lang.String> getSetDisplayText()

Gets the Text that is shown on the display of the EVCS. See ManagedEvcs.ChannelId.SET_DISPLAY_TEXT.

Returns:

the Channel Value

_setSetDisplayText

default void _setSetDisplayText(java.lang.String value)

Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_DISPLAY_TEXT Channel.

Parameters:

value - the next value

setDisplayText

default void setDisplayText(java.lang.String value)
                     throws OpenemsError.OpenemsNamedException

Sets a Text that is shown on the display of the EVCS. See ManagedEvcs.ChannelId.SET_DISPLAY_TEXT.

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getSetChargePowerRequestChannel

default IntegerWriteChannel getSetChargePowerRequestChannel()

Gets the Channel for ManagedEvcs.ChannelId.SET_CHARGE_POWER_REQUEST.

Returns:

the Channel

getSetChargePowerRequest

default Value<java.lang.Integer> getSetChargePowerRequest()

Gets the request for a charge power in [W]. The limit is not directly activated by this call.. See ManagedEvcs.ChannelId.SET_CHARGE_POWER_REQUEST.

Returns:

the Channel Value

_setSetChargePowerRequest

default void _setSetChargePowerRequest(java.lang.Integer value)

Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_REQUEST Channel.

Parameters:

value - the next value

_setSetChargePowerRequest

default void _setSetChargePowerRequest(int value)

Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_CHARGE_POWER_REQUEST Channel.

Parameters:

value - the next value

setChargePowerRequest

default void setChargePowerRequest(java.lang.Integer value)
                            throws OpenemsError.OpenemsNamedException

Sets the request for a charge power in [W]. The limit is not directly activated by this call. See ManagedEvcs.ChannelId.SET_CHARGE_POWER_REQUEST.

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getSetEnergyLimitChannel

default IntegerWriteChannel getSetEnergyLimitChannel()

Gets the Channel for ManagedEvcs.ChannelId.SET_ENERGY_LIMIT.

Returns:

the Channel

getSetEnergyLimit

default Value<java.lang.Integer> getSetEnergyLimit()

Gets the energy limit for the current or next session in [Wh].. See ManagedEvcs.ChannelId.SET_ENERGY_LIMIT.

Returns:

the Channel Value

_setSetEnergyLimit

default void _setSetEnergyLimit(java.lang.Integer value)

Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_ENERGY_LIMIT Channel.

Parameters:

value - the next value

_setSetEnergyLimit

default void _setSetEnergyLimit(int value)

Internal method to set the 'nextValue' on ManagedEvcs.ChannelId.SET_ENERGY_LIMIT Channel.

Parameters:

value - the next value

setEnergyLimit

default void setEnergyLimit(java.lang.Integer value)
                     throws OpenemsError.OpenemsNamedException

Sets the energy limit for the current or next session in [Wh]. See ManagedEvcs.ChannelId.SET_ENERGY_LIMIT.

Parameters:

value - the next write value

Throws:

OpenemsError.OpenemsNamedException - on error

getModbusSlaveNatureTable

static ModbusSlaveNatureTable getModbusSlaveNatureTable(AccessMode accessMode)

Returns the modbus table for this nature.

Specified by:

getModbusSlaveNatureTable in interface Evcs

Specified by:

getModbusSlaveNatureTable in interface OpenemsComponent

Parameters:

accessMode - accessMode

Returns:

nature table