homeassistant.components.purpleair.config_flow Namespace Reference

Classes
class	PurpleAirConfigFlow
class	PurpleAirOptionsFlowHandler
class	ValidationResult

Functions
API	async_get_api (HomeAssistant hass, str api_key)
vol.Schema	async_get_coordinates_schema (HomeAssistant hass)
list[SelectOptionDict]	async_get_nearby_sensors_options (list[NearbySensorResult] nearby_sensor_results)
vol.Schema	async_get_nearby_sensors_schema (list[SelectOptionDict] options)
list[SelectOptionDict]	async_get_remove_sensor_options (HomeAssistant hass, ConfigEntry config_entry)
vol.Schema	async_get_remove_sensor_schema (list[SelectOptionDict] sensors)
ValidationResult	async_validate_api_key (HomeAssistant hass, str api_key)
ValidationResult	async_validate_coordinates (HomeAssistant hass, str api_key, float latitude, float longitude, float distance)

Variables
	API_KEY_SCHEMA
string	CONF_DISTANCE = "distance"
string	CONF_NEARBY_SENSOR_OPTIONS = "nearby_sensor_options"
string	CONF_SENSOR_DEVICE_ID = "sensor_device_id"
string	CONF_SENSOR_INDEX = "sensor_index"
int	DEFAULT_DISTANCE = 5

Detailed Description

Config flow for PurpleAir integration.

Function Documentation

async_get_api()

API homeassistant.components.purpleair.config_flow.async_get_api	(	HomeAssistant	hass,
		str	api_key
	)

Get an aiopurpleair API object.

Definition at line 60 of file config_flow.py.

async_get_coordinates_schema()

vol.Schema homeassistant.components.purpleair.config_flow.async_get_coordinates_schema

(

HomeAssistant

hass

)

Define a schema for searching for sensors near a coordinate pair.

Definition at line 67 of file config_flow.py.

async_get_nearby_sensors_options()

list[SelectOptionDict] homeassistant.components.purpleair.config_flow.async_get_nearby_sensors_options

(

list[NearbySensorResult]

nearby_sensor_results

)

Return a set of nearby sensors as SelectOptionDict objects.

Definition at line 83 of file config_flow.py.

async_get_nearby_sensors_schema()

vol.Schema homeassistant.components.purpleair.config_flow.async_get_nearby_sensors_schema

(

list[SelectOptionDict]

options

)

Define a schema for selecting a sensor from a list.

Definition at line 96 of file config_flow.py.

async_get_remove_sensor_options()

list[SelectOptionDict] homeassistant.components.purpleair.config_flow.async_get_remove_sensor_options	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Return a set of already-configured sensors as SelectOptionDict objects.

Definition at line 108 of file config_flow.py.

async_get_remove_sensor_schema()

vol.Schema homeassistant.components.purpleair.config_flow.async_get_remove_sensor_schema

(

list[SelectOptionDict]

sensors

)

Define a schema removing a sensor.

Definition at line 122 of file config_flow.py.

async_validate_api_key()

ValidationResult homeassistant.components.purpleair.config_flow.async_validate_api_key	(	HomeAssistant	hass,
		str	api_key
	)

Validate an API key.

This method returns a dictionary of errors (if appropriate).

Definition at line 141 of file config_flow.py.

async_validate_coordinates()

ValidationResult homeassistant.components.purpleair.config_flow.async_validate_coordinates	(	HomeAssistant	hass,
		str	api_key,
		float	latitude,
		float	longitude,
		float	distance
	)

Validate coordinates.

Definition at line 166 of file config_flow.py.

Variable Documentation

API_KEY_SCHEMA

homeassistant.components.purpleair.config_flow.API_KEY_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_API_KEY): cv.string,
    }
)

Definition at line 52 of file config_flow.py.

CONF_DISTANCE

string homeassistant.components.purpleair.config_flow.CONF_DISTANCE = "distance"

Definition at line 45 of file config_flow.py.

CONF_NEARBY_SENSOR_OPTIONS

string homeassistant.components.purpleair.config_flow.CONF_NEARBY_SENSOR_OPTIONS = "nearby_sensor_options"

Definition at line 46 of file config_flow.py.

CONF_SENSOR_DEVICE_ID

string homeassistant.components.purpleair.config_flow.CONF_SENSOR_DEVICE_ID = "sensor_device_id"

Definition at line 47 of file config_flow.py.

CONF_SENSOR_INDEX

string homeassistant.components.purpleair.config_flow.CONF_SENSOR_INDEX = "sensor_index"

Definition at line 48 of file config_flow.py.

DEFAULT_DISTANCE

int homeassistant.components.purpleair.config_flow.DEFAULT_DISTANCE = 5

Definition at line 50 of file config_flow.py.