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

Interface ModbusComponent

All Superinterfaces:

OpenemsComponent

All Known Subinterfaces:

MeterPqplusUmd96, MeterPqplusUmd97, PlexlogDatalogger, SiemensPacMeter, SunnyIslandEss

All Known Implementing Classes:

AbstractEdge2Edge, AbstractEssDcChargerFeneconCommercial40, AbstractFeneconDessCharger, AbstractGoodWe, AbstractGoodWeEtCharger, AbstractKmtronicRelay, AbstractOpenemsModbusComponent, AbstractOpenemsSunSpecComponent, AbstractSocomecMeter, AbstractSunSpecBatteryInverter, AbstractSunSpecMeter, AbstractSunSpecPvInverter, AdstecStoraxeEssImpl, BatteryBoxC130Impl, BmwBatteryImpl, ClusterVersionB, ClusterVersionCImpl, Edge2EdgeEssImpl, EssDcChargerFeneconCommercial40Pv1Impl, EssDcChargerFeneconCommercial40Pv2Impl, EssFeneconBydContainer, EssFeneconCommercial40Impl, EvcsWebastoNextImpl, FeneconCommercialBatteryImpl, FeneconDessCharger1, FeneconDessCharger2, FeneconDessEssImpl, FeneconDessGridMeterImpl, FeneconDessPvMeterImpl, FeneconHomeBatteryImpl, FeneconMiniEssImpl, FeneconMiniGridMeterImpl, FeneconMiniPvMeterImpl, FeneconProEssImpl, FeneconProPvMeter, FroniusPvInverter, GoodWeBatteryInverterImpl, GoodWeEmergencyPowerMeterImpl, GoodWeEssImpl, GoodWeEtCharger1, GoodWeEtCharger2, GoodWeGridMeterImpl, GridconPcsImpl, HyperchargerImpl, KacoBlueplanet, KacoBlueplanetGridsaveImpl, KmtronicRelay4PortImpl, KmtronicRelay8PortImpl, KostalPvInverter, MeterArtemesAM2, MeterBControlEM300Impl, MeterBgeTechDrt428M2Impl, MeterCarloGavazziEm300Impl, MeterJanitzaUmg511Impl, MeterJanitzaUmg604Impl, MeterJanitzaUmg96rme, MeterKdk2puctImpl, MeterMicrocareSdm630Impl, MeterPqplusUmd96Impl, MeterPqplusUmd97Impl, MeterSchneiderActi9Smartlink, MeterSmaShm20Impl, MeterWeidmueller525, MeterZiehlEfr4001IpImpl, PlexlogDataloggerImpl, RefuStore88kImpl, SiemensPacMeterImpl, SinexcelImpl, SingleRack, SingleRackVersionBImpl, SingleRackVersionCImpl, SmaPvInverter, SocomecMeterSinglephaseImpl, SocomecMeterThreephaseImpl, SolarEdgeGridMeter, SolarEdgePvInverter, SolarLogImpl, SunnyIslandEssImpl, Wago, WebastoImpl, WeidmuellerUR20Impl

@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 class	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 Value<java.lang.Boolean>	getModbusCommunicationFailed()	Gets the Modbus Communication Failed State.
default StateChannel	getModbusCommunicationFailedChannel()	Gets the Channel for ModbusComponent.ChannelId.MODBUS_COMMUNICATION_FAILED.

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

getModbusCommunicationFailedChannel

default StateChannel getModbusCommunicationFailedChannel()

Gets the Channel for ModbusComponent.ChannelId.MODBUS_COMMUNICATION_FAILED.

Returns:

the Channel

getModbusCommunicationFailed

default Value<java.lang.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