Package io.openems.edge.evcs.api

Interface Evcs

All Superinterfaces:

OpenemsComponent

All Known Subinterfaces:

EvcsClusterPeakShaving, EvcsGoeChargerHome, EvcsKebaKeContact, EvcsOcppAbl, EvcsOcppIesKeywattSingle, ManagedEvcs, MeasuringEvcs, MetaEvcs, SimulatorEvcs, SocEvcs

All Known Implementing Classes:

AbstractManagedEvcsComponent, AbstractManagedOcppEvcsComponent, DummyManagedEvcs, EvcsAlpitronicHyperchargerImpl, EvcsClusterPeakShavingImpl, EvcsDezonyImpl, EvcsGoeChargerHomeImpl, EvcsHardyBarthImpl, EvcsKebaKeContactImpl, EvcsOcppAblImpl, EvcsOcppIesKeywattSingleImpl, EvcsSpelsbergSmartImpl, EvcsWebastoNextImpl, EvcsWebastoUniteImpl, SimulatorEvcsImpl

public interface Evcs
extends OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Evcs.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	DEFAULT_MAXIMUM_HARDWARE_CURRENT
static final Integer	DEFAULT_MAXIMUM_HARDWARE_POWER
static final Integer	DEFAULT_MINIMUM_HARDWARE_CURRENT
static final Integer	DEFAULT_MINIMUM_HARDWARE_POWER
static final int	DEFAULT_POWER_RECISION
static final Integer	DEFAULT_VOLTAGE

Method Summary

Modifier and Type	Method	Description
default void	_setActiveConsumptionEnergy(long value)	Internal method to set the 'nextValue' on Evcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY Channel.
default void	_setActiveConsumptionEnergy(Long value)	Internal method to set the 'nextValue' on Evcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY Channel.
default void	_setChargePower(int value)	Internal method to set the 'nextValue' on Evcs.ChannelId.CHARGE_POWER Channel.
default void	_setChargePower(Integer value)	Internal method to set the 'nextValue' on Evcs.ChannelId.CHARGE_POWER Channel.
default void	_setChargingstationCommunicationFailed(boolean value)	Internal method to set the 'nextValue' on Evcs.ChannelId.CHARGINGSTATION_COMMUNICATION_FAILED Channel.
default void	_setChargingType(ChargingType value)	Internal method to set the 'nextValue' on Evcs.ChannelId.CHARGING_TYPE Channel.
default void	_setEnergySession(int value)	Internal method to set the 'nextValue' on Evcs.ChannelId.ENERGY_SESSION Channel.
default void	_setEnergySession(Integer value)	Internal method to set the 'nextValue' on Evcs.ChannelId.ENERGY_SESSION Channel.
default void	_setFixedMaximumHardwarePower(int value)	Internal method to set the 'nextValue' on Evcs.ChannelId.FIXED_MAXIMUM_HARDWARE_POWER Channel.
default void	_setFixedMaximumHardwarePower(Integer value)	Internal method to set the 'nextValue' on Evcs.ChannelId.FIXED_MAXIMUM_HARDWARE_POWER Channel.
default void	_setFixedMinimumHardwarePower(int value)	Internal method to set the 'nextValue' on Evcs.ChannelId.FIXED_MINIMUM_HARDWARE_POWER Channel.
default void	_setFixedMinimumHardwarePower(Integer value)	Internal method to set the 'nextValue' on Evcs.ChannelId.FIXED_MINIMUM_HARDWARE_POWER Channel.
default void	_setMaximumPower(int value)	Internal method to set the 'nextValue' on Evcs.ChannelId.MAXIMUM_POWER Channel.
default void	_setMaximumPower(Integer value)	Internal method to set the 'nextValue' on Evcs.ChannelId.MAXIMUM_POWER Channel.
default void	_setMinimumPower(int value)	Internal method to set the 'nextValue' on Evcs.ChannelId.MINIMUM_POWER Channel.
default void	_setMinimumPower(Integer value)	Internal method to set the 'nextValue' on Evcs.ChannelId.MINIMUM_POWER Channel.
default void	_setPhases(Phases value)	Internal method to set the 'nextValue' on Evcs.ChannelId.PHASES Channel.
default void	_setPhases(Integer value)	Internal method to set the 'nextValue' on Evcs.ChannelId.PHASES Channel.
default void	_setStatus(Status value)	Internal method to set the 'nextValue' on Evcs.ChannelId.STATUS Channel.
static void	addCalculatePowerLimitListeners(Evcs evcs)	Adds onSetNextValue listeners for minimum and maximum hardware power.
default Value<Long>	getActiveConsumptionEnergy()	Gets the Active Consumption Energy in [Wh_Σ].
default LongReadChannel	getActiveConsumptionEnergyChannel()	Gets the Channel for Evcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY.
default Value<Integer>	getChargePower()	Gets the Charge Power in [W].
default IntegerReadChannel	getChargePowerChannel()	Gets the Channel for Evcs.ChannelId.CHARGE_POWER.
default Value<Boolean>	getChargingstationCommunicationFailed()	Gets the Failed state channel for a failed communication to the EVCS.
default StateChannel	getChargingstationCommunicationFailedChannel()	Gets the Channel for Evcs.ChannelId.CHARGINGSTATION_COMMUNICATION_FAILED.
default ChargingType	getChargingType()	Gets the Type of charging.
default Channel<ChargingType>	getChargingTypeChannel()	Gets the Channel for Evcs.ChannelId.CHARGING_TYPE.
default Value<Integer>	getEnergySession()	Gets the Energy that was charged during the current or last Session in [Wh].
default IntegerReadChannel	getEnergySessionChannel()	Gets the Channel for Evcs.ChannelId.ENERGY_SESSION.
default Value<Integer>	getFixedMaximumHardwarePower()	Gets the fixed maximum power valid by the hardware in [W].
default IntegerReadChannel	getFixedMaximumHardwarePowerChannel()	Gets the Channel for Evcs.ChannelId.FIXED_MAXIMUM_HARDWARE_POWER.
default Value<Integer>	getFixedMinimumHardwarePower()	Gets the fixed minimum power valid by the hardware in [W].
default IntegerReadChannel	getFixedMinimumHardwarePowerChannel()	Gets the Channel for Evcs.ChannelId.FIXED_MINIMUM_HARDWARE_POWER.
default Value<Integer>	getMaximumHardwarePower()	Gets the Maximum Power valid by the hardware in [W].
default IntegerReadChannel	getMaximumHardwarePowerChannel()	Gets the Channel for Evcs.ChannelId.MAXIMUM_HARDWARE_POWER.
default Value<Integer>	getMaximumPower()	Gets the Maximum Power valid by software in [W].
default IntegerReadChannel	getMaximumPowerChannel()	Gets the Channel for Evcs.ChannelId.MAXIMUM_POWER.
default Value<Integer>	getMinimumHardwarePower()	Gets the Minimum Power valid by the hardware in [W].
default IntegerReadChannel	getMinimumHardwarePowerChannel()	Gets the Channel for Evcs.ChannelId.MINIMUM_HARDWARE_POWER.
default Value<Integer>	getMinimumPower()	Gets the Minimum Power valid by software in [W].
default IntegerReadChannel	getMinimumPowerChannel()	Gets the Channel for Evcs.ChannelId.MINIMUM_POWER.
static ModbusSlaveNatureTable	getModbusSlaveNatureTable(AccessMode accessMode)	Used for Modbus/TCP Api Controller.
default Phases	getPhases()	Gets the current Phases definition.
default int	getPhasesAsInt()	Gets the Count of phases, the EV is charging with.
default EnumReadChannel	getPhasesChannel()	Gets the Channel for Evcs.ChannelId.PHASES.
default Status	getStatus()	Gets the Status of the EVCS charging station.
default Channel<Status>	getStatusChannel()	Gets the Channel for Evcs.ChannelId.STATUS.

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

