New Transmission turtle mode switch. Using existing TransmissionRpc requirement.

homeassistant/components/switch/transmission.py

@@ -0,0 +1,141 @@
+"""
+homeassistant.components.switch.transmission
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Enable or disable Transmission BitTorrent client Turtle Mode
+
+Configuration:
+
+To use the Transmission switch you will need to add something like the
+following to your config/configuration.yaml
+
+switch:
+    platform: transmission
+    name: Transmission
+    host: 192.168.1.26
+    port: 9091
+    username: YOUR_USERNAME
+    password: YOUR_PASSWORD
+
+Variables:
+
+host
+*Required
+This is the IP address of your Transmission daemon. Example: 192.168.1.32
+
+port
+*Optional
+The port your Transmission daemon uses, defaults to 9091. Example: 8080
+
+username
+*Optional
+Your Transmission username, if you use authentication
+
+password
+*Optional
+Your Transmission username, if you use authentication
+
+name
+*Optional
+The name to use when displaying this Transmission instance.
+
+
+"""
+
+from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.const import STATE_ON, STATE_OFF
+
+from homeassistant.helpers.entity import ToggleEntity
+# pylint: disable=no-name-in-module, import-error
+import transmissionrpc
+
+from transmissionrpc.error import TransmissionError
+
+import logging
+
+_LOGGING = logging.getLogger(__name__)
+
+
+# pylint: disable=unused-argument
+def setup_platform(hass, config, add_devices_callback, discovery_info=None):
+    """ Sets up the sensors. """
+    host = config.get(CONF_HOST)
+    username = config.get(CONF_USERNAME, None)
+    password = config.get(CONF_PASSWORD, None)
+    port = config.get('port', 9091)
+
+    name = config.get("name", "Transmission Turtle Mode")
+    if not host:
+        _LOGGING.error('Missing config variable %s', CONF_HOST)
+        return False
+
+    # import logging
+    # logging.getLogger('transmissionrpc').setLevel(logging.DEBUG)
+
+    transmission_api = transmissionrpc.Client(
+        host, port=port, user=username, password=password)
+    try:
+        transmission_api.session_stats()
+    except TransmissionError:
+        _LOGGING.exception("Connection to Transmission API failed.")
+        return False
+
+    add_devices_callback([
+        TransmissionSwitch(transmission_api, name)
+    ])
+
+
+class TransmissionSwitch(ToggleEntity):
+
+    """ A Transmission sensor. """
+
+    def __init__(self, transmission_client, name):
+        self._name = name
+        self.transmission_client = transmission_client
+        self.turtle_mode_active = False
+        self._state = STATE_OFF
+
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def state(self):
+        """ Returns the state of the device. """
+        return self._state
+
+    @property
+    def should_poll(self):
+        """ Poll for status regularly. """
+        return True
+
+    @property
+    def is_on(self):
+        """ True if device is on. """
+        return self._state == STATE_ON
+
+    def turn_on(self, **kwargs):
+        """ Turn the device on. """
+
+        _LOGGING.info("Turning on Turtle Mode")
+        self.toggle_turtle_mode()
+
+    def turn_off(self, **kwargs):
+        """ Turn the device off. """
+
+        _LOGGING.info("Turning off Turtle Mode ")
+        self.toggle_turtle_mode()
+
+    def toggle_turtle_mode(self):
+        """ Toggle turtle mode. """
+
+        self.transmission_client.set_session(
+            alt_speed_enabled=not self.turtle_mode_active)
+        self.update()
+
+    def update(self):
+        """ Gets the latest data from Transmission and updates the state. """
+
+        self.turtle_mode_active = self.transmission_client.get_session(
+        ).alt_speed_enabled
+        self._state = STATE_ON if self.turtle_mode_active else STATE_OFF