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

Namespaces

 const
 
 sensor
 

Functions

bool setup (HomeAssistant hass, ConfigType config)
 
str urlbase (value)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CONFIG_SCHEMA
 
 SUBMIT_MOVIE_REQUEST_SERVICE_SCHEMA = vol.Schema({vol.Required(ATTR_NAME): cv.string})
 
 SUBMIT_MUSIC_REQUEST_SERVICE_SCHEMA = vol.Schema({vol.Required(ATTR_NAME): cv.string})
 
 SUBMIT_TV_REQUEST_SERVICE_SCHEMA
 

Detailed Description

Support for Ombi.

Function Documentation

◆ setup()

bool homeassistant.components.ombi.setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the Ombi component platform.

Definition at line 83 of file __init__.py.

◆ urlbase()

str homeassistant.components.ombi.urlbase (   value)
Validate and transform urlbase.

Definition at line 39 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 36 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.ombi.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.All(
4  vol.Schema(
5  {
6  vol.Required(CONF_HOST): cv.string,
7  vol.Required(CONF_USERNAME): cv.string,
8  vol.Exclusive(CONF_API_KEY, "auth"): cv.string,
9  vol.Exclusive(CONF_PASSWORD, "auth"): cv.string,
10  vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
11  vol.Optional(CONF_URLBASE, default=DEFAULT_URLBASE): urlbase,
12  vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean,
13  }
14  ),
15  cv.has_at_least_one_key(CONF_API_KEY, CONF_PASSWORD),
16  )
17  },
18  extra=vol.ALLOW_EXTRA,
19 )

Definition at line 62 of file __init__.py.

◆ SUBMIT_MOVIE_REQUEST_SERVICE_SCHEMA

homeassistant.components.ombi.SUBMIT_MOVIE_REQUEST_SERVICE_SCHEMA = vol.Schema({vol.Required(ATTR_NAME): cv.string})

Definition at line 49 of file __init__.py.

◆ SUBMIT_MUSIC_REQUEST_SERVICE_SCHEMA

homeassistant.components.ombi.SUBMIT_MUSIC_REQUEST_SERVICE_SCHEMA = vol.Schema({vol.Required(ATTR_NAME): cv.string})

Definition at line 51 of file __init__.py.

◆ SUBMIT_TV_REQUEST_SERVICE_SCHEMA

homeassistant.components.ombi.SUBMIT_TV_REQUEST_SERVICE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_NAME): cv.string,
4  vol.Optional(ATTR_SEASON, default=DEFAULT_SEASON): vol.In(
5  ["first", "latest", "all"]
6  ),
7  }
8 )

Definition at line 53 of file __init__.py.