Package io.openems.shared.influxdb

Class InfluxConnector

java.lang.Object

io.openems.shared.influxdb.InfluxConnector

public class InfluxConnector
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InfluxConnector.InfluxConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected final ThreadPoolExecutor	executor
protected final QueryProxy	queryProxy

Constructor Summary

Constructors

Constructor	Description
InfluxConnector(String componentId, QueryLanguageConfig queryLanguage, URI url, String org, String apiKey, String bucket, String tag, boolean isReadOnly, int poolSize, int maxQueueSize, Consumer<com.influxdb.exceptions.BadRequestException> onWriteError, boolean safeWrite, com.influxdb.client.write.WriteParameters... parameters)	The Constructor.
InfluxConnector(String componentId, QueryLanguageConfig queryLanguage, URI url, String org, String apiKey, String bucket, String tag, boolean isReadOnly, int poolSize, int maxQueueSize, Consumer<com.influxdb.exceptions.BadRequestException> onWriteError, com.influxdb.client.write.WriteParameters... parameters)

Method Summary

Modifier and Type	Method	Description
static com.influxdb.client.write.Point	buildUpdateAvailableSincePoint(String tag, int influxEdgeId, String channel, long availableSinceTimestamp)	Builds a Point which set the invalid reference QueryProxy.AVAILABLE_SINCE_COLUMN_NAME field to the new value.
void	deactivate()	Close current InfluxDBClient.
String	debugLog()	Returns a debug log of the current influx connection state.
protected InfluxConnector.InfluxConnection	getInfluxConnection()	Get InfluxDB Connection.
boolean	isSafeWrite()
static Integer	parseNumberFromName(String name)	Parses the number of an Edge from its name string.
Map<Integer,Map<String,Long>>	queryAvailableSince()	Gets the edges which already have the available since field set.
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryFirstValueBefore(Optional<Integer> influxEdgeId, ZonedDateTime date, Set<ChannelAddress> channels, String measurement)	Queries the first valid values before the given date.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricData(Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution, String measurement)	Queries historic data.
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryHistoricEnergy(Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, String measurement)	Queries historic energy.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryHistoricEnergyPerPeriod(Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution, String measurement)	Queries historic energy per period.
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryHistoricEnergySingleValueInDay(Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, String measurement)	Queries historic energy where only one value per day is saved.
SortedMap<ChannelAddress,com.google.gson.JsonElement>	queryLastData(Optional<Integer> influxEdgeId, ChannelAddress channelAddress, String measurement)	Queries the last value for given channel address from now to 100 days in the past.
SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>>	queryRawHistoricEnergyPerPeriodSinglePerDay(Optional<Integer> influxEdgeId, ZonedDateTime fromDate, ZonedDateTime toDate, Set<ChannelAddress> channels, Resolution resolution, String measurement)	Queries the raw historic values without calculating the difference between two values.
void	write(com.influxdb.client.write.Point point)	Actually write the Point to InfluxDB.
void	write(com.influxdb.client.write.Point point, com.influxdb.client.write.WriteParameters writeParameters)	Actually write the Point to InfluxDB.

Methods inherited from class java.lang.Object

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

Field Details

executor

protected final ThreadPoolExecutor executor

queryProxy

protected final QueryProxy queryProxy

Constructor Details

InfluxConnector

public InfluxConnector(String componentId,
 QueryLanguageConfig queryLanguage,
 URI url,
 String org,
 String apiKey,
 String bucket,
 String tag,
 boolean isReadOnly,
 int poolSize,
 int maxQueueSize,
 Consumer<com.influxdb.exceptions.BadRequestException> onWriteError,
 boolean safeWrite,
 com.influxdb.client.write.WriteParameters... parameters)

The Constructor.

Parameters:

componentId - ID of the calling OpenEMS Component

queryLanguage - A QueryLanguageConfig

