homeassistant.components.iperf3.Iperf3Data Class Reference

Public Member Functions
def	__init__ (self, hass, host)
def	create_client (self)
def	host (self)
def	port (self)
def	protocol (self)
def	update (self, now=None)

Public Attributes
	data
	protocol

Private Member Functions
def	_run_test (self, test_type)

Private Attributes
	_hass
	_host

Detailed Description

Get the latest data from iperf3.

Definition at line 141 of file __init__.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.iperf3.Iperf3Data.__init__	(		self,
			hass,
			host
	)

Initialize the data object.

Definition at line 144 of file __init__.py.

Member Function Documentation

_run_test()

def homeassistant.components.iperf3.Iperf3Data._run_test (   self,   test_type  )

private

Run and return the iperf3 data.

Definition at line 195 of file __init__.py.

create_client()

def homeassistant.components.iperf3.Iperf3Data.create_client

(

self

)

Create a new iperf3 client to use for measurement.

Definition at line 150 of file __init__.py.

host()

def homeassistant.components.iperf3.Iperf3Data.host

(

self

)

Return the host connected to.

Definition at line 167 of file __init__.py.

port()

def homeassistant.components.iperf3.Iperf3Data.port

(

self

)

Return the port on the host connected to.

Definition at line 172 of file __init__.py.

protocol()

def homeassistant.components.iperf3.Iperf3Data.protocol

(

self

)

Return the protocol used for this connection.

Definition at line 162 of file __init__.py.

update()

def homeassistant.components.iperf3.Iperf3Data.update	(		self,
			now = None
	)

Get the latest data from iperf3.

Definition at line 176 of file __init__.py.

Member Data Documentation

_hass

homeassistant.components.iperf3.Iperf3Data._hass

private

Definition at line 146 of file __init__.py.

_host

homeassistant.components.iperf3.Iperf3Data._host

private

Definition at line 147 of file __init__.py.

data

homeassistant.components.iperf3.Iperf3Data.data

Definition at line 148 of file __init__.py.

protocol

homeassistant.components.iperf3.Iperf3Data.protocol

Definition at line 178 of file __init__.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/iperf3/__init__.py