Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.voip Namespace Reference

Namespaces

 assist_satellite
 
 binary_sensor
 
 config_flow
 
 const
 
 devices
 
 entity
 
 repairs
 
 select
 
 switch
 
 voip
 

Classes

class  DomainData
 

Functions

tuple[asyncio.DatagramTransport, HassVoipDatagramProtocol_create_sip_server (HomeAssistant hass, Callable[[], asyncio.DatagramProtocol,] protocol_factory, int sip_port)
 
bool async_remove_config_entry_device (HomeAssistant hass, ConfigEntry config_entry, dr.DeviceEntry device_entry)
 
None async_remove_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
def update_listener (HomeAssistant hass, ConfigEntry entry)
 

Variables

list __all__
 
string _IP_WILDCARD = "0.0.0.0"
 
 _LOGGER = logging.getLogger(__name__)
 
tuple PLATFORMS
 

Detailed Description

The Voice over IP integration.

Function Documentation

◆ _create_sip_server()

tuple[asyncio.DatagramTransport, HassVoipDatagramProtocol] homeassistant.components.voip._create_sip_server ( HomeAssistant  hass,
Callable[ [], asyncio.DatagramProtocol, ]  protocol_factory,
int  sip_port 
)
private

Definition at line 86 of file __init__.py.

◆ async_remove_config_entry_device()

bool homeassistant.components.voip.async_remove_config_entry_device ( HomeAssistant  hass,
ConfigEntry  config_entry,
dr.DeviceEntry   device_entry 
)
Remove device from a config entry.

Definition at line 117 of file __init__.py.

◆ async_remove_entry()

None homeassistant.components.voip.async_remove_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Remove VoIP entry.

Definition at line 124 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.voip.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up VoIP integration from a config entry.

Definition at line 48 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.voip.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload VoIP.

Definition at line 105 of file __init__.py.

◆ update_listener()

def homeassistant.components.voip.update_listener ( HomeAssistant  hass,
ConfigEntry  entry 
)
Handle options update.

Definition at line 81 of file __init__.py.

Variable Documentation

◆ __all__

list homeassistant.components.voip.__all__
private
Initial value:
1 = [
2  "DOMAIN",
3  "async_setup_entry",
4  "async_unload_entry",
5  "async_remove_config_entry_device",
6 ]

Definition at line 31 of file __init__.py.

◆ _IP_WILDCARD

string homeassistant.components.voip._IP_WILDCARD = "0.0.0.0"
private

Definition at line 29 of file __init__.py.

◆ _LOGGER

homeassistant.components.voip._LOGGER = logging.getLogger(__name__)
private

Definition at line 28 of file __init__.py.

◆ PLATFORMS

tuple homeassistant.components.voip.PLATFORMS
Initial value:
1 = (
2  Platform.ASSIST_SATELLITE,
3  Platform.BINARY_SENSOR,
4  Platform.SELECT,
5  Platform.SWITCH,
6 )

Definition at line 22 of file __init__.py.