io.openems.edge.timedata.influxdb

Class InfluxTimedataImpl

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.timedata.influxdb.InfluxTimedataImpl

All Implemented Interfaces:

CommonTimedataService, OpenemsComponent, Timedata, InfluxTimedata, org.osgi.service.event.EventHandler

public class InfluxTimedataImpl
extends AbstractOpenemsComponent
implements InfluxTimedata, Timedata, OpenemsComponent, org.osgi.service.event.EventHandler

Provides read and write access to InfluxDB.

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.timedata.influxdb.InfluxTimedata

InfluxTimedata.ChannelId

Field Summary

Fields

Modifier and Type	Field and Description
protected ComponentManager	componentManager

Constructor Summary

Constructors

Constructor and Description
InfluxTimedataImpl()

Method Summary

Modifier and Type	Method and Description
protected void	collectAndWriteChannelValues()
protected void	deactivate() Handles @Deactivate of implementations.
java.util.concurrent.CompletableFuture<java.util.Optional<java.lang.Object>>	getLatestValue(ChannelAddress channelAddress) Gets the latest known value for the given ChannelAddress.
void	handleEvent(org.osgi.service.event.Event event)
java.util.SortedMap<java.time.ZonedDateTime,java.util.SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricData(java.lang.String edgeId, java.time.ZonedDateTime fromDate, java.time.ZonedDateTime toDate, java.util.Set<ChannelAddress> channels, int resolution) Queries historic data.
java.util.SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryHistoricEnergy(java.lang.String edgeId, java.time.ZonedDateTime fromDate, java.time.ZonedDateTime toDate, java.util.Set<ChannelAddress> channels) Queries historic energy.
java.util.SortedMap<java.time.ZonedDateTime,java.util.SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricEnergyPerPeriod(java.lang.String edgeId, java.time.ZonedDateTime fromDate, java.time.ZonedDateTime toDate, java.util.Set<ChannelAddress> channels, int resolution) Queries historic energy per period.

Methods inherited from class io.openems.edge.common.component.AbstractOpenemsComponent

_channel, activate, addChannel, addChannels, addChannels, alias, channels, getComponentContext, id, isEnabled, logDebug, logError, logInfo, logWarn, modified, removeChannel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.openems.common.timedata.CommonTimedataService

calculateResolution, handleQueryHistoricTimeseriesExportXlxsRequest, queryHistoricData

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getModbusSlaveNatureTable, getState, getStateChannel, hasFaults, id, isEnabled, logDebug, logError, logInfo, logWarn, serviceFactoryPid, servicePid, updateConfigurationProperty, updateReferenceFilter

Field Detail

componentManager

protected ComponentManager componentManager

Constructor Detail

InfluxTimedataImpl

public InfluxTimedataImpl()

Method Detail

deactivate

protected void deactivate()

Description copied from class: AbstractOpenemsComponent

Handles @Deactivate of implementations. Prints log output.

Overrides:

deactivate in class AbstractOpenemsComponent

handleEvent

public void handleEvent(org.osgi.service.event.Event event)

Specified by:

handleEvent in interface org.osgi.service.event.EventHandler

collectAndWriteChannelValues

protected void collectAndWriteChannelValues()

queryHistoricData

public java.util.SortedMap<java.time.ZonedDateTime,java.util.SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricData(java.lang.String edgeId,
                                                                                                                                      java.time.ZonedDateTime fromDate,
                                                                                                                                      java.time.ZonedDateTime toDate,
                                                                                                                                      java.util.Set<ChannelAddress> channels,
                                                                                                                                      int resolution)
                                                                                                                               throws OpenemsError.OpenemsNamedException

Description copied from interface: CommonTimedataService

Queries historic data.

Specified by:

queryHistoricData in interface CommonTimedataService

Parameters:

edgeId - the Edge-ID; or null query all

fromDate - the From-Date

toDate - the To-Date

channels - the Channels

resolution - the Resolution in seconds

Throws:

OpenemsError.OpenemsNamedException

queryHistoricEnergy

public java.util.SortedMap<ChannelAddress,com.google.gson.JsonElement> queryHistoricEnergy(java.lang.String edgeId,
                                                                                           java.time.ZonedDateTime fromDate,
                                                                                           java.time.ZonedDateTime toDate,
                                                                                           java.util.Set<ChannelAddress> channels)
                                                                                    throws OpenemsError.OpenemsNamedException

Description copied from interface: CommonTimedataService

Queries historic energy.

Specified by:

queryHistoricEnergy in interface CommonTimedataService

Parameters:

edgeId - the Edge-ID; or null query all

fromDate - the From-Date

toDate - the To-Date

channels - the Channels

Throws:

OpenemsError.OpenemsNamedException

queryHistoricEnergyPerPeriod

public java.util.SortedMap<java.time.ZonedDateTime,java.util.SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricEnergyPerPeriod(java.lang.String edgeId,
                                                                                                                                                 java.time.ZonedDateTime fromDate,
                                                                                                                                                 java.time.ZonedDateTime toDate,
                                                                                                                                                 java.util.Set<ChannelAddress> channels,
                                                                                                                                                 int resolution)
                                                                                                                                          throws OpenemsError.OpenemsNamedException

Description copied from interface: CommonTimedataService

Queries historic energy per period.

This is for use-cases where you want to get the energy for each period (with length 'resolution') per Channel, e.g. to visualize energy in a histogram chart. For each period the energy is calculated by subtracting first value of the period from the last value of the period.

Specified by:

queryHistoricEnergyPerPeriod in interface CommonTimedataService

Parameters:

edgeId - the Edge-ID; or null query all

fromDate - the From-Date

toDate - the To-Date

channels - the Channels

resolution - the Resolution in seconds

Throws:

OpenemsError.OpenemsNamedException

getLatestValue

public java.util.concurrent.CompletableFuture<java.util.Optional<java.lang.Object>> getLatestValue(ChannelAddress channelAddress)

Description copied from interface: Timedata

Gets the latest known value for the given ChannelAddress.

Specified by:

getLatestValue in interface Timedata

Parameters:

channelAddress - the ChannelAddress to be queried

Returns:

the latest known value or Empty