acts/framework/acts/controllers/relay_lib/generic_relay_device.py

#!/usr/bin/env python
#
#   Copyright 2016 - 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.

from acts.controllers.relay_lib.relay_device import RelayDevice
from acts.controllers.relay_lib.relay import SynchronizeRelays


class GenericRelayDevice(RelayDevice):
    """A default, all-encompassing implementation of RelayDevice.

    This class allows for quick access to getting relay switches through the
    subscript ([]) operator. Note that it does not allow for re-assignment or
    additions to the relays dictionary.
    """

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

    def setup(self):
        """Sets all relays to their default state (off)."""
        with SynchronizeRelays():
            for relay in self.relays.values():
                relay.set_no()

    def clean_up(self):
        """Sets all relays to their default state (off)."""
        with SynchronizeRelays():
            for relay in self.relays.values():
                relay.set_no()