url - URL of the InfluxDB-Server (http://ip:port)

org - The organisation; '-' for InfluxDB v1

apiKey - The apiKey; 'username:password' for InfluxDB v1

bucket - The bucket name; 'database/retentionPolicy' for InfluxDB v1

tag - The InfluxDB tag

isReadOnly - If true, a 'Read-Only-Mode' is activated, where no data is actually written to the database

poolSize - the number of threads dedicated to handle the tasks

maxQueueSize - queue size limit for executor

onWriteError - A consumer for write-errors

safeWrite - Adds back points to the queue if a write fails

parameters - the WriteParameters to create a MergePointsWorker for. All later used WriteParameters need to be passed here

InfluxConnector

public InfluxConnector(String componentId,
 QueryLanguageConfig queryLanguage,
 URI url,
 String org,
 String apiKey,
 String bucket,
 String tag,
 boolean isReadOnly,
 int poolSize,
 int maxQueueSize,
 Consumer<com.influxdb.exceptions.BadRequestException> onWriteError,
 com.influxdb.client.write.WriteParameters... parameters)

Method Details

debugLog

public String debugLog()

Returns a debug log of the current influx connection state.

Returns:

the debug log string

getInfluxConnection

protected InfluxConnector.InfluxConnection getInfluxConnection()

Get InfluxDB Connection.

Returns:

the

invalid reference

InfluxDB

connection

deactivate

public void deactivate()

Close current InfluxDBClient.

queryHistoricEnergy

public SortedMap<ChannelAddress,com.google.gson.JsonElement> queryHistoricEnergy(Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 String measurement)
                                                                          throws OpenemsError.OpenemsNamedException

Queries historic energy.

Parameters:

influxEdgeId - the unique, numeric Edge-ID; or Empty to query all Edges

fromDate - the From-Date

toDate - the To-Date

channels - the Channels to query

measurement - the measurement

Returns:

a map between ChannelAddress and value

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

queryHistoricEnergySingleValueInDay

public SortedMap<ChannelAddress,com.google.gson.JsonElement> queryHistoricEnergySingleValueInDay(Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 String measurement)
                                                                                          throws OpenemsError.OpenemsNamedException

Queries historic energy where only one value per day is saved.

Parameters:

influxEdgeId - the unique, numeric Edge-ID; or Empty to query all Edges

fromDate - the From-Date

toDate - the To-Date

channels - the Channels to query

measurement - the measurement

Returns:

a map between ChannelAddress and value

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

queryHistoricEnergyPerPeriod

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricEnergyPerPeriod(Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution,
 String measurement)
                                                                                                            throws OpenemsError.OpenemsNamedException

Queries historic energy per period.

Parameters:

influxEdgeId - the unique, numeric Edge-ID; or Empty to query all Edges

fromDate - the From-Date

toDate - the To-Date

channels - the Channels to query

resolution - the resolution in seconds

measurement - the measurement

Returns:

the historic data as Map

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

queryRawHistoricEnergyPerPeriodSinglePerDay

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryRawHistoricEnergyPerPeriodSinglePerDay(Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution,
 String measurement)
                                                                                                                           throws OpenemsError.OpenemsNamedException

Queries the raw historic values without calculating the difference between two values.

Parameters:

influxEdgeId - the unique, numeric Edge-ID; or Empty to query all Edges

fromDate - the From-Date

toDate - the To-Date

channels - the Channels to query

resolution - the resolution in seconds

measurement - the measurement

Returns:

the historic data as Map

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

queryHistoricData

public SortedMap<ZonedDateTime,SortedMap<ChannelAddress,com.google.gson.JsonElement>> queryHistoricData(Optional<Integer> influxEdgeId,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 Set<ChannelAddress> channels,
 Resolution resolution,
 String measurement)
                                                                                                 throws OpenemsError.OpenemsNamedException

Queries historic data.

Parameters:

influxEdgeId - the unique, numeric Edge-ID; or Empty to query all Edges

fromDate - the From-Date

toDate - the To-Date

channels - the Channels to query

resolution - the resolution in seconds

measurement - the measurement

Returns:

the historic data as Map

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

queryLastData

public SortedMap<ChannelAddress,com.google.gson.JsonElement> queryLastData(Optional<Integer> influxEdgeId,
 ChannelAddress channelAddress,
 String measurement)
                                                                    throws OpenemsError.OpenemsNamedException

Queries the last value for given channel address from now to 100 days in the past.

Parameters:

influxEdgeId - the unique, numeric Edge-ID; or Empty to query all Edges

channelAddress - the Channels to query

measurement - the measurement

Returns:

the values mapped to their channel

Throws:

OpenemsError.OpenemsNamedException - on error

queryFirstValueBefore

public SortedMap<ChannelAddress,com.google.gson.JsonElement> queryFirstValueBefore(Optional<Integer> influxEdgeId,
 ZonedDateTime date,
 Set<ChannelAddress> channels,
 String measurement)
                                                                            throws OpenemsError.OpenemsNamedException

Queries the first valid values before the given date.

Parameters:

influxEdgeId - the unique, numeric Edge-ID; or Empty to query all Edges

date - the date

channels - the Channels to query

measurement - the measurement

Returns:

the values mapped to their channel

Throws:

OpenemsError.OpenemsNamedException - on error

write

public void write(com.influxdb.client.write.Point point)

Actually write the Point to InfluxDB.

Parameters:

point - the InfluxDB Point

write

public void write(com.influxdb.client.write.Point point,
 com.influxdb.client.write.WriteParameters writeParameters)

Actually write the Point to InfluxDB.

Parameters:

point - the InfluxDB Point

writeParameters - the WriteParameters of the written point. The WriteParameters had to be passed in the constructor

queryAvailableSince

public Map<Integer,Map<String,Long>> queryAvailableSince()
                                                  throws OpenemsError.OpenemsNamedException

Gets the edges which already have the available since field set. Mapped from edgeId to timestamp of availableSince. The timestamp should be in epoch seconds.

Returns:

the map, where the first key is the edge id the second key is the channel and the value is the available since timestamp in epoch seconds

Throws:

OpenemsError.OpenemsNamedException - on error

buildUpdateAvailableSincePoint

public static com.influxdb.client.write.Point buildUpdateAvailableSincePoint(String tag,
 int influxEdgeId,
 String channel,
 long availableSinceTimestamp)

Builds a Point which set the

invalid reference

QueryProxy.AVAILABLE_SINCE_COLUMN_NAME

field to the new value.

Parameters:

tag - the InfluxDB tag

influxEdgeId - the id of the edge

channel - the channels

availableSinceTimestamp - the new timestamp in epoch seconds

Returns:

the Point

isSafeWrite

public boolean isSafeWrite()

parseNumberFromName

public static Integer parseNumberFromName(String name)
                                   throws OpenemsException

Parses the number of an Edge from its name string.

e.g. translates "edge0" to "0".

Parameters:

name - the edge name

Returns:

the number

Throws:

OpenemsException - on error