Field Details

DEFAULT_MAXIMUM_HARDWARE_POWER

static final Integer DEFAULT_MAXIMUM_HARDWARE_POWER

DEFAULT_MINIMUM_HARDWARE_POWER

static final Integer DEFAULT_MINIMUM_HARDWARE_POWER

DEFAULT_MAXIMUM_HARDWARE_CURRENT

static final Integer DEFAULT_MAXIMUM_HARDWARE_CURRENT

DEFAULT_MINIMUM_HARDWARE_CURRENT

static final Integer DEFAULT_MINIMUM_HARDWARE_CURRENT

DEFAULT_VOLTAGE

static final Integer DEFAULT_VOLTAGE

DEFAULT_POWER_RECISION

static final int DEFAULT_POWER_RECISION

See Also:

• Constant Field Values

Method Details

getStatusChannel

default Channel<Status> getStatusChannel()

Gets the Channel for Evcs.ChannelId.STATUS.

Returns:

the Channel

getStatus

default Status getStatus()

Gets the Status of the EVCS charging station. See Evcs.ChannelId.STATUS.

Returns:

the Channel Value

_setStatus

default void _setStatus(Status value)

Internal method to set the 'nextValue' on Evcs.ChannelId.STATUS Channel.

Parameters:

value - the next value

getChargePowerChannel

default IntegerReadChannel getChargePowerChannel()

Gets the Channel for Evcs.ChannelId.CHARGE_POWER.

Returns:

the Channel

getChargePower

default Value<Integer> getChargePower()

