Package io.openems.edge.common.channel

Interface ChannelId

All Known Implementing Classes:
AbstractGpioChannel, AbstractManagedOcppEvcsComponent.ChannelId, AnalogOutput.ChannelId, AnalogVoltageOutput.ChannelId, AppManager.ChannelId, AsymmetricEss.ChannelId, Battery.ChannelId, BatteryFeneconCommercial.ChannelId, BatteryFeneconHome.ChannelId, BatteryInverterKacoBlueplanetGridsave.ChannelId, BatteryInverterRefuStore88k.ChannelId, BatteryInverterSinexcel.ChannelId, BatteryProtection.ChannelId, BatterySoltaroClusterVersionB.ChannelId, BatterySoltaroClusterVersionC.ChannelId, BatterySoltaroSingleRackVersionA.ChannelId, BatterySoltaroSingleRackVersionB.ChannelId, BatterySoltaroSingleRackVersionC.ChannelId, BmwBattery.ChannelId, BoschBpts5HybridCore.CoreChannelId, BoschBpts5HybridEss.ChannelId, BoschBpts5HybridMeter.ChannelId, BoschBpts5HybridMeterImpl.ChannelId, BoschBpts5HybridPv.ChannelId, BridgeMbus.ChannelId, BridgeModbus.ChannelId, BridgeModbusSerial.ChannelId, BridgeModbusTcp.ChannelId, BridgeOnewire.ChannelId, BydBatteryBoxCommercialC130.ChannelId, ChannelId.ChannelIdImpl, ComponentManager.ChannelId, Controller.ChannelId, ControllerApiBackend.ChannelId, ControllerApiModbusTcpReadOnly.ChannelId, ControllerApiModbusTcpReadWrite.ChannelId, ControllerApiMqtt.ChannelId, ControllerApiRestReadOnly.ChannelId, ControllerApiRestReadWrite.ChannelId, ControllerApiWebsocket.ChannelId, ControllerAsymmetricBalancingCosPhi.ChannelId, ControllerAsymmetricFixReactivePower.ChannelId, ControllerAsymmetricPeakShaving.ChannelId, ControllerAsymmetricPhaseRectification.ChannelId, ControllerChannelThreshold.ChannelId, ControllerChpSoc.ChannelId, ControllerDebugDetailedLog.ChannelId, ControllerDebugLog.ChannelId, ControllerEssAcIsland.ChannelId, ControllerEssActivePowerVoltageCharacteristic.ChannelId, ControllerEssBalancing.ChannelId, ControllerEssBalancingSchedule.ChannelId, ControllerEssCycle.ChannelId, ControllerEssDelayCharge.ChannelId, ControllerEssDelayedSellToGrid.ChannelId, ControllerEssEmergencyCapacityReserve.ChannelId, ControllerEssFixActivePower.ChannelId, ControllerEssFixReactivePower.ChannelId, ControllerEssGridOptimizedCharge.ChannelId, ControllerEssHybridSurplusFeedToGrid.ChannelId, ControllerEssLimitActivePower.ChannelId, ControllerEssLimitTotalDischarge.ChannelId, ControllerEssLinearPowerBand.ChannelId, ControllerEssMinimumDischargePower.ChannelId, ControllerEssPeakShaving.ChannelId, ControllerEssRandomPower.ChannelId, ControllerEssReactivePowerVoltageCharacteristic.ChannelId, ControllerEssSellToGridLimit.ChannelId, ControllerEssStandby.ChannelId, ControllerEssTimeslotPeakshaving.ChannelId, ControllerEvcs.ChannelId, ControllerEvcsFixActivePower.ChannelId, ControllerGenericJsonLogic.ChannelId, ControllerHighLoadTimeslot.ChannelId, ControllerIoAlarm.ChannelId, ControllerIoAnalog.ChannelId, ControllerIoChannelSingleThreshold.ChannelId, ControllerIoFixDigitalOutput.ChannelId, ControllerIoHeatingElement.ChannelId, ControllerIoHeatPumpSgReady.ChannelId, ControllerMrFundamentalFrequency.ChannelId, ControllerMrSetBalancing.ChannelId, ControllerPvInverterFixPowerLimit.ChannelId, ControllerPvInverterSellToGridLimit.ChannelId, Cycle.ChannelId, DigitalInput.ChannelId, DigitalOutput.ChannelId, DummyHybridEss.ChannelId, Edge2Edge.ChannelId, Edge2EdgeEss.ChannelId, ElectricityMeter.ChannelId, ErrorChannelId, ErrorCodeChannelId0, ErrorCodeChannelId1, EssAdstecStoraxe.ChannelId, EssCluster.ChannelId, EssDcCharger.ChannelId, EssFeneconBydContainer.ChannelId, EssFeneconBydContainerWatchdogController.ChannelId, EssFeneconCommercial40.ChannelId, EssFeneconCommercial40.InsufficientGridParametersChannelId, EssFeneconCommercial40.PowerDecreaseCausedByOvertemperatureChannelId, EssFeneconCommercial40.SystemErrorChannelId, EssFeneconCommercial40Pv.ChannelId, EssGenericManagedSymmetric.ChannelId, EssGenericOffGrid.ChannelId, EssPower.ChannelId, EssSmaSunnyIsland.ChannelId, Evcs.ChannelId, EvcsAlpitronicHypercharger.ChannelId, EvcsClusterPeakShaving.ChannelId, EvcsDezony.ChannelId, EvcsGoeChargerHome.ChannelId, EvcsHardyBarth.ChannelId, EvcsKebaKeContact.ChannelId, EvcsOcppAbl.ChannelId, EvcsOcppIesKeywattSingle.ChannelId, EvcsSpelsbergSmart.ChannelId, EvcsWebastoNext.ChannelId, EvcsWebastoUnite.ChannelId, FeneconDessCharger.ChannelId, FeneconDessEss.ChannelId, FeneconDessGridMeter.ChannelId, FeneconDessPvMeter.ChannelId, FeneconMiniEss.ChannelId, FeneconMiniEss.ServiceInfoChannelId, FeneconMiniEss.SystemErrorChannelId, FeneconMiniGridMeter.ChannelId, FeneconMiniPvMeter.ChannelId, FeneconProEss.ChannelId, FeneconProPvMeter.ChannelId, FieldbusChannelId, FieldbusChannelId, FixStateOfCharge.ChannelId, GenericManagedEss.ChannelId, GoodWe.ChannelId, GoodWeBatteryInverter.ChannelId, GoodWeCharger.ChannelId, GoodWeChargerTwoString.ChannelId, GoodWeEmergencyPowerMeter.ChannelId, GoodWeEss.ChannelId, GoodWeGridMeter.ChannelId, GridConChannelId, Host.ChannelId, HybridEss.ChannelId, HybridManagedSymmetricBatteryInverter.ChannelId, IoFilipowskiMrAo1.ChannelId, IoGpio.ChannelId, IoKmtronicRelay4Port.ChannelId, IoKmtronicRelay8Port.ChannelId, IoOffGridSwitch.ChannelId, IoRevolutionPiDigitalIo.ChannelId, IoShelly25.ChannelId, IoShelly3Em.ChannelId, IoShellyPlug.ChannelId, IoWago.ChannelId, IoWeidmuellerUr20.ChannelId, KacoBlueplanetHybrid10Charger.ChannelId, KacoBlueplanetHybrid10Core.ChannelId, KacoBlueplanetHybrid10Ess.ChannelId, KacoBlueplanetHybrid10GridMeter.ChannelId, KacoBlueplanetHybrid10PvInverter.ChannelId, KostalPikoCharger.ChannelId, KostalPikoCore.ChannelId, KostalPikoEss.ChannelId, KostalPikoGridMeter.ChannelId, ManagedAsymmetricEss.ChannelId, ManagedEvcs.ChannelId, ManagedSinglePhaseEss.ChannelId, ManagedSymmetricBatteryInverter.ChannelId, ManagedSymmetricEss.ChannelId, ManagedSymmetricPvInverter.ChannelId, MeasuringEvcs.ChannelId, Meta.ChannelId, MeterAbbB23.ChannelId, MeterArtemesAM2.ChannelId, MeterBControlEM300.ChannelId, MeterBgeTechDrt428M2.ChannelId, MeterCamillebauerAplus.ChannelId, MeterCarloGavazziEm300.ChannelId, MeterChannelId, MeterDiscovergy.ChannelId, MeterGridcon.ChannelId, MeterJanitzaUmg511.ChannelId, MeterJanitzaUmg604.ChannelId, MeterJanitzaUmg96rme.ChannelId, MeterKdk2puct.ChannelId, MeterMicrocareSdm630.ChannelId, MeterPlexlogDatalogger.ChannelId, MeterPqplusUmd96.ChannelId, MeterPqplusUmd97.ChannelId, MeterSchneiderActi9Smartlink.ChannelId, MeterSiemensPac1600.ChannelId, MeterSiemensPac2200.ChannelId, MeterSmaShm20.ChannelId, MeterSocomecSinglephase.ChannelId, MeterSocomecThreephase.ChannelId, MeterVirtualAdd.ChannelId, MeterWeidmueller525.ChannelId, MeterZiehlEfr4001Ip.ChannelId, ModbusComponent.ChannelId, ModbusTcpApi.ChannelId, MrGridconOngrid.ChannelId, MrGridconOnOffgrid.ChannelId, MyChannelId, MyChannelId, OffGridBatteryInverter.ChannelId, OffGridSwitch.ChannelId, OneWireThermometer.ChannelId, OpenemsComponent.ChannelId, PhoenixContactMeter.ChannelId, PredictorManager.ChannelId, PredictorPersistenceModel.ChannelId, PredictorSimilardayModel.ChannelId, PvInverterCluster.ChannelId, PvInverterFronius.ChannelId, PvInverterKacoBlueplanet.ChannelId, PvInverterKostal.ChannelId, PvInverterSmaSunnyTripower.ChannelId, PvInverterSolarlog.ChannelId, ReadChannelId, RestApi.ChannelId, Scheduler.ChannelId, SchedulerAllAlphabetically.ChannelId, SchedulerDaily.ChannelId, SchedulerFixedOrder.ChannelId, SimulatorApp.ChannelId, SimulatorBattery.ChannelId, SimulatorDatasourceCsvDirect.ChannelId, SimulatorDatasourceCsvPredefined.ChannelId, SimulatorDatasourceSingleDirect.ChannelId, SimulatorEssAsymmetricReacting.ChannelId, SimulatorEssSinglePhaseReacting.ChannelId, SimulatorEssSymmetricReacting.ChannelId, SimulatorEvcs.ChannelId, SimulatorGridMeterActing.ChannelId, SimulatorGridMeterReacting.ChannelId, SimulatorIoDigitalInputOutput.ChannelId, SimulatorModbus.ChannelId, SimulatorNrcMeterActing.ChannelId, SimulatorProductionMeterActing.ChannelId, SimulatorPvInverter.ChannelId, SimulatorThermometer.ChannelId, SimulatorTimedata.ChannelId, SinglePhaseEss.ChannelId, SinglePhaseMeter.ChannelId, SocEvcs.ChannelId, SocomecMeter.ChannelId, SolarEdgeGridMeter.ChannelId, SolarEdgePvInverter.ChannelId, SoltaroBatteryVersionC.ChannelId, SoltaroCluster.ChannelId, StartStoppable.ChannelId, Sum.ChannelId, SunSChannelId, SunSpecPvInverter.ChannelId, SymmetricBatteryInverter.ChannelId, SymmetricEss.ChannelId, TeslaPowerwall2Battery.ChannelId, TeslaPowerwall2Core.ChannelId, Thermometer.ChannelId, Timedata.ChannelId, TimedataInfluxDb.ChannelId, TimedataRrd4j.ChannelId, TimeOfUseTariffAwattar.ChannelId, TimeOfUseTariffController.ChannelId, TimeOfUseTariffCorrently.ChannelId, TimeOfUseTariffTibber.ChannelId, TouEntsoe.ChannelId, VirtualSubtractMeter.ChannelId, WriteChannelId
public interface ChannelId
A ChannelId defines a Channel. It provides a unique Name and and a Doc.

