homeassistant.components.iperf3 Namespace Reference

Namespaces
	sensor

Classes
class	Iperf3Data

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_DOWNLOAD = "download"
string	ATTR_HOST = "host"
string	ATTR_UPLOAD = "upload"
string	ATTR_VERSION = "Version"
string	CONF_DURATION = "duration"
string	CONF_MANUAL = "manual"
string	CONF_PARALLEL = "parallel"
	CONFIG_SCHEMA
string	DATA_UPDATED = f"{DOMAIN}_data_updated"
int	DEFAULT_DURATION = 10
	DEFAULT_INTERVAL = timedelta(minutes=60)
int	DEFAULT_PARALLEL = 1
int	DEFAULT_PORT = 5201
string	DEFAULT_PROTOCOL = "tcp"
string	DOMAIN = "iperf3"
	HOST_CONFIG_SCHEMA
list	PROTOCOLS = ["tcp", "udp"]
	SERVICE_SCHEMA = vol.Schema({vol.Optional(ATTR_HOST, default=None): cv.string})

Detailed Description

Support for Iperf3 network measurement tool.

Function Documentation

async_setup()

bool homeassistant.components.iperf3.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the iperf3 component.

Definition at line 106 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.iperf3._LOGGER = logging.getLogger(__name__)

private

Definition at line 36 of file __init__.py.

ATTR_DOWNLOAD

string homeassistant.components.iperf3.ATTR_DOWNLOAD = "download"

Definition at line 48 of file __init__.py.

ATTR_HOST

string homeassistant.components.iperf3.ATTR_HOST = "host"

Definition at line 51 of file __init__.py.

ATTR_UPLOAD

string homeassistant.components.iperf3.ATTR_UPLOAD = "upload"

Definition at line 49 of file __init__.py.

ATTR_VERSION

string homeassistant.components.iperf3.ATTR_VERSION = "Version"

Definition at line 50 of file __init__.py.

CONF_DURATION

string homeassistant.components.iperf3.CONF_DURATION = "duration"

Definition at line 38 of file __init__.py.

CONF_MANUAL

string homeassistant.components.iperf3.CONF_MANUAL = "manual"

Definition at line 40 of file __init__.py.

CONF_PARALLEL

string homeassistant.components.iperf3.CONF_PARALLEL = "parallel"

Definition at line 39 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.iperf3.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: vol.Schema(
            {
                vol.Required(CONF_HOSTS): vol.All(cv.ensure_list, [HOST_CONFIG_SCHEMA]),
                vol.Optional(CONF_MONITORED_CONDITIONS, default=SENSOR_KEYS): vol.All(
                    cv.ensure_list, [vol.In(SENSOR_KEYS)]
                ),
                vol.Optional(CONF_SCAN_INTERVAL, default=DEFAULT_INTERVAL): vol.All(
                    cv.time_period, cv.positive_timedelta
                ),
                vol.Optional(CONF_MANUAL, default=False): cv.boolean,
            }
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 85 of file __init__.py.

DATA_UPDATED

string homeassistant.components.iperf3.DATA_UPDATED = f"{DOMAIN}_data_updated"

Definition at line 34 of file __init__.py.

DEFAULT_DURATION

int homeassistant.components.iperf3.DEFAULT_DURATION = 10

Definition at line 42 of file __init__.py.

DEFAULT_INTERVAL

homeassistant.components.iperf3.DEFAULT_INTERVAL = timedelta(minutes=60)

Definition at line 46 of file __init__.py.

DEFAULT_PARALLEL

int homeassistant.components.iperf3.DEFAULT_PARALLEL = 1

Definition at line 44 of file __init__.py.

DEFAULT_PORT

int homeassistant.components.iperf3.DEFAULT_PORT = 5201

Definition at line 43 of file __init__.py.

DEFAULT_PROTOCOL

string homeassistant.components.iperf3.DEFAULT_PROTOCOL = "tcp"

Definition at line 45 of file __init__.py.

DOMAIN

string homeassistant.components.iperf3.DOMAIN = "iperf3"

Definition at line 33 of file __init__.py.

HOST_CONFIG_SCHEMA

homeassistant.components.iperf3.HOST_CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_HOST): cv.string,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
        vol.Optional(CONF_DURATION, default=DEFAULT_DURATION): vol.Range(5, 10),
        vol.Optional(CONF_PARALLEL, default=DEFAULT_PARALLEL): vol.Range(1, 20),
        vol.Optional(CONF_PROTOCOL, default=DEFAULT_PROTOCOL): vol.In(PROTOCOLS),
    }
)

Definition at line 75 of file __init__.py.

PROTOCOLS

list homeassistant.components.iperf3.PROTOCOLS = ["tcp", "udp"]

Definition at line 73 of file __init__.py.

SERVICE_SCHEMA

homeassistant.components.iperf3.SERVICE_SCHEMA = vol.Schema({vol.Optional(ATTR_HOST, default=None): cv.string})

Definition at line 103 of file __init__.py.