Gets the Charge Power in [W]. See Evcs.ChannelId.CHARGE_POWER.

Returns:

the Channel Value

_setChargePower

default void _setChargePower(Integer value)

Internal method to set the 'nextValue' on Evcs.ChannelId.CHARGE_POWER Channel.

Parameters:

value - the next value

_setChargePower

default void _setChargePower(int value)

Internal method to set the 'nextValue' on Evcs.ChannelId.CHARGE_POWER Channel.

Parameters:

value - the next value

getChargingTypeChannel

default Channel<ChargingType> getChargingTypeChannel()

Gets the Channel for Evcs.ChannelId.CHARGING_TYPE.

Returns:

the Channel

getChargingType

default ChargingType getChargingType()

Gets the Type of charging. See Evcs.ChannelId.CHARGING_TYPE.

Returns:

the Channel Value

_setChargingType

default void _setChargingType(ChargingType value)

Internal method to set the 'nextValue' on Evcs.ChannelId.CHARGING_TYPE Channel.

Parameters:

value - the next value

getPhasesChannel

default EnumReadChannel getPhasesChannel()

Gets the Channel for Evcs.ChannelId.PHASES.

Returns:

the Channel

getPhases

default Phases getPhases()

Gets the current Phases definition. See Evcs.ChannelId.PHASES.

Returns:

the Channel Value

getPhasesAsInt

default int getPhasesAsInt()

Gets the Count of phases, the EV is charging with. See Evcs.ChannelId.PHASES.

Returns:

the Channel Value

_setPhases

default void _setPhases(Phases value)

Internal method to set the 'nextValue' on Evcs.ChannelId.PHASES Channel.

Parameters:

value - the next value

_setPhases

default void _setPhases(Integer value)

Internal method to set the 'nextValue' on Evcs.ChannelId.PHASES Channel.

Parameters:

value - the next value

getFixedMinimumHardwarePowerChannel

default IntegerReadChannel getFixedMinimumHardwarePowerChannel()

Gets the Channel for Evcs.ChannelId.FIXED_MINIMUM_HARDWARE_POWER.

Returns:

the Channel

getFixedMinimumHardwarePower

default Value<Integer> getFixedMinimumHardwarePower()

Gets the fixed minimum power valid by the hardware in [W]. See Evcs.ChannelId.FIXED_MINIMUM_HARDWARE_POWER.

Returns:

the Channel Value

_setFixedMinimumHardwarePower

default void _setFixedMinimumHardwarePower(Integer value)

Internal method to set the 'nextValue' on Evcs.ChannelId.FIXED_MINIMUM_HARDWARE_POWER Channel.

Parameters:

value - the next value

_setFixedMinimumHardwarePower

default void _setFixedMinimumHardwarePower(int value)

Internal method to set the 'nextValue' on Evcs.ChannelId.FIXED_MINIMUM_HARDWARE_POWER Channel.

Parameters:

value - the next value

getFixedMaximumHardwarePowerChannel

default IntegerReadChannel getFixedMaximumHardwarePowerChannel()

Gets the Channel for Evcs.ChannelId.FIXED_MAXIMUM_HARDWARE_POWER.

Returns:

the Channel

getFixedMaximumHardwarePower

default Value<Integer> getFixedMaximumHardwarePower()

Gets the fixed maximum power valid by the hardware in [W]. See Evcs.ChannelId.FIXED_MAXIMUM_HARDWARE_POWER.

Returns:

the Channel Value

_setFixedMaximumHardwarePower

default void _setFixedMaximumHardwarePower(Integer value)

Internal method to set the 'nextValue' on Evcs.ChannelId.FIXED_MAXIMUM_HARDWARE_POWER Channel.

Parameters:

value - the next value

_setFixedMaximumHardwarePower

default void _setFixedMaximumHardwarePower(int value)

Internal method to set the 'nextValue' on Evcs.ChannelId.FIXED_MAXIMUM_HARDWARE_POWER Channel.

Parameters:

value - the next value

getMaximumHardwarePowerChannel

default IntegerReadChannel getMaximumHardwarePowerChannel()

Gets the Channel for Evcs.ChannelId.MAXIMUM_HARDWARE_POWER.

Returns:

the Channel

getMaximumHardwarePower

default Value<Integer> getMaximumHardwarePower()

Gets the Maximum Power valid by the hardware in [W]. See Evcs.ChannelId.MAXIMUM_HARDWARE_POWER.

Returns:

the Channel Value

getMinimumHardwarePowerChannel

default IntegerReadChannel getMinimumHardwarePowerChannel()

Gets the Channel for Evcs.ChannelId.MINIMUM_HARDWARE_POWER.

Returns:

the Channel

getMinimumHardwarePower

default Value<Integer> getMinimumHardwarePower()

