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

Functions

bool _update_no_ip (HomeAssistant hass, aiohttp.ClientSession session, str domain, bytes auth_str, int timeout)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CONFIG_SCHEMA
 
int DEFAULT_TIMEOUT = 10
 
string DOMAIN = "no_ip"
 
string EMAIL = "hello@home-assistant.io"
 
string HA_USER_AGENT = f"{SERVER_SOFTWARE} {EMAIL}"
 
 INTERVAL = timedelta(minutes=5)
 
dictionary NO_IP_ERRORS
 
string UPDATE_URL = "https://dynupdate.no-ip.com/nic/update"
 

Detailed Description

Integrate with NO-IP Dynamic DNS service.

Function Documentation

◆ _update_no_ip()

bool homeassistant.components.no_ip._update_no_ip ( HomeAssistant  hass,
aiohttp.ClientSession  session,
str  domain,
bytes  auth_str,
int  timeout 
)
private
Update NO-IP.

Definition at line 85 of file __init__.py.

◆ async_setup()

bool homeassistant.components.no_ip.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Initialize the NO-IP component.

Definition at line 60 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 22 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.no_ip.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Required(CONF_DOMAIN): cv.string,
6  vol.Required(CONF_USERNAME): cv.string,
7  vol.Required(CONF_PASSWORD): cv.string,
8  vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
9  }
10  )
11  },
12  extra=vol.ALLOW_EXTRA,
13 )

Definition at line 45 of file __init__.py.

◆ DEFAULT_TIMEOUT

int homeassistant.components.no_ip.DEFAULT_TIMEOUT = 10

Definition at line 31 of file __init__.py.

◆ DOMAIN

string homeassistant.components.no_ip.DOMAIN = "no_ip"

Definition at line 24 of file __init__.py.

◆ EMAIL

string homeassistant.components.no_ip.EMAIL = "hello@home-assistant.io"

Definition at line 27 of file __init__.py.

◆ HA_USER_AGENT

string homeassistant.components.no_ip.HA_USER_AGENT = f"{SERVER_SOFTWARE} {EMAIL}"

Definition at line 43 of file __init__.py.

◆ INTERVAL

homeassistant.components.no_ip.INTERVAL = timedelta(minutes=5)

Definition at line 29 of file __init__.py.

◆ NO_IP_ERRORS

dictionary homeassistant.components.no_ip.NO_IP_ERRORS
Initial value:
1 = {
2  "nohost": "Hostname supplied does not exist under specified account",
3  "badauth": "Invalid username password combination",
4  "badagent": "Client disabled",
5  "!donator": "An update request was sent with a feature that is not available",
6  "abuse": "Username is blocked due to abuse",
7  "911": "A fatal error on NO-IP's side such as a database outage",
8 }

Definition at line 33 of file __init__.py.

◆ UPDATE_URL

string homeassistant.components.no_ip.UPDATE_URL = "https://dynupdate.no-ip.com/nic/update"

Definition at line 42 of file __init__.py.