This interface is typically implemented by an Enum type which automatically provides a name() method.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final record 
    ChannelId.ChannelIdImpl
    The preferred way to define ChannelIds in OpenEMS Edge is via an enum that inherits ChannelId:

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    channelIdCamelToUpper(String name)
    Converts a Channel-ID in UPPER_CAMEL format to the UPPER_UNDERSCORE format.
    static String
    channelIdUpperToCamel(String name)
    Converts a Channel-ID in UPPER_UNDERSCORE format (like from an Enum) to the preferred UPPER_CAMEL format.
    Doc
    doc()
    Gets the Channel Doc for this ChannelId.
    default String
    id()
    Gets the name in CamelCase.
    String
    name()
    Gets the name in format CaseFormat.UPPER_UNDERSCORE.

  • Method Details

    • channelIdUpperToCamel

      static String channelIdUpperToCamel(String name)
      Converts a Channel-ID in UPPER_UNDERSCORE format (like from an Enum) to the preferred UPPER_CAMEL format.

      Examples: converts "ACTIVE_POWER" to "ActivePower".

      Special reserved Channel-IDs starting with "_" have a special handling: "_PROPERTY_ENABLED" is converted to "_PropertyEnabled".

      Parameters:
      name - a Channel-ID in UPPER_UNDERSCORE format
      Returns:
      the Channel-ID in UPPER_CAMEL format.

    • channelIdCamelToUpper

      static String channelIdCamelToUpper(String name)
      Converts a Channel-ID in UPPER_CAMEL format to the UPPER_UNDERSCORE format.

      Examples: converts "ActivePower" to "ACTIVE_POWER".

      Parameters:
      name - Channel-ID in UPPER_CAMEL format.
      Returns:
      the a Channel-ID in UPPER_UNDERSCORE format

    • name

      String name()
      Gets the name in format CaseFormat.UPPER_UNDERSCORE. This is available by default for an Enum.

      Names starting with underscore ("_") are reserved for internal usage.

      Returns:
      the name

    • id

      default String id()
      Gets the name in CamelCase.
      Returns:
      the Channel-ID in CamelCase

    • doc

      Doc doc()
      Gets the Channel Doc for this ChannelId.
      Returns:
      the Channel-Doc