io.openems.edge.common.channel

Interface ChannelId

All Known Implementing Classes:

AbstractFeneconDessCharger.ChannelId, AbstractOcppEvcsComponent.ChannelId, AbstractPredictiveDelayCharge.ChannelId, AcIsland.ChannelId, AllAlphabeticallyScheduler.ChannelId, AsymmetricEss.ChannelId, AsymmetricFixActivePower.ChannelId, AsymmetricFixReactivePower.ChannelId, AsymmetricMeter.ChannelId, BackendApi.ChannelId, Balancing.ChannelId, BalancingSchedule.ChannelId, Battery.ChannelId, BatteryBoxC130.ChannelId, BmwBattery.BMWChannelId, BridgeMbus.ChannelId, BridgeModbus.ChannelId, BridgeModbusSerialImpl.ChannelId, BridgeModbusTcpImpl.ChannelId, BridgeOnewire.ChannelId, BydContainerWatchdog.ChannelId, ChannelId, ChannelIdImpl, ChannelSingleThreshold.ChannelId, ChannelThreshold.ChannelId, ClusterVersionBChannelId, ClusterVersionC.ChannelId, ComponentManager.ChannelId, Controller.ChannelId, ControllerChpSoc.ChannelId, ControllerHeatingElement.ChannelId, CosPhi.ChannelId, Cycle.ChannelId, DailyScheduler.ChannelId, DebugDetailedLog.ChannelId, DebugLog.ChannelId, DelayChargeController.ChannelId, DelayedSellToGrid.ChannelId, DigitalInput.ChannelId, DigitalOutput.ChannelId, DummyHybridEss.ChannelId, DummyInputOutput.ChannelId, ErrorCodeChannelId0, ErrorCodeChannelId1, EssAsymmetric.ChannelId, EssChannelId, EssCluster.ChannelId, EssDcCharger.ChannelId, EssDcChargerFeneconCommercial40.ChannelId, EssFeneconBydContainer.ChannelId, EssFeneconCommercial40Impl.ChannelId, EssKacoBlueplanetGridsave50.ChannelId, EssOneFullCycle.ChannelId, EssSellToGridLimit.ChannelId, EssSinexcel.ChannelId, EssSinglePhase.ChannelId, EssSymmetric.ChannelId, Evcs.ChannelId, EvcsController.ChannelId, EvcsFixActivePower.ChannelId, FeneconDessEss.ChannelId, FeneconDessGridMeter.ChannelId, FeneconDessPvMeter.ChannelId, FeneconMiniEss.ChannelId, FeneconMiniGridMeter.ChannelId, FeneconMiniPvMeter.ChannelId, FeneconProPvMeter.ChannelId, FieldbusChannelId, FixDigitalOutput.ChannelId, FixedOrderScheduler.ChannelId, GenericManagedSymmetricEss.ChannelId, GridConChannelId, GridMeter.ChannelId, GridMeter.ChannelId, GridMeterChannelId, HighLoadTimeslot.ChannelId, Host.ChannelId, HybridEss.ChannelId, InfluxTimedata.ChannelId, IoAlarm.ChannelId, JsonLogicController.ChannelId, KacoBlueplanetGridsave.ChannelId, KebaChannelId, KostalPikoCharger.ThisChannelId, KostalPikoCore.ChannelId, KostalPikoEss.ThisChannelId, KostalPikoGridMeter.ThisChannelId, LimitTotalDischargeController.ChannelId, ManagedAsymmetricEss.ChannelId, ManagedEvcs.ChannelId, ManagedSinglePhaseEss.ChannelId, ManagedSymmetricBatteryInverter.ChannelId, ManagedSymmetricEss.ChannelId, ManagedSymmetricPvInverter.ChannelId, MeasuringEvcs.ChannelId, Meta.ChannelId, MeterAbbB23Mbus.ChannelId, MeterArtemesAM2.ChannelId, MeterBControlEM300.ChannelId, MeterCarloGavazziEm300.ChannelId, MeterCarloGavazziEm300Impl.ChannelId, MeterChannelId, MeterDiscovergy.ChannelId, MeterJanitzaUmg604.ChannelId, MeterJanitzaUmg96rme.ChannelId, MeterMicrocareSdm630.ChannelId, MeterPqplusUmd97.ChannelId, MinDischargePeriod.ChannelId, ModbusSimulator.ChannelId, ModbusTcpApi.ChannelId, ModbusTcpApiReadOnly.ChannelId, ModbusTcpApiReadWrite.ChannelId, MyChannelId, MyChannelId, NrcMeter.ChannelId, OpenemsComponent.ChannelId, PeakShaving.ChannelId, PeakShaving.ChannelId, PhaseRectification.ChannelId, PowerComponent.ChannelId, PredictorChannelId, ProChannelId, ProductionMeter.ChannelId, PvChannelId, PvInverter.ChannelId, PvInverterCluster.ChannelId, PvInverterFixPowerLimit.ChannelId, PvInverterSellToGridLimit.ChannelId, ReactivePowerVoltageCharacteristic.ChannelId, RefuEss.ChannelId, RefuStore88k.ChannelId, RefuStore88kChannelId, RestApi.ChannelId, RestApiReadOnly.ChannelId, RestApiReadWrite.ChannelId, RevPiDioChannelId, Rrd4jTimedata.ChannelId, Scheduler.ChannelId, Shelly25.ChannelId, ShellyPlug.ChannelId, SiChannelId, SimulatedEvcs.ChannelId, SimulatorApp.ChannelId, SimulatorTimedata.ChannelId, SinglePhaseEss.ChannelId, SinglePhaseMeter.ChannelId, SingleRack.ChannelId, SingleRackVersionB.ChannelId, SingleRackVersionC.ChannelId, SocEvcs.ChannelId, SocomecMeter.ChannelId, SocomecMeterSinglephase.ChannelId, SocomecMeterThreephase.ChannelId, SolarLog.ChannelId, SoltaroBatteryVersionC.ChannelId, SoltaroCluster.ChannelId, StartStoppable.ChannelId, StrtsctrChannelId, Sum.ChannelId, SunSChannelId, SunSpecPvInverter.ChannelId, SurplusFeedInController.ChannelId, SurplusFeedToGridController.ChannelId, SymmetricBatteryInverter.ChannelId, SymmetricEss.ChannelId, SymmetricFixActivePower.ChannelId, SymmetricFixReactivePower.ChannelId, SymmetricLimitActivePower.ChannelId, SymmetricLinearPowerBand.ChannelId, SymmetricMeter.ChannelId, SymmetricRandomPower.ChannelId, TeslaPowerwall2Battery.ChannelId, TeslaPowerwall2Core.CoreChannelId, Thermometer.ChannelId, ThisChannelId, ThisChannelId, Timedata.ChannelId, TimeslotPeakshaving.ChannelId, Wago.ThisChannelId, WebsocketApi.ChannelId, WeidmuellerChannelId

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.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	channelIdUpperToCamel(java.lang.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 java.lang.String	id() Gets the name in CamelCase.
java.lang.String	name() Gets the name in format CaseFormat.UPPER_UNDERSCORE.

Method Detail

channelIdUpperToCamel

static java.lang.String channelIdUpperToCamel(java.lang.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.

name

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