mirror of
https://github.com/home-assistant/core
synced 2024-08-28 03:36:46 +02:00
154 lines
5.1 KiB
Python
154 lines
5.1 KiB
Python
"""Constants for InfluxDB integration."""
|
|
from datetime import timedelta
|
|
import re
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.const import (
|
|
CONF_API_VERSION,
|
|
CONF_HOST,
|
|
CONF_PASSWORD,
|
|
CONF_PATH,
|
|
CONF_PORT,
|
|
CONF_SSL,
|
|
CONF_TOKEN,
|
|
CONF_USERNAME,
|
|
CONF_VERIFY_SSL,
|
|
)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
CONF_DB_NAME = "database"
|
|
CONF_BUCKET = "bucket"
|
|
CONF_ORG = "organization"
|
|
CONF_TAGS = "tags"
|
|
CONF_DEFAULT_MEASUREMENT = "default_measurement"
|
|
CONF_MEASUREMENT_ATTR = "measurement_attr"
|
|
CONF_OVERRIDE_MEASUREMENT = "override_measurement"
|
|
CONF_TAGS_ATTRIBUTES = "tags_attributes"
|
|
CONF_COMPONENT_CONFIG = "component_config"
|
|
CONF_COMPONENT_CONFIG_GLOB = "component_config_glob"
|
|
CONF_COMPONENT_CONFIG_DOMAIN = "component_config_domain"
|
|
CONF_RETRY_COUNT = "max_retries"
|
|
CONF_IGNORE_ATTRIBUTES = "ignore_attributes"
|
|
CONF_PRECISION = "precision"
|
|
CONF_SSL_CA_CERT = "ssl_ca_cert"
|
|
|
|
CONF_QUERIES = "queries"
|
|
CONF_QUERIES_FLUX = "queries_flux"
|
|
CONF_GROUP_FUNCTION = "group_function"
|
|
CONF_FIELD = "field"
|
|
CONF_MEASUREMENT_NAME = "measurement"
|
|
CONF_WHERE = "where"
|
|
|
|
CONF_RANGE_START = "range_start"
|
|
CONF_RANGE_STOP = "range_stop"
|
|
CONF_FUNCTION = "function"
|
|
CONF_QUERY = "query"
|
|
CONF_IMPORTS = "imports"
|
|
|
|
DEFAULT_DATABASE = "home_assistant"
|
|
DEFAULT_HOST_V2 = "us-west-2-1.aws.cloud2.influxdata.com"
|
|
DEFAULT_SSL_V2 = True
|
|
DEFAULT_BUCKET = "Home Assistant"
|
|
DEFAULT_VERIFY_SSL = True
|
|
DEFAULT_API_VERSION = "1"
|
|
DEFAULT_GROUP_FUNCTION = "mean"
|
|
DEFAULT_FIELD = "value"
|
|
DEFAULT_RANGE_START = "-15m"
|
|
DEFAULT_RANGE_STOP = "now()"
|
|
DEFAULT_FUNCTION_FLUX = "|> limit(n: 1)"
|
|
DEFAULT_MEASUREMENT_ATTR = "unit_of_measurement"
|
|
|
|
INFLUX_CONF_MEASUREMENT = "measurement"
|
|
INFLUX_CONF_TAGS = "tags"
|
|
INFLUX_CONF_TIME = "time"
|
|
INFLUX_CONF_FIELDS = "fields"
|
|
INFLUX_CONF_STATE = "state"
|
|
INFLUX_CONF_VALUE = "value"
|
|
INFLUX_CONF_VALUE_V2 = "_value"
|
|
INFLUX_CONF_ORG = "org"
|
|
|
|
EVENT_NEW_STATE = "new_state"
|
|
DOMAIN = "influxdb"
|
|
API_VERSION_2 = "2"
|
|
TIMEOUT = 10 # seconds
|
|
RETRY_DELAY = 20
|
|
QUEUE_BACKLOG_SECONDS = 30
|
|
RETRY_INTERVAL = 60 # seconds
|
|
BATCH_TIMEOUT = 1
|
|
BATCH_BUFFER_SIZE = 100
|
|
LANGUAGE_INFLUXQL = "influxQL"
|
|
LANGUAGE_FLUX = "flux"
|
|
TEST_QUERY_V1 = "SHOW DATABASES;"
|
|
TEST_QUERY_V2 = "buckets()"
|
|
CODE_INVALID_INPUTS = 400
|
|
|
|
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=10)
|
|
|
|
RE_DIGIT_TAIL = re.compile(r"^[^\.]*\d+\.?\d+[^\.]*$")
|
|
RE_DECIMAL = re.compile(r"[^\d.]+")
|
|
|
|
CONNECTION_ERROR = (
|
|
"Cannot connect to InfluxDB due to '%s'. "
|
|
"Please check that the provided connection details (host, port, etc.) are correct "
|
|
"and that your InfluxDB server is running and accessible."
|
|
)
|
|
CLIENT_ERROR_V2 = (
|
|
"InfluxDB bucket is not accessible due to '%s'. "
|
|
"Please check that the bucket, org and token are correct and "
|
|
"that the token has the correct permissions set."
|
|
)
|
|
CLIENT_ERROR_V1 = (
|
|
"InfluxDB database is not accessible due to '%s'. "
|
|
"Please check that the database, username and password are correct and "
|
|
"that the specified user has the correct permissions set."
|
|
)
|
|
NO_BUCKET_ERROR = (
|
|
"InfluxDB bucket '%s' cannot be found. "
|
|
"Check the name is correct and the token has access to it."
|
|
)
|
|
NO_DATABASE_ERROR = (
|
|
"InfluxDB database '%s' cannot be found. "
|
|
"Check the name is correct and the user has access to it."
|
|
)
|
|
WRITE_ERROR = "Could not write '%s' to influx due to '%s'."
|
|
QUERY_ERROR = (
|
|
"Could not execute query '%s' due to '%s'. Check the syntax of your query."
|
|
)
|
|
RETRY_MESSAGE = f"%s Retrying in {RETRY_INTERVAL} seconds."
|
|
CATCHING_UP_MESSAGE = "Catching up, dropped %d old events."
|
|
RESUMED_MESSAGE = "Resumed, lost %d events."
|
|
WROTE_MESSAGE = "Wrote %d events."
|
|
RUNNING_QUERY_MESSAGE = "Running query: %s."
|
|
QUERY_NO_RESULTS_MESSAGE = "Query returned no results, sensor state set to UNKNOWN: %s."
|
|
QUERY_MULTIPLE_RESULTS_MESSAGE = (
|
|
"Query returned multiple results, only value from first one is shown: %s."
|
|
)
|
|
RENDERING_QUERY_MESSAGE = "Rendering query: %s."
|
|
RENDERING_QUERY_ERROR_MESSAGE = "Could not render query template: %s."
|
|
RENDERING_WHERE_MESSAGE = "Rendering where: %s."
|
|
RENDERING_WHERE_ERROR_MESSAGE = "Could not render where template: %s."
|
|
|
|
COMPONENT_CONFIG_SCHEMA_CONNECTION = {
|
|
# Connection config for V1 and V2 APIs.
|
|
vol.Optional(CONF_API_VERSION, default=DEFAULT_API_VERSION): vol.All(
|
|
vol.Coerce(str),
|
|
vol.In([DEFAULT_API_VERSION, API_VERSION_2]),
|
|
),
|
|
vol.Optional(CONF_HOST): cv.string,
|
|
vol.Optional(CONF_PATH): cv.string,
|
|
vol.Optional(CONF_PORT): cv.port,
|
|
vol.Optional(CONF_SSL): cv.boolean,
|
|
vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
|
|
vol.Optional(CONF_SSL_CA_CERT): cv.isfile,
|
|
vol.Optional(CONF_PRECISION): vol.In(["ms", "s", "us", "ns"]),
|
|
# Connection config for V1 API only.
|
|
vol.Inclusive(CONF_USERNAME, "authentication"): cv.string,
|
|
vol.Inclusive(CONF_PASSWORD, "authentication"): cv.string,
|
|
vol.Optional(CONF_DB_NAME, default=DEFAULT_DATABASE): cv.string,
|
|
# Connection config for V2 API only.
|
|
vol.Inclusive(CONF_TOKEN, "v2_authentication"): cv.string,
|
|
vol.Inclusive(CONF_ORG, "v2_authentication"): cv.string,
|
|
vol.Optional(CONF_BUCKET, default=DEFAULT_BUCKET): cv.string,
|
|
}
|