Merge branch 'release/1.5.0'

Author: zghp

CHANGELOG.md

@@ -4,11 +4,21 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [1.5.0](https://github.com/rdkcentral/python_raft/compare/1.4.2...1.5.0)
+
+- GH166 - audio amp [`#170`](https://github.com/rdkcentral/python_raft/pull/170)
+- Fix #164 - Fixed bug in StreamLogger's readUntil method [`#164`](https://github.com/rdkcentral/python_raft/issues/164)
+- update denon_controller class, add docstrings and test [`fcef34b`](https://github.com/rdkcentral/python_raft/commit/fcef34bce72d1213c65f9f7c3e9a67d1ab379e96)
+- add core/denon_controller with logging, fix docstring and __init__ inside controller [`c6bdbc6`](https://github.com/rdkcentral/python_raft/commit/c6bdbc62204e87a0aa40e33e66eec928d7bdb61c)
+- add config to test audio amplifier and clean up test [`de55e8c`](https://github.com/rdkcentral/python_raft/commit/de55e8c681044407dd4ce4d19bd3b67a331743a1)
+
 #### [1.4.2](https://github.com/rdkcentral/python_raft/compare/1.4.1...1.4.2)
 
+> 16 April 2025
+
+- Bumped changelog - bugfix 1.4.2 [`c88c2b1`](https://github.com/rdkcentral/python_raft/commit/c88c2b1d91a505ccce72f4f11cbf3780fd1ad06a)
 - gh #163 from rdkcentral/feature/gh133-fix-listDevices-CEC-adapter [`45693d4`](https://github.com/rdkcentral/python_raft/commit/45693d4d4bb8bdcce2d30aceffb75d32fd012fe1)
 - Fix gh #133 : Fix the number of retries before reading input from CECAdapter [`159d3be`](https://github.com/rdkcentral/python_raft/commit/159d3be0c21c63258dbb79d494cc99abe54d5a36)
-- Merge tag '1.4.1' into develop [`ded5b83`](https://github.com/rdkcentral/python_raft/commit/ded5b83a5827ac542e62f04529d7a68295ec591e)
 
 #### [1.4.1](https://github.com/rdkcentral/python_raft/compare/1.4.0...1.4.1)
 
@@ -126,7 +136,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - bumped changelog [`d288dbf`](https://github.com/rdkcentral/python_raft/commit/d288dbfe3520344a287ad3c8935ac47f12bed7ce)
 - updated #97 - self.console.set_missing_host_key_policy [`3ce3839`](https://github.com/rdkcentral/python_raft/commit/3ce3839500e6922b9e2d60f07af6c891c2d309b0)
 
-#### [1.1.0](https://github.com/rdkcentral/python_raft/compare/1.0.0...1.1.0)
+#### [1.1.0](https://github.com/rdkcentral/python_raft/compare/1.0.1...1.1.0)
 
 > 20 September 2024
 
@@ -136,13 +146,27 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Fix #71: Added missing args in docstring for constructTestPath in [`#71`](https://github.com/rdkcentral/python_raft/issues/71)
 - Fix #71: Fix rackController to use --rack argument correctly [`#71`](https://github.com/rdkcentral/python_raft/issues/71)
 - Fix #77: Removed S20 import from powerControl [`#77`](https://github.com/rdkcentral/python_raft/issues/77)
+- Initial commit [`f7868c3`](https://github.com/rdkcentral/python_raft/commit/f7868c3c1ccfb768cfe91cc8d289b3a1420c6c45)
 - Update #71: Updates to Singleton for rackController support [`4e88c59`](https://github.com/rdkcentral/python_raft/commit/4e88c59f49a83e79b8665ad7f0a1ff048f6cf40d)
 - Update #75: Moved pingTest and added session to device class. [`5a967fe`](https://github.com/rdkcentral/python_raft/commit/5a967fedd6a5a7be2efc6d8963a82963704e66b6)
-- update test adn singleton logic [`2edf093`](https://github.com/rdkcentral/python_raft/commit/2edf09353bb0c5c80fd73ee117a09b98eaedb749)
+
+#### [1.0.1](https://github.com/rdkcentral/python_raft/compare/1.0.0...1.0.1)
+
+> 7 May 2024
+
+- gh30 - Refactored getting started guide and added it to README [`c2f9914`](https://github.com/rdkcentral/python_raft/commit/c2f991418024228a664c2f0e112e42759985c3b9)
+- gh33 - Created initial design docs for RAFT [`953c313`](https://github.com/rdkcentral/python_raft/commit/953c313484dd7f7872ad2a1053c62f96e041c1d4)
+- gh57 - Added missing copyright headers [`1873172`](https://github.com/rdkcentral/python_raft/commit/187317270a1905e07adc189545acc56e7671b3e9)
 
 #### 1.0.0
 
-> 14 May 2024
+> 29 April 2024
 
-- Initial commit [`f7868c3`](https://github.com/rdkcentral/python_raft/commit/f7868c3c1ccfb768cfe91cc8d289b3a1420c6c45)
-- reset changelog [`9976d08`](https://github.com/rdkcentral/python_raft/commit/9976d083e060326fc5146d2ef68288c413be8b2a)
+- gh14 - document test & rack controller [`#44`](https://github.com/rdkcentral/python_raft/pull/44)
+- gh11 - document common remote [`#42`](https://github.com/rdkcentral/python_raft/pull/42)
+- gh10 - document log module [`#40`](https://github.com/rdkcentral/python_raft/pull/40)
+- gh7 - document config parser [`#37`](https://github.com/rdkcentral/python_raft/pull/37)
+- gh3 - add installation guidelines and requirements.txt file  [`#34`](https://github.com/rdkcentral/python_raft/pull/34)
+- Initial commit of framework [`453787b`](https://github.com/rdkcentral/python_raft/commit/453787b2dde06c128cadca7047bd61ca4567a234)
+- gh30 - Refactored getting started guide and added it to README [`5c4004d`](https://github.com/rdkcentral/python_raft/commit/5c4004dc749dfd4ad6fe3a8d33102f1db0c9c0d7)
+- update copyright information on all files [`d1bc272`](https://github.com/rdkcentral/python_raft/commit/d1bc2727a120ef1842ad6f7b78b04b1b35281f6a)

framework/core/audioAmplifier/__init__.py

@@ -0,0 +1,107 @@
+from abc import ABC, abstractmethod
+
+class AudioAmplifier(ABC):
+    """
+    Abstract base class defining the interface for an audio amplifier controller.
+
+    Implementations must provide methods for controlling power, volume,
+    input source, mute state, sound mode, and retrieving status information.
+    """
+
+    @abstractmethod
+    def power_on(self):
+        """Power on the amplifier."""
+        pass
+
+    @abstractmethod
+    def power_off(self):
+        """Power off the amplifier."""
+        pass
+
+    @abstractmethod
+    def set_volume(self, volume: float):
+        """
+        Set the amplifier volume.
+
+        :param volume: Desired volume level.
+        """
+        pass
+
+    @abstractmethod
+    def mute(self, state: bool):
+        """
+        Mute or unmute the amplifier.
+
+        :param state: True to mute, False to unmute.
+        """
+        pass
+
+    @abstractmethod
+    def list_inputs(self) -> list[str]:
+        """
+        Get the list of available input sources supported by the amplifier.
+        """
+        pass
+
+    @abstractmethod
+    def list_sound_modes(self) -> list[str]:
+        """
+        Get the list of available sound modes supported by the amplifier.
+        """
+        pass
+
+    @abstractmethod
+    def set_input(self, input_name: str):
+        """
+        Set the input source of the amplifier.
+
+        :param input_name: Name of the input source (e.g., "TV", "CD").
+        """
+        pass
+
+    @abstractmethod
+    def set_sound_mode(self, input_name: str):
+        """
+        Set the sound mode of the amplifier.
+
+        :param input_name: Name of the sound mode (e.g., "TV", "CD").
+        """
+        pass
+
+    @abstractmethod
+    def update_state(self):
+        """
+        Refresh the internal state from the amplifier.
+
+        Typically required before retrieving status properties.
+        """
+        pass
+
+    @abstractmethod
+    def get_power(self) -> str:
+        """Get the current power state (e.g., "ON", "OFF")."""
+        pass
+
+    @abstractmethod
+    def get_volume(self) -> float:
+        """Get the current volume level."""
+        pass
+
+    @abstractmethod
+    def get_input(self) -> str:
+        """Get the currently selected input source."""
+        pass
+
+    @abstractmethod
+    def is_muted(self) -> bool:
+        """Check whether the amplifier is muted."""
+        pass
+
+    @abstractmethod
+    def get_status(self) -> dict:
+        """
+        Get a dictionary of key status information (power, volume, input, mute).
+
+        :return: Dictionary of current amplifier state.
+        """
+        pass

framework/core/audioAmplifier/base.py

@@ -0,0 +1,78 @@
+import asyncio
+from denonavr import DenonAVR
+from .base import AudioAmplifier
+
+class DenonAVRController(AudioAmplifier):
+    
+    def __init__(self, host: str):
+        self.receiver = DenonAVR(host)
+        self.setup()
+
+    def setup(self):
+        asyncio.run(self.receiver.async_setup())
+
+    def power_on(self):
+        asyncio.run(self.receiver.async_power_on())
+        self.update_state()
+
+    def power_off(self):
+        asyncio.run(self.receiver.async_power_off())
+        self.update_state()
+
+
+    def set_volume(self, volume: float):
+        asyncio.run(self.receiver.async_set_volume(volume))
+        self.update_state()
+
+    def mute(self, state: bool):
+        asyncio.run(self.receiver.async_mute(state))
+        self.update_state()
+
+    def list_inputs(self) -> list[str]:
+        self.update_state()
+        return self.receiver.input_func_list
+
+    def list_sound_modes(self) -> list[str]:
+        self.update_state()
+        return self.receiver.sound_mode_list
+
+    def set_input(self, input_name: str):
+        available = self.list_inputs()
+        if input_name not in available:
+            raise ValueError(f"Invalid input: {input_name}. Available inputs: {available}")
+        asyncio.run(self.receiver.async_set_input_func(input_name))
+        self.update_state()
+
+    def set_sound_mode(self, mode: str):
+        available = self.list_sound_modes()
+        if mode not in available:
+            raise ValueError(f"Invalid sound mode: {mode}. Available modes: {available}")
+        asyncio.run(self.receiver.async_set_sound_mode(mode))
+        self.update_state()
+
+    def update_state(self):
+        asyncio.run(self.receiver.async_update())
+
+    def get_power(self) -> str:
+        return self.receiver.power
+
+    def get_volume(self) -> float:
+        return self.receiver.volume
+
+    def is_muted(self) -> bool:
+        return self.receiver.muted
+    
+    def get_input(self) -> str:
+        return self.receiver.input_func
+    
+    def get_sound_mode(self) -> str:
+        return self.receiver.sound_mode
+
+    def get_status(self):
+        return {
+            "power": self.get_power(),
+            "volume": self.get_volume(),
+            "muted": self.is_muted(),
+            "input": self.get_input(),
+            "sound_mode": self.get_sound_mode(),
+        }

framework/core/audioAmplifier/denon_controller.py

@@ -0,0 +1,98 @@
+#!/usr/bin/env python3
+#** *****************************************************************************
+# *
+# * If not stated otherwise in this file or this component's LICENSE file the
+# * following copyright and licenses apply:
+# *
+# * Copyright 2023 RDK Management
+# *
+# * 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.
+# *
+#* ******************************************************************************
+#*
+#*   ** Project      : RAFT
+#*   ** @addtogroup  : core
+#*   ** @date        : 01/07/2025
+#*   **
+#*   ** @brief : audio amplifier controller
+#*   **
+#* ******************************************************************************
+
+from framework.core.logModule import logModule
+from framework.core.audioAmplifier.denon_controller import DenonAVRController
+
+class audioAmplifierController():
+    
+    def __init__(self, log:logModule, config:dict):
+        self._log = log
+        self.controllerType = config.get("type")
+        self.host = config.get("host")
+        
+        if self.controllerType == "denon":
+            self.audioAmplifier = DenonAVRController(self.host)
+
+    def power_on(self):
+        self._log.info("Powering ON audio amplifier")
+        self.audioAmplifier.power_on()
+
+    def power_off(self):
+        self._log.info("Powering OFF audio amplifier")
+        self.audioAmplifier.power_off()
+
+    def set_volume(self, volume: float):
+        self._log.info("Setting audio amplifier volume")
+        self.audioAmplifier.set_volume(volume)
+
+    def mute(self, state: bool):
+        self._log.info("Muting audio amplifier")
+        self.audioAmplifier.mute(state)
+
+    def list_inputs(self) -> list[str]:
+        self._log.info("Listing the audio amplifier available inputs")
+        return self.audioAmplifier.list_inputs()
+
+    def list_sound_modes(self) -> list[str]:
+        self._log.info("Listing the audio amplifier available sound modes")
+        return self.audioAmplifier.list_sound_modes()
+
+    def set_input(self, input_name: str):
+        self._log.info("Setting audio amplifier input")
+        self.audioAmplifier.set_input(input_name)
+
+    def set_sound_mode(self, mode: str):
+        self.audioAmplifier.set_sound_mode(mode)
+
+    def get_power(self) -> str:
+        self._log.info("Getting audio amplifier power")
+        return self.audioAmplifier.get_power()
+
+    def get_volume(self) -> float:
+        self._log.info("Getting audio amplifier volume")
+        return self.audioAmplifier.get_volume()
+
+    def is_muted(self) -> bool:
+        self._log.info("Getting audio amplifier mute state")
+        return self.audioAmplifier.is_muted()
+    
+    def get_input(self) -> str:
+        self._log.info("Getting audio amplifier input")
+        return self.audioAmplifier.get_input()
+    
+    def get_sound_mode(self) -> str:
+        self._log.info("Getting audio amplifier sound mode")
+        return self.audioAmplifier.get_sound_mode()
+
+    def get_status(self):
+        self._log.info("Getting audio amplifier status")
+        return self.audioAmplifier.get_status()

framework/core/audioAmplifierController.py

@@ -21,8 +21,6 @@ def writeStreamToFile(self, inputStream: IOBase) -> None:
 
         Args:
             inputStream (IOBase): The input stream to be read from.
-            outFileName (str): The path of the output file where the stream data will be written.
-                                If only a file name is given, the file will be written in the current tests log directory.
         """
         self._fileHandle = open(self._filePath, 'a+', encoding='utf-8')
         self._stopThread = False
@@ -84,10 +82,9 @@ def readUntil(self, searchString:str, retries: int = 5) -> None:
             if read_line == write_line:
                 time.sleep(1)
             else:
-                while read_line < write_line:
+                while read_line < write_line and len(result) == 0:
                     if searchString in out_lines[read_line]:
                         result = out_lines[:read_line]
-                        break
                     read_line+=1
             retry += 1
             self._readLine = read_line