Gets the Minimum Power valid by the hardware in [W]. See Evcs.ChannelId.MINIMUM_HARDWARE_POWER.

Returns:

the Channel Value

getMaximumPowerChannel

default IntegerReadChannel getMaximumPowerChannel()

Gets the Channel for Evcs.ChannelId.MAXIMUM_POWER.

Returns:

the Channel

getMaximumPower

default Value<Integer> getMaximumPower()

Gets the Maximum Power valid by software in [W]. See Evcs.ChannelId.MAXIMUM_POWER.

Returns:

the Channel Value

_setMaximumPower

default void _setMaximumPower(Integer value)

Internal method to set the 'nextValue' on Evcs.ChannelId.MAXIMUM_POWER Channel.

Parameters:

value - the next value

_setMaximumPower

default void _setMaximumPower(int value)

Internal method to set the 'nextValue' on Evcs.ChannelId.MAXIMUM_POWER Channel.

Parameters:

value - the next value

getMinimumPowerChannel

default IntegerReadChannel getMinimumPowerChannel()

Gets the Channel for Evcs.ChannelId.MINIMUM_POWER.

Returns:

the Channel

getMinimumPower

default Value<Integer> getMinimumPower()

Gets the Minimum Power valid by software in [W]. See Evcs.ChannelId.MINIMUM_POWER.

Returns:

the Channel Value

_setMinimumPower

default void _setMinimumPower(Integer value)

Internal method to set the 'nextValue' on Evcs.ChannelId.MINIMUM_POWER Channel.

Parameters:

value - the next value

_setMinimumPower

default void _setMinimumPower(int value)

Internal method to set the 'nextValue' on Evcs.ChannelId.MINIMUM_POWER Channel.

Parameters:

value - the next value

getEnergySessionChannel

default IntegerReadChannel getEnergySessionChannel()

Gets the Channel for Evcs.ChannelId.ENERGY_SESSION.

Returns:

the Channel

getEnergySession

default Value<Integer> getEnergySession()

Gets the Energy that was charged during the current or last Session in [Wh]. See Evcs.ChannelId.ENERGY_SESSION.

Returns:

the Channel Value

_setEnergySession

default void _setEnergySession(Integer value)

Internal method to set the 'nextValue' on Evcs.ChannelId.ENERGY_SESSION Channel.

Parameters:

value - the next value

_setEnergySession

default void _setEnergySession(int value)

Internal method to set the 'nextValue' on Evcs.ChannelId.ENERGY_SESSION Channel.

Parameters:

value - the next value

getActiveConsumptionEnergyChannel

default LongReadChannel getActiveConsumptionEnergyChannel()

Gets the Channel for Evcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY.

Returns:

the Channel

getActiveConsumptionEnergy

default Value<Long> getActiveConsumptionEnergy()

Gets the Active Consumption Energy in [Wh_Σ]. This relates to negative ACTIVE_POWER. See Evcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY.

Returns:

the Channel Value

_setActiveConsumptionEnergy

default void _setActiveConsumptionEnergy(Long value)

Internal method to set the 'nextValue' on Evcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY Channel.

Parameters:

value - the next value

_setActiveConsumptionEnergy

default void _setActiveConsumptionEnergy(long value)

Internal method to set the 'nextValue' on Evcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY Channel.

Parameters:

value - the next value

getChargingstationCommunicationFailedChannel

default StateChannel getChargingstationCommunicationFailedChannel()

Gets the Channel for Evcs.ChannelId.CHARGINGSTATION_COMMUNICATION_FAILED.

Returns:

the Channel

getChargingstationCommunicationFailed

default Value<Boolean> getChargingstationCommunicationFailed()

Gets the Failed state channel for a failed communication to the EVCS. See Evcs.ChannelId.CHARGINGSTATION_COMMUNICATION_FAILED.

Returns:

the Channel Value

_setChargingstationCommunicationFailed

default void _setChargingstationCommunicationFailed(boolean value)

Internal method to set the 'nextValue' on Evcs.ChannelId.CHARGINGSTATION_COMMUNICATION_FAILED Channel.

Parameters:

value - the next value

addCalculatePowerLimitListeners

static void addCalculatePowerLimitListeners(Evcs evcs)

Adds onSetNextValue listeners for minimum and maximum hardware power.

Since the minimum and maximum power strongly depends on the connected vehicle, this automatically adjusts it to the currently used phases.

Parameters:

evcs - evcs

getModbusSlaveNatureTable

static ModbusSlaveNatureTable getModbusSlaveNatureTable(AccessMode accessMode)

Used for Modbus/TCP Api Controller. Provides a Modbus table for the Channels of this Component.

Parameters:

accessMode - filters the Modbus-Records that should be shown

Returns:

the ModbusSlaveNatureTable