acts/framework/acts/controllers/relay_lib/fugu_remote.py

#!/usr/bin/env python
#
#   Copyright 2017 - The Android Open Source Project
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
import time
import enum
from acts.controllers.relay_lib.generic_relay_device import GenericRelayDevice
from acts.controllers.relay_lib.relay import SynchronizeRelays
from acts.controllers.relay_lib.errors import RelayConfigError
from acts.controllers.relay_lib.helpers import validate_key

PAIRING_MODE_WAIT_TIME = 5.2
MISSING_RELAY_MSG = 'Relay config for FuguRemote "%s" missing relay "%s".'


class Buttons(enum.Enum):
    HOME = 'Home'
    BACK = 'Back'
    PLAY_PAUSE = 'Play'


class FuguRemote(GenericRelayDevice):
    """A Nexus Player (Fugu) Remote.

    Wraps the button presses, as well as the special features like pairing.
    """

    def __init__(self, config, relay_rig):
        GenericRelayDevice.__init__(self, config, relay_rig)

        self.mac_address = validate_key('mac_address', config, str,
                                        'FuguRemote')

        for button in Buttons:
            self.ensure_config_contains_relay(button.value)

    def ensure_config_contains_relay(self, relay_name):
        """Throws an error if the relay does not exist."""
        if relay_name not in self.relays:
            raise RelayConfigError(MISSING_RELAY_MSG % (self.name, relay_name))

    def setup(self):
        """Sets all relays to their default state (off)."""
        GenericRelayDevice.setup(self)
        # If the Fugu remote does have a power relay attached, turn it on.
        power = 'Power'
        if power in self.relays:
            self.relays[power].set_nc()

    def clean_up(self):
        """Sets all relays to their default state (off)."""
        GenericRelayDevice.clean_up(self)

    def enter_pairing_mode(self):
        """Enters pairing mode. Blocks the thread until pairing mode is set.

        Holds down the 'Home' and 'Back' buttons for a little over 5 seconds.
        """
        with SynchronizeRelays():
            self.relays[Buttons.HOME.value].set_nc()
            self.relays[Buttons.BACK.value].set_nc()

        time.sleep(PAIRING_MODE_WAIT_TIME)

        with SynchronizeRelays():
            self.relays[Buttons.HOME.value].set_no()
            self.relays[Buttons.BACK.value].set_no()

    def press_play_pause(self):
        """Briefly presses the Play/Pause button."""
        self.relays[Buttons.PLAY_PAUSE.value].set_nc_for()

    def press_home(self):
        """Briefly presses the Home button."""
        self.relays[Buttons.HOME.value].set_nc_for()

    def press_back(self):
        """Briefly presses the Back button."""
        self.relays[Buttons.BACK.value].set_nc_for()