Package io.openems.backend.timedata.influx

Class TimedataInfluxDb

java.lang.Object

io.openems.backend.common.component.AbstractOpenemsBackendComponent

io.openems.backend.timedata.influx.TimedataInfluxDb

All Implemented Interfaces:

DebugLoggable, BackendTimedata, Timedata, CommonTimedataService, org.osgi.service.event.EventHandler

public class TimedataInfluxDb
extends AbstractOpenemsBackendComponent
implements Timedata, org.osgi.service.event.EventHandler, DebugLoggable

Field Summary

Fields

Modifier and Type	Field	Description
protected Metadata	metadata

Constructor Summary

Constructors

Constructor	Description
TimedataInfluxDb()

Method Summary

Modifier and Type	Method	Description
String	debugLog()	Gets some output that is suitable for a continuous Debug log.
Map<String,com.google.gson.JsonElement>	debugMetrics()	Gets some output that is suitable for a debug metrics to write down as Timedata.
void	handleEvent(org.osgi.service.event.Event event)
String	id()	Returns a unique ID for this OpenEMS component.
protected static boolean	isAllowed(String channelAddress)
protected void	logInfo(org.slf4j.Logger log, String message)	Log an info message including the Component ID.
protected void	logWarn(org.slf4j.Logger log, String message)	Log a warn message including the Component ID.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricData(String edgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)	Queries historic data.
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryHistoricEnergy(String edgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels)	Queries historic energy.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricEnergyPerPeriod(String edgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution)	Queries historic energy per period.
void	write(String edgeId, AggregatedDataNotification notification)	Sends the data points to the Timedata service.
void	write(String edgeId, ResendDataNotification data)	Sends the data points to the Timedata service.
void	write(String edgeId, TimestampedDataNotification notification)	Sends the data points to the Timedata service.

Methods inherited from class io.openems.backend.common.component.AbstractOpenemsBackendComponent

getName, logDebug, logDebug, logError, logError, logInfo, logWarn

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.backend.common.timedata.BackendTimedata

queryFirstValueBefore

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

handleQueryHistoricTimeseriesExportXlxsRequest, queryHistoricData

Field Details

metadata

protected volatile Metadata metadata

Constructor Details

TimedataInfluxDb

public TimedataInfluxDb()

Method Details

handleEvent

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

Specified by:

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

write

public void write(String edgeId,
 TimestampedDataNotification notification)

Description copied from interface: BackendTimedata

Sends the data points to the Timedata service.

Specified by:

write in interface BackendTimedata

Parameters:

edgeId - The unique Edge-ID

notification - Table of timestamp (epoch in milliseconds), Channel-Address and the Channel value as JsonElement. Sorted by timestamp.

write

public void write(String edgeId,
 AggregatedDataNotification notification)

Description copied from interface: BackendTimedata

Sends the data points to the Timedata service.

Specified by:

write in interface BackendTimedata

Parameters:

edgeId - The unique Edge-ID

notification - Table of timestamp (epoch in milliseconds), Channel-Address and the Channel value as AggregatedData. Sorted by timestamp.

write

public void write(String edgeId,
 ResendDataNotification data)

Description copied from interface: BackendTimedata

Sends the data points to the Timedata service.

Specified by:

write in interface BackendTimedata

Parameters:

edgeId - The unique Edge-ID

data - Table of timestamp (epoch in milliseconds), Channel-Address and the Channel value as ResendData. Sorted by timestamp.

queryHistoricData

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricData(String edgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution 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

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException

queryHistoricEnergy

public SortedMap<ChannelAddress,com.google.gson.JsonElement> queryHistoricEnergy(String edgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 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

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException

queryHistoricEnergyPerPeriod

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricEnergyPerPeriod(String edgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution 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 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

Returns:

the query result; possibly null

Throws:

OpenemsError.OpenemsNamedException

logInfo

protected void logInfo(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractOpenemsBackendComponent

Log an info message including the Component ID.

Overrides:

logInfo in class AbstractOpenemsBackendComponent

Parameters:

log - the Logger that is used for writing the log

message - the Info-message

logWarn

protected void logWarn(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractOpenemsBackendComponent

Log a warn message including the Component ID.

Overrides:

logWarn in class AbstractOpenemsBackendComponent

Parameters:

log - the Logger that is used for writing the log

message - the Warn-message

id

public String id()

Description copied from interface: Timedata

Returns a unique ID for this OpenEMS component.

Specified by:

id in interface Timedata

Returns:

the unique ID

isAllowed

protected static boolean isAllowed(String channelAddress)

debugLog

public String debugLog()

Description copied from interface: DebugLoggable

Gets some output that is suitable for a continuous Debug log.

Specified by:

debugLog in interface DebugLoggable

Returns:

the debug log output; null for no log

debugMetrics

public Map<String,com.google.gson.JsonElement> debugMetrics()

Description copied from interface: DebugLoggable

Gets some output that is suitable for a debug metrics to write down as Timedata.

Specified by:

debugMetrics in interface DebugLoggable

Returns:

the key value entries to write down; null or emptyMap for no metrics