homeassistant.components.influxdb.sensor Namespace Reference

Classes
class	InfluxFluxSensorData
class	InfluxQLSensorData
class	InfluxSensor

Functions
def	_merge_connection_config_into_query (conf, query)
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)
dict	validate_query_format_for_version (dict conf)

Variables
	_LOGGER = logging.getLogger(__name__)
dictionary	_QUERY_SCHEMA
	_QUERY_SENSOR_SCHEMA
	Final
	PLATFORM_SCHEMA
	seconds

Detailed Description

InfluxDB component which allows you to get data from an Influx database.

Function Documentation

_merge_connection_config_into_query()

def homeassistant.components.influxdb.sensor._merge_connection_config_into_query (   conf,   query  )

private

Merge connection details into each configured query.

Definition at line 74 of file sensor.py.

setup_platform()

None homeassistant.components.influxdb.sensor.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the InfluxDB component.

Definition at line 158 of file sensor.py.

validate_query_format_for_version()

dict homeassistant.components.influxdb.sensor.validate_query_format_for_version

(

dict

conf

)

Ensure queries are provided in correct format based on API version.

Definition at line 81 of file sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.influxdb.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 69 of file sensor.py.

_QUERY_SCHEMA

dictionary homeassistant.components.influxdb.sensor._QUERY_SCHEMA

private

Initial value:

=  {
    LANGUAGE_INFLUXQL: _QUERY_SENSOR_SCHEMA.extend(
        {
            vol.Optional(CONF_DB_NAME): cv.string,
            vol.Required(CONF_MEASUREMENT_NAME): cv.string,
            vol.Optional(
                CONF_GROUP_FUNCTION, default=DEFAULT_GROUP_FUNCTION
            ): cv.string,
            vol.Optional(CONF_FIELD, default=DEFAULT_FIELD): cv.string,
            vol.Required(CONF_WHERE): cv.template,
        }
    ),
    LANGUAGE_FLUX: _QUERY_SENSOR_SCHEMA.extend(
        {
            vol.Optional(CONF_BUCKET): cv.string,
            vol.Optional(CONF_RANGE_START, default=DEFAULT_RANGE_START): cv.string,
            vol.Optional(CONF_RANGE_STOP, default=DEFAULT_RANGE_STOP): cv.string,
            vol.Required(CONF_QUERY): cv.template,
            vol.Optional(CONF_IMPORTS): vol.All(cv.ensure_list, [cv.string]),
            vol.Optional(CONF_GROUP_FUNCTION): cv.string,
        }
    ),
}

Definition at line 121 of file sensor.py.

_QUERY_SENSOR_SCHEMA

homeassistant.components.influxdb.sensor._QUERY_SENSOR_SCHEMA

private

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_NAME): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
        vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
    }
)

Definition at line 112 of file sensor.py.

Final

homeassistant.components.influxdb.sensor.Final

Definition at line 71 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.influxdb.sensor.PLATFORM_SCHEMA

Initial value:

=  vol.All(
    SENSOR_PLATFORM_SCHEMA.extend(COMPONENT_CONFIG_SCHEMA_CONNECTION).extend(
        {
            vol.Exclusive(CONF_QUERIES, "queries"): [_QUERY_SCHEMA[LANGUAGE_INFLUXQL]],
            vol.Exclusive(CONF_QUERIES_FLUX, "queries"): [_QUERY_SCHEMA[LANGUAGE_FLUX]],
        }
    ),
    validate_version_specific_config,
    validate_query_format_for_version,
    create_influx_url,
)

Definition at line 145 of file sensor.py.

seconds

homeassistant.components.influxdb.sensor.seconds

Definition at line 71 of file sensor.py.