homeassistant.components.sabnzbd Namespace Reference

Namespaces
	binary_sensor
	button
	config_flow
	const
	coordinator
	entity
	helpers
	number
	sensor

Functions
SabnzbdConfigEntry	async_get_entry_for_service_call (HomeAssistant hass, ServiceCall call)
bool	async_setup_entry (HomeAssistant hass, SabnzbdConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, SabnzbdConfigEntry entry)

Variables
	_LOGGER = logging.getLogger(__name__)
list	PLATFORMS = [Platform.BINARY_SENSOR, Platform.BUTTON, Platform.NUMBER, Platform.SENSOR]
	SabnzbdConfigEntry
	SERVICE_BASE_SCHEMA
	SERVICE_SPEED_SCHEMA
tuple	SERVICES

Detailed Description

Support for monitoring an SABnzbd NZB client.

Function Documentation

async_get_entry_for_service_call()

SabnzbdConfigEntry homeassistant.components.sabnzbd.async_get_entry_for_service_call	(	HomeAssistant	hass,
		ServiceCall	call
	)

Get the entry ID related to a service call (by device ID).

Definition at line 55 of file __init__.py.

async_setup_entry()

bool homeassistant.components.sabnzbd.async_setup_entry	(	HomeAssistant	hass,
		SabnzbdConfigEntry	entry
	)

Set up the SabNzbd Component.

Definition at line 68 of file __init__.py.

async_unload_entry()

bool homeassistant.components.sabnzbd.async_unload_entry	(	HomeAssistant	hass,
		SabnzbdConfigEntry	entry
	)

Unload a Sabnzbd config entry.

Definition at line 162 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 31 of file __init__.py.

PLATFORMS

list homeassistant.components.sabnzbd.PLATFORMS = [Platform.BINARY_SENSOR, Platform.BUTTON, Platform.NUMBER, Platform.SENSOR]

Definition at line 30 of file __init__.py.

SabnzbdConfigEntry

homeassistant.components.sabnzbd.SabnzbdConfigEntry

Definition at line 51 of file __init__.py.

SERVICE_BASE_SCHEMA

homeassistant.components.sabnzbd.SERVICE_BASE_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_API_KEY): cv.string,
    }
)

Definition at line 39 of file __init__.py.

SERVICE_SPEED_SCHEMA

homeassistant.components.sabnzbd.SERVICE_SPEED_SCHEMA

Initial value:

=  SERVICE_BASE_SCHEMA.extend(
    {
        vol.Optional(ATTR_SPEED, default=DEFAULT_SPEED_LIMIT): cv.string,
    }
)

Definition at line 45 of file __init__.py.

SERVICES

tuple homeassistant.components.sabnzbd.SERVICES

Initial value:

=  (
    SERVICE_PAUSE,
    SERVICE_RESUME,
    SERVICE_SET_SPEED,
)

Definition at line 33 of file __init__.py.