server/cros/bluetooth/bluetooth_client.py

# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import logging

from autotest_lib.client.common_lib import error
from autotest_lib.client.cros import constants
from autotest_lib.server import autotest


class BluetoothClient(object):
    """BluetoothClient is a thin layer of logic over a remote DUT."""

    XMLRPC_BRINGUP_TIMEOUT_SECONDS = 60

    @property
    def host(self):
        """@return host object representing the remote DUT."""
        return self._host

    def __init__(self, client_host):
        """Construct a BluetoothClient.

        @param client_host host object representing a remote host.

        """
        self._host = client_host
        # Make sure the client library is on the device so that the proxy code
        # is there when we try to call it.
        client_at = autotest.Autotest(self.host)
        client_at.install()
        # Start up the XML-RPC proxy on the client.
        self._proxy = self.host.xmlrpc_connect(
                constants.BLUETOOTH_CLIENT_XMLRPC_SERVER_COMMAND,
                constants.BLUETOOTH_CLIENT_XMLRPC_SERVER_PORT,
                command_name=
                  constants.BLUETOOTH_CLIENT_XMLRPC_SERVER_CLEANUP_PATTERN,
                ready_test_name=
                  constants.BLUETOOTH_CLIENT_XMLRPC_SERVER_READY_METHOD,
                timeout_seconds=self.XMLRPC_BRINGUP_TIMEOUT_SECONDS)

    def reset_on(self):
        """Reset the adapter and settings and power up the adapter.

        @return True on success, False otherwise.

        """
        return self._proxy.reset_on()

    def reset_off(self):
        """Reset the adapter and settings, leave the adapter powered off.

        @return True on success, False otherwise.

        """
        return self._proxy.reset_off()

    def set_powered(self, powered):
        """Set the adapter power state.

        @param powered adapter power state to set (True or False).

        @return True on success, False otherwise.

        """
        return self._proxy.set_powered(powered)

    def set_discoverable(self, discoverable):
        """Set the adapter discoverable state.

        @param powered adapter discoverable state to set (True or False).

        @return True on success, False otherwise.

        """
        return self._proxy.set_discoverable(discoverable)

    def set_pairable(self, pairable):
        """Set the adapter pairable state.

        @param powered adapter pairable state to set (True or False).

        @return True on success, False otherwise.

        """
        return self._proxy.set_pairable(pairable)

    def close(self):
        """Tear down state associated with the client."""
        # Leave the adapter powered off, but don't do a full reset.
        self._proxy.set_powered(False)
        # This kills the RPC server.
        self._host.close()