Package io.openems.edge.evcs.api
Interface Evcs
-
- All Superinterfaces:
OpenemsComponent
- All Known Subinterfaces:
ManagedEvcs
,MeasuringEvcs
,SocEvcs
- All Known Implementing Classes:
Abl
,AbstractEvcsCluster
,AbstractOcppEvcsComponent
,DummyManagedEvcs
,EvcsClusterPeakShaving
,EvcsClusterSelfConsumption
,HardyBarthImpl
,IesKeywattSingleCcs
,KebaKeContact
,SimulatedEvcs
public interface Evcs extends OpenemsComponent
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Evcs.ChannelId
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default void
_setActiveConsumptionEnergy(long value)
Internal method to set the 'nextValue' onEvcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY
Channel.default void
_setActiveConsumptionEnergy(java.lang.Long value)
Internal method to set the 'nextValue' onEvcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY
Channel.default void
_setChargePower(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.CHARGE_POWER
Channel.default void
_setChargePower(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.CHARGE_POWER
Channel.default void
_setChargingstationCommunicationFailed(boolean value)
Internal method to set the 'nextValue' onEvcs.ChannelId.CHARGINGSTATION_COMMUNICATION_FAILED
Channel.default void
_setChargingType(ChargingType value)
Internal method to set the 'nextValue' onEvcs.ChannelId.CHARGING_TYPE
Channel.default void
_setEnergySession(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.ENERGY_SESSION
Channel.default void
_setEnergySession(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.ENERGY_SESSION
Channel.default void
_setMaximumHardwarePower(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MAXIMUM_HARDWARE_POWER
Channel.default void
_setMaximumHardwarePower(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MAXIMUM_HARDWARE_POWER
Channel.default void
_setMaximumPower(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MAXIMUM_POWER
Channel.default void
_setMaximumPower(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MAXIMUM_POWER
Channel.default void
_setMinimumHardwarePower(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MINIMUM_HARDWARE_POWER
Channel.default void
_setMinimumHardwarePower(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MINIMUM_HARDWARE_POWER
Channel.default void
_setMinimumPower(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MINIMUM_POWER
Channel.default void
_setMinimumPower(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MINIMUM_POWER
Channel.default void
_setPhases(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.PHASES
Channel.default void
_setPhases(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.PHASES
Channel.default void
_setStatus(Status value)
Internal method to set the 'nextValue' onEvcs.ChannelId.STATUS
Channel.default Value<java.lang.Long>
getActiveConsumptionEnergy()
Gets the Active Consumption Energy in [Wh].default LongReadChannel
getActiveConsumptionEnergyChannel()
Gets the Channel forEvcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY
.default Value<java.lang.Integer>
getChargePower()
Gets the Charge Power in [W].default IntegerReadChannel
getChargePowerChannel()
Gets the Channel forEvcs.ChannelId.CHARGE_POWER
.default Value<java.lang.Boolean>
getChargingstationCommunicationFailed()
Gets the Failed state channel for a failed communication to the EVCS.default StateChannel
getChargingstationCommunicationFailedChannel()
Gets the Channel forEvcs.ChannelId.CHARGINGSTATION_COMMUNICATION_FAILED
.default ChargingType
getChargingType()
Gets the Type of charging.default Channel<ChargingType>
getChargingTypeChannel()
Gets the Channel forEvcs.ChannelId.CHARGING_TYPE
.default Value<java.lang.Integer>
getEnergySession()
Gets the Energy that was charged during the current or last Session in [Wh].default IntegerReadChannel
getEnergySessionChannel()
Gets the Channel forEvcs.ChannelId.ENERGY_SESSION
.default Value<java.lang.Integer>
getMaximumHardwarePower()
Gets the Maximum Power valid by the hardware in [W].default IntegerReadChannel
getMaximumHardwarePowerChannel()
Gets the Channel forEvcs.ChannelId.MAXIMUM_HARDWARE_POWER
.default Value<java.lang.Integer>
getMaximumPower()
Gets the Maximum Power valid by software in [W].default IntegerReadChannel
getMaximumPowerChannel()
Gets the Channel forEvcs.ChannelId.MAXIMUM_POWER
.default Value<java.lang.Integer>
getMinimumHardwarePower()
Gets the Minimum Power valid by the hardware in [W].default IntegerReadChannel
getMinimumHardwarePowerChannel()
Gets the Channel forEvcs.ChannelId.MINIMUM_HARDWARE_POWER
.default Value<java.lang.Integer>
getMinimumPower()
Gets the Minimum Power valid by software in [W].default IntegerReadChannel
getMinimumPowerChannel()
Gets the Channel forEvcs.ChannelId.MINIMUM_POWER
.static ModbusSlaveNatureTable
getModbusSlaveNatureTable(AccessMode accessMode)
Returns the modbus table for this nature.default Value<java.lang.Integer>
getPhases()
Gets the Count of phases, the EV is charging with.default IntegerReadChannel
getPhasesChannel()
Gets the Channel forEvcs.ChannelId.PHASES
.default Status
getStatus()
Gets the Status of the EVCS charging station.default Channel<Status>
getStatusChannel()
Gets the Channel forEvcs.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
-
-
-
-
Method Detail
-
getStatusChannel
default Channel<Status> getStatusChannel()
Gets the Channel forEvcs.ChannelId.STATUS
.- Returns:
- the Channel
-
getStatus
default Status getStatus()
Gets the Status of the EVCS charging station. SeeEvcs.ChannelId.STATUS
.- Returns:
- the Channel
Value
-
_setStatus
default void _setStatus(Status value)
Internal method to set the 'nextValue' onEvcs.ChannelId.STATUS
Channel.- Parameters:
value
- the next value
-
getChargePowerChannel
default IntegerReadChannel getChargePowerChannel()
Gets the Channel forEvcs.ChannelId.CHARGE_POWER
.- Returns:
- the Channel
-
getChargePower
default Value<java.lang.Integer> getChargePower()
Gets the Charge Power in [W]. SeeEvcs.ChannelId.CHARGE_POWER
.- Returns:
- the Channel
Value
-
_setChargePower
default void _setChargePower(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.CHARGE_POWER
Channel.- Parameters:
value
- the next value
-
_setChargePower
default void _setChargePower(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.CHARGE_POWER
Channel.- Parameters:
value
- the next value
-
getChargingTypeChannel
default Channel<ChargingType> getChargingTypeChannel()
Gets the Channel forEvcs.ChannelId.CHARGING_TYPE
.- Returns:
- the Channel
-
getChargingType
default ChargingType getChargingType()
Gets the Type of charging. SeeEvcs.ChannelId.CHARGING_TYPE
.- Returns:
- the Channel
Value
-
_setChargingType
default void _setChargingType(ChargingType value)
Internal method to set the 'nextValue' onEvcs.ChannelId.CHARGING_TYPE
Channel.- Parameters:
value
- the next value
-
getPhasesChannel
default IntegerReadChannel getPhasesChannel()
Gets the Channel forEvcs.ChannelId.PHASES
.- Returns:
- the Channel
-
getPhases
default Value<java.lang.Integer> getPhases()
Gets the Count of phases, the EV is charging with. SeeEvcs.ChannelId.PHASES
.- Returns:
- the Channel
Value
-
_setPhases
default void _setPhases(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.PHASES
Channel.- Parameters:
value
- the next value
-
_setPhases
default void _setPhases(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.PHASES
Channel.- Parameters:
value
- the next value
-
getMinimumHardwarePowerChannel
default IntegerReadChannel getMinimumHardwarePowerChannel()
Gets the Channel forEvcs.ChannelId.MINIMUM_HARDWARE_POWER
.- Returns:
- the Channel
-
getMinimumHardwarePower
default Value<java.lang.Integer> getMinimumHardwarePower()
Gets the Minimum Power valid by the hardware in [W]. SeeEvcs.ChannelId.MINIMUM_HARDWARE_POWER
.- Returns:
- the Channel
Value
-
_setMinimumHardwarePower
default void _setMinimumHardwarePower(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MINIMUM_HARDWARE_POWER
Channel.- Parameters:
value
- the next value
-
_setMinimumHardwarePower
default void _setMinimumHardwarePower(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MINIMUM_HARDWARE_POWER
Channel.- Parameters:
value
- the next value
-
getMaximumHardwarePowerChannel
default IntegerReadChannel getMaximumHardwarePowerChannel()
Gets the Channel forEvcs.ChannelId.MAXIMUM_HARDWARE_POWER
.- Returns:
- the Channel
-
getMaximumHardwarePower
default Value<java.lang.Integer> getMaximumHardwarePower()
Gets the Maximum Power valid by the hardware in [W]. SeeEvcs.ChannelId.MAXIMUM_HARDWARE_POWER
.- Returns:
- the Channel
Value
-
_setMaximumHardwarePower
default void _setMaximumHardwarePower(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MAXIMUM_HARDWARE_POWER
Channel.- Parameters:
value
- the next value
-
_setMaximumHardwarePower
default void _setMaximumHardwarePower(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MAXIMUM_HARDWARE_POWER
Channel.- Parameters:
value
- the next value
-
getMaximumPowerChannel
default IntegerReadChannel getMaximumPowerChannel()
Gets the Channel forEvcs.ChannelId.MAXIMUM_POWER
.- Returns:
- the Channel
-
getMaximumPower
default Value<java.lang.Integer> getMaximumPower()
Gets the Maximum Power valid by software in [W]. SeeEvcs.ChannelId.MAXIMUM_POWER
.- Returns:
- the Channel
Value
-
_setMaximumPower
default void _setMaximumPower(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MAXIMUM_POWER
Channel.- Parameters:
value
- the next value
-
_setMaximumPower
default void _setMaximumPower(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MAXIMUM_POWER
Channel.- Parameters:
value
- the next value
-
getMinimumPowerChannel
default IntegerReadChannel getMinimumPowerChannel()
Gets the Channel forEvcs.ChannelId.MINIMUM_POWER
.- Returns:
- the Channel
-
getMinimumPower
default Value<java.lang.Integer> getMinimumPower()
Gets the Minimum Power valid by software in [W]. SeeEvcs.ChannelId.MINIMUM_POWER
.- Returns:
- the Channel
Value
-
_setMinimumPower
default void _setMinimumPower(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MINIMUM_POWER
Channel.- Parameters:
value
- the next value
-
_setMinimumPower
default void _setMinimumPower(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.MINIMUM_POWER
Channel.- Parameters:
value
- the next value
-
getEnergySessionChannel
default IntegerReadChannel getEnergySessionChannel()
Gets the Channel forEvcs.ChannelId.ENERGY_SESSION
.- Returns:
- the Channel
-
getEnergySession
default Value<java.lang.Integer> getEnergySession()
Gets the Energy that was charged during the current or last Session in [Wh]. SeeEvcs.ChannelId.ENERGY_SESSION
.- Returns:
- the Channel
Value
-
_setEnergySession
default void _setEnergySession(java.lang.Integer value)
Internal method to set the 'nextValue' onEvcs.ChannelId.ENERGY_SESSION
Channel.- Parameters:
value
- the next value
-
_setEnergySession
default void _setEnergySession(int value)
Internal method to set the 'nextValue' onEvcs.ChannelId.ENERGY_SESSION
Channel.- Parameters:
value
- the next value
-
getActiveConsumptionEnergyChannel
default LongReadChannel getActiveConsumptionEnergyChannel()
Gets the Channel forEvcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY
.- Returns:
- the Channel
-
getActiveConsumptionEnergy
default Value<java.lang.Long> getActiveConsumptionEnergy()
Gets the Active Consumption Energy in [Wh]. This relates to negative ACTIVE_POWER. SeeEvcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY
.- Returns:
- the Channel
Value
-
_setActiveConsumptionEnergy
default void _setActiveConsumptionEnergy(java.lang.Long value)
Internal method to set the 'nextValue' onEvcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY
Channel.- Parameters:
value
- the next value
-
_setActiveConsumptionEnergy
default void _setActiveConsumptionEnergy(long value)
Internal method to set the 'nextValue' onEvcs.ChannelId.ACTIVE_CONSUMPTION_ENERGY
Channel.- Parameters:
value
- the next value
-
getChargingstationCommunicationFailedChannel
default StateChannel getChargingstationCommunicationFailedChannel()
Gets the Channel forEvcs.ChannelId.CHARGINGSTATION_COMMUNICATION_FAILED
.- Returns:
- the Channel
-
getChargingstationCommunicationFailed
default Value<java.lang.Boolean> getChargingstationCommunicationFailed()
Gets the Failed state channel for a failed communication to the EVCS. SeeEvcs.ChannelId.CHARGINGSTATION_COMMUNICATION_FAILED
.- Returns:
- the Channel
Value
-
_setChargingstationCommunicationFailed
default void _setChargingstationCommunicationFailed(boolean value)
Internal method to set the 'nextValue' onEvcs.ChannelId.CHARGINGSTATION_COMMUNICATION_FAILED
Channel.- Parameters:
value
- the next value
-
getModbusSlaveNatureTable
static ModbusSlaveNatureTable getModbusSlaveNatureTable(AccessMode accessMode)
Returns the modbus table for this nature.- Parameters:
accessMode
- accessMode- Returns:
- nature table
-
-