homeassistant.components.rtorrent.sensor Namespace Reference

Classes
class	RTorrentSensor

Functions
def	format_speed (speed)
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	DEFAULT_NAME = "rtorrent"
	PLATFORM_SCHEMA
string	SENSOR_TYPE_ACTIVE_TORRENTS = "active_torrents"
string	SENSOR_TYPE_ALL_TORRENTS = "all_torrents"
string	SENSOR_TYPE_COMPLETE_TORRENTS = "complete_torrents"
string	SENSOR_TYPE_CURRENT_STATUS = "current_status"
string	SENSOR_TYPE_DOWNLOAD_SPEED = "download_speed"
string	SENSOR_TYPE_DOWNLOADING_TORRENTS = "downloading_torrents"
string	SENSOR_TYPE_STOPPED_TORRENTS = "stopped_torrents"
string	SENSOR_TYPE_UPLOAD_SPEED = "upload_speed"
string	SENSOR_TYPE_UPLOADING_TORRENTS = "uploading_torrents"

Detailed Description

Support for monitoring the rtorrent BitTorrent client API.

Function Documentation

format_speed()

def homeassistant.components.rtorrent.sensor.format_speed

(

speed

)

Return a bytes/s measurement as a human readable string.

Definition at line 123 of file sensor.py.

setup_platform()

None homeassistant.components.rtorrent.sensor.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the rtorrent sensors.

Definition at line 98 of file sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.rtorrent.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 29 of file sensor.py.

DEFAULT_NAME

string homeassistant.components.rtorrent.sensor.DEFAULT_NAME = "rtorrent"

Definition at line 41 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.rtorrent.sensor.PLATFORM_SCHEMA

Initial value:

=  SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_URL): cv.url,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_MONITORED_VARIABLES, default=SENSOR_KEYS): vol.All(
            cv.ensure_list, [vol.In(SENSOR_KEYS)]
        ),
    }
)

Definition at line 87 of file sensor.py.

SENSOR_TYPE_ACTIVE_TORRENTS

string homeassistant.components.rtorrent.sensor.SENSOR_TYPE_ACTIVE_TORRENTS = "active_torrents"

Definition at line 39 of file sensor.py.

SENSOR_TYPE_ALL_TORRENTS

string homeassistant.components.rtorrent.sensor.SENSOR_TYPE_ALL_TORRENTS = "all_torrents"

Definition at line 34 of file sensor.py.

SENSOR_TYPE_COMPLETE_TORRENTS

string homeassistant.components.rtorrent.sensor.SENSOR_TYPE_COMPLETE_TORRENTS = "complete_torrents"

Definition at line 36 of file sensor.py.

SENSOR_TYPE_CURRENT_STATUS

string homeassistant.components.rtorrent.sensor.SENSOR_TYPE_CURRENT_STATUS = "current_status"

Definition at line 31 of file sensor.py.

SENSOR_TYPE_DOWNLOAD_SPEED

string homeassistant.components.rtorrent.sensor.SENSOR_TYPE_DOWNLOAD_SPEED = "download_speed"

Definition at line 32 of file sensor.py.

SENSOR_TYPE_DOWNLOADING_TORRENTS

string homeassistant.components.rtorrent.sensor.SENSOR_TYPE_DOWNLOADING_TORRENTS = "downloading_torrents"

Definition at line 38 of file sensor.py.

SENSOR_TYPE_STOPPED_TORRENTS

string homeassistant.components.rtorrent.sensor.SENSOR_TYPE_STOPPED_TORRENTS = "stopped_torrents"

Definition at line 35 of file sensor.py.

SENSOR_TYPE_UPLOAD_SPEED

string homeassistant.components.rtorrent.sensor.SENSOR_TYPE_UPLOAD_SPEED = "upload_speed"

Definition at line 33 of file sensor.py.

SENSOR_TYPE_UPLOADING_TORRENTS

string homeassistant.components.rtorrent.sensor.SENSOR_TYPE_UPLOADING_TORRENTS = "uploading_torrents"

Definition at line 37 of file sensor.py.