homeassistant.components.ping Namespace Reference

Namespaces
	binary_sensor
	config_flow
	const
	coordinator
	device_tracker
	entity
	helpers
	sensor

Functions
bool|None	_can_use_icmp_lib_with_privilege ()
None	async_reload_entry (HomeAssistant hass, PingConfigEntry entry)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, PingConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, PingConfigEntry entry)

Variables
	_LOGGER = logging.getLogger(__name__)
	CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
	PingConfigEntry
list	PLATFORMS = [Platform.BINARY_SENSOR, Platform.DEVICE_TRACKER, Platform.SENSOR]

Detailed Description

The ping component.

Function Documentation

_can_use_icmp_lib_with_privilege()

bool | None homeassistant.components.ping._can_use_icmp_lib_with_privilege ( )

private

Verify we can create a raw socket.

Definition at line 72 of file __init__.py.

async_reload_entry()

None homeassistant.components.ping.async_reload_entry	(	HomeAssistant	hass,
		PingConfigEntry	entry
	)

Handle an options update.

Definition at line 62 of file __init__.py.

async_setup()

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

Set up the ping integration.

Definition at line 30 of file __init__.py.

async_setup_entry()

bool homeassistant.components.ping.async_setup_entry	(	HomeAssistant	hass,
		PingConfigEntry	entry
	)

Set up Ping (ICMP) from a config entry.

Definition at line 37 of file __init__.py.

async_unload_entry()

bool homeassistant.components.ping.async_unload_entry	(	HomeAssistant	hass,
		PingConfigEntry	entry
	)

Unload a config entry.

Definition at line 67 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 20 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.ping.CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)

Definition at line 22 of file __init__.py.

PingConfigEntry

homeassistant.components.ping.PingConfigEntry

Definition at line 27 of file __init__.py.

PLATFORMS

list homeassistant.components.ping.PLATFORMS = [Platform.BINARY_SENSOR, Platform.DEVICE_TRACKER, Platform.SENSOR]

Definition at line 23 of file __init__.py.