Package io.openems.edge.bridge.modbus.api

Interface ModbusComponent

All Superinterfaces:

OpenemsComponent

All Known Subinterfaces:

BatteryFeneconHome, BatterySoltaroClusterVersionB, BatterySoltaroSingleRackVersionA, EssFeneconBydContainer, EssSmaSunnyIsland, FeneconProPvMeter, IoWago, MeterArtemesAM2, MeterJanitzaUmg96rme, MeterPlexlogDatalogger, MeterPqplusUmd96, MeterPqplusUmd97, MeterSchneiderActi9Smartlink, MeterSiemens, MeterWeidmueller525, PvInverterFronius, PvInverterKacoBlueplanet, PvInverterKostal, PvInverterSmaSunnyTripower, SolarEdgeGridMeter, SolarEdgePvInverter

All Known Implementing Classes:

AbstractEdge2Edge, AbstractEssFeneconCommercial40Pv, AbstractFeneconDessCharger, AbstractGoodWe, AbstractGoodWeEtCharger, AbstractKmtronicRelay, AbstractOpenemsModbusComponent, AbstractOpenemsSunSpecComponent, AbstractSocomecMeter, AbstractSunSpecBatteryInverter, AbstractSunSpecMeter, AbstractSunSpecPvInverter, BatteryFeneconCommercialImpl, BatteryFeneconHomeImpl, BatteryInverterKacoBlueplanetGridsaveImpl, BatteryInverterRefuStore88kImpl, BatteryInverterSinexcelImpl, BatterySoltaroClusterVersionBImpl, BatterySoltaroClusterVersionCImpl, BatterySoltaroSingleRackVersionAImpl, BatterySoltaroSingleRackVersionBImpl, BatterySoltaroSingleRackVersionCImpl, BmwBatteryImpl, BydBatteryBoxCommercialC130Impl, Edge2EdgeEssImpl, EssAdstecStoraxeImpl, EssFeneconBydContainerImpl, EssFeneconCommercial40Impl, EssFeneconCommercial40Pv1Impl, EssFeneconCommercial40Pv2Impl, EssSmaSunnyIslandImpl, EvcsAlpitronicHyperchargerImpl, EvcsWebastoNextImpl, EvcsWebastoUniteImpl, FeneconDessCharger1, FeneconDessCharger2, FeneconDessEssImpl, FeneconDessGridMeterImpl, FeneconDessPvMeterImpl, FeneconMiniEssImpl, FeneconMiniGridMeterImpl, FeneconMiniPvMeterImpl, FeneconProEssImpl, FeneconProPvMeterImpl, GoodWeBatteryInverterImpl, GoodWeChargerPv1, GoodWeChargerPv2, GoodWeChargerTwoStringImpl, GoodWeEmergencyPowerMeterImpl, GoodWeEssImpl, GoodWeGridMeterImpl, GridconPcsImpl, IoKmtronicRelay4PortImpl, IoKmtronicRelay8PortImpl, IoWagoImpl, IoWeidmuellerUr20Impl, MeterArtemesAM2Impl, MeterBControlEM300Impl, MeterBgeTechDrt428M2Impl, MeterCarloGavazziEm300Impl, MeterJanitzaUmg511Impl, MeterJanitzaUmg604Impl, MeterJanitzaUmg96rmeImpl, MeterKdk2puctImpl, MeterMicrocareSdm630Impl, MeterPlexlogDataloggerImpl, MeterPqplusUmd96Impl, MeterPqplusUmd97Impl, MeterSchneiderActi9SmartlinkImpl, MeterSiemensImpl, MeterSmaShm20Impl, MeterSocomecSinglephaseImpl, MeterSocomecThreephaseImpl, MeterWeidmueller525Impl, MeterZiehlEfr4001IpImpl, PhoenixContactMeterImpl, PvInverterFroniusImpl, PvInverterKacoBlueplanetImpl, PvInverterKostalImpl, PvInverterSmaSunnyTripowerImpl, PvInverterSolarlogImpl, SolarEdgeGridMeterImpl, SolarEdgePvInverterImpl

@ProviderType
public interface ModbusComponent
extends OpenemsComponent

A OpenEMS Component that uses Modbus communication.

Classes implementing this interface typically inherit AbstractOpenemsModbusComponent.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ModbusComponent.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setModbusCommunicationFailed(boolean value)	Internal method to set the 'nextValue' on ModbusComponent.ChannelId.MODBUS_COMMUNICATION_FAILED Channel.
default boolean	getModbusCommunicationFailed()	Gets the Modbus Communication Failed State.
default StateChannel	getModbusCommunicationFailedChannel()	Gets the Channel for ModbusComponent.ChannelId.MODBUS_COMMUNICATION_FAILED.
void	retryModbusCommunication()	The Modbus Bridge marks defective Components, e.g.

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 Details

getModbusCommunicationFailedChannel

default StateChannel getModbusCommunicationFailedChannel()

Gets the Channel for ModbusComponent.ChannelId.MODBUS_COMMUNICATION_FAILED.

Returns:

the Channel

getModbusCommunicationFailed

default boolean getModbusCommunicationFailed()

Gets the Modbus Communication Failed State. See ModbusComponent.ChannelId.MODBUS_COMMUNICATION_FAILED.

Returns:

the Channel Value

_setModbusCommunicationFailed

default void _setModbusCommunicationFailed(boolean value)

Internal method to set the 'nextValue' on ModbusComponent.ChannelId.MODBUS_COMMUNICATION_FAILED Channel.

Parameters:

value - the next value

retryModbusCommunication

void retryModbusCommunication()

The Modbus Bridge marks defective Components, e.g. if there are communication failures. If a component is marked as defective, reads and writes are paused for an increasing waiting time. This method resets the waiting time, causing the Modbus Bridge to retry if a Component is not anymore defective.

Use this method if there is good reason that a Modbus Component should be available again 'now', e.g. because it was turned on manually.