homeassistant.components.transmission Namespace Reference

Namespaces
	config_flow
	const
	coordinator
	errors
	sensor
	switch

Functions
TransmissionDataUpdateCoordinator	_get_coordinator_from_service_data (HomeAssistant hass, str entry_id)
bool	async_migrate_entry (HomeAssistant hass, ConfigEntry config_entry)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, TransmissionConfigEntry config_entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry config_entry)
transmission_rpc.Client	get_api (HomeAssistant hass, dict[str, Any] entry)
None	setup_hass_services (HomeAssistant hass)

Variables
	_LOGGER = logging.getLogger(__name__)
	CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
dictionary	MIGRATION_NAME_TO_KEY
list	PLATFORMS = [Platform.SENSOR, Platform.SWITCH]
	SERVICE_ADD_TORRENT_SCHEMA
	SERVICE_BASE_SCHEMA
	SERVICE_REMOVE_TORRENT_SCHEMA
	SERVICE_START_TORRENT_SCHEMA
	SERVICE_STOP_TORRENT_SCHEMA
	TransmissionConfigEntry

Detailed Description

Support for the Transmission BitTorrent client API.

Function Documentation

_get_coordinator_from_service_data()

TransmissionDataUpdateCoordinator homeassistant.components.transmission._get_coordinator_from_service_data ( HomeAssistant  hass, str   entry_id  )

private

Return coordinator for entry id.

Definition at line 196 of file __init__.py.

async_migrate_entry()

bool homeassistant.components.transmission.async_migrate_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Migrate an old config entry.

Definition at line 167 of file __init__.py.

async_setup()

bool homeassistant.components.transmission.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the Transmission component.

Definition at line 115 of file __init__.py.

async_setup_entry()

bool homeassistant.components.transmission.async_setup_entry	(	HomeAssistant	hass,
		TransmissionConfigEntry	config_entry
	)

Set up the Transmission Component.

Definition at line 121 of file __init__.py.

async_unload_entry()

bool homeassistant.components.transmission.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Unload Transmission Entry from config_entry.

Definition at line 162 of file __init__.py.

get_api()

transmission_rpc.Client homeassistant.components.transmission.get_api	(	HomeAssistant	hass,
		dict[str, Any]	entry
	)

Get Transmission client.

Definition at line 277 of file __init__.py.

setup_hass_services()

None homeassistant.components.transmission.setup_hass_services

(

HomeAssistant

hass

)

Home Assistant services.

Definition at line 208 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 59 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.transmission.CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)

Definition at line 110 of file __init__.py.

MIGRATION_NAME_TO_KEY

dictionary homeassistant.components.transmission.MIGRATION_NAME_TO_KEY

Initial value:

=  {
    # Sensors
    "Down Speed": "download",
    "Up Speed": "upload",
    "Status": "status",
    "Active Torrents": "active_torrents",
    "Paused Torrents": "paused_torrents",
    "Total Torrents": "total_torrents",
    "Completed Torrents": "completed_torrents",
    "Started Torrents": "started_torrents",
    # Switches
    "Switch": "on_off",
    "Turtle Mode": "turtle_mode",
}

Definition at line 63 of file __init__.py.

PLATFORMS

list homeassistant.components.transmission.PLATFORMS = [Platform.SENSOR, Platform.SWITCH]

Definition at line 61 of file __init__.py.

SERVICE_ADD_TORRENT_SCHEMA

homeassistant.components.transmission.SERVICE_ADD_TORRENT_SCHEMA

Initial value:

=  vol.All(
    SERVICE_BASE_SCHEMA.extend({vol.Required(ATTR_TORRENT): cv.string}),
)

Definition at line 84 of file __init__.py.

SERVICE_BASE_SCHEMA

homeassistant.components.transmission.SERVICE_BASE_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_ENTRY_ID): selector.ConfigEntrySelector(),
    }
)

Definition at line 78 of file __init__.py.

SERVICE_REMOVE_TORRENT_SCHEMA

homeassistant.components.transmission.SERVICE_REMOVE_TORRENT_SCHEMA

Initial value:

=  vol.All(
    SERVICE_BASE_SCHEMA.extend(
        {
            vol.Required(CONF_ID): cv.positive_int,
            vol.Optional(ATTR_DELETE_DATA, default=DEFAULT_DELETE_DATA): cv.boolean,
        }
    )
)

Definition at line 89 of file __init__.py.

SERVICE_START_TORRENT_SCHEMA

homeassistant.components.transmission.SERVICE_START_TORRENT_SCHEMA

Initial value:

=  vol.All(
    SERVICE_BASE_SCHEMA.extend({vol.Required(CONF_ID): cv.positive_int}),
)

Definition at line 98 of file __init__.py.

SERVICE_STOP_TORRENT_SCHEMA

homeassistant.components.transmission.SERVICE_STOP_TORRENT_SCHEMA

Initial value:

=  vol.All(
    SERVICE_BASE_SCHEMA.extend(
        {
            vol.Required(CONF_ID): cv.positive_int,
        }
    )
)

Definition at line 102 of file __init__.py.

TransmissionConfigEntry

homeassistant.components.transmission.TransmissionConfigEntry

Definition at line 112 of file __init__.py.