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

Functions

bool _update_duckdns (ClientSession session, str domain, str token, *str|None|object txt=_SENTINEL, bool clear=False)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
CALLBACK_TYPE async_track_time_interval_backoff (HomeAssistant hass, Callable[[datetime], Coroutine[Any, Any, bool]] action, Sequence[timedelta] intervals)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 _SENTINEL = object()
 
string ATTR_TXT = "txt"
 
 CONFIG_SCHEMA
 
string DOMAIN = "duckdns"
 
 INTERVAL = timedelta(minutes=5)
 
string SERVICE_SET_TXT = "set_txt"
 
 SERVICE_TXT_SCHEMA = vol.Schema({vol.Required(ATTR_TXT): vol.Any(None, cv.string)})
 
string UPDATE_URL = "https://www.duckdns.org/update"
 

Detailed Description

Integrate with DuckDNS.

Function Documentation

◆ _update_duckdns()

bool homeassistant.components.duckdns._update_duckdns ( ClientSession  session,
str  domain,
str  token,
*str | None | object   txt = _SENTINEL,
bool   clear = False 
)
private
Update DuckDNS.

Definition at line 88 of file __init__.py.

◆ async_setup()

bool homeassistant.components.duckdns.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Initialize the DuckDNS component.

Definition at line 55 of file __init__.py.

◆ async_track_time_interval_backoff()

CALLBACK_TYPE homeassistant.components.duckdns.async_track_time_interval_backoff ( HomeAssistant  hass,
Callable[[datetime], Coroutine[Any, Any, bool]]  action,
Sequence[timedelta]  intervals 
)
Add a listener that fires repetitively at every timedelta interval.

Definition at line 122 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 28 of file __init__.py.

◆ _SENTINEL

homeassistant.components.duckdns._SENTINEL = object()
private

Definition at line 85 of file __init__.py.

◆ ATTR_TXT

string homeassistant.components.duckdns.ATTR_TXT = "txt"

Definition at line 30 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.duckdns.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Required(CONF_DOMAIN): cv.string,
6  vol.Required(CONF_ACCESS_TOKEN): cv.string,
7  }
8  )
9  },
10  extra=vol.ALLOW_EXTRA,
11 )

Definition at line 40 of file __init__.py.

◆ DOMAIN

string homeassistant.components.duckdns.DOMAIN = "duckdns"

Definition at line 32 of file __init__.py.

◆ INTERVAL

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

Definition at line 34 of file __init__.py.

◆ SERVICE_SET_TXT

string homeassistant.components.duckdns.SERVICE_SET_TXT = "set_txt"

Definition at line 36 of file __init__.py.

◆ SERVICE_TXT_SCHEMA

homeassistant.components.duckdns.SERVICE_TXT_SCHEMA = vol.Schema({vol.Required(ATTR_TXT): vol.Any(None, cv.string)})

Definition at line 52 of file __init__.py.

◆ UPDATE_URL

string homeassistant.components.duckdns.UPDATE_URL = "https://www.duckdns.org/update"

Definition at line 38 of file __init__.py.