v0.7.1

Author: kennymc-c

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.1] - 2025-03-16
+
+### Changed
+
+- Http request responses are now also used for the media_title attribute of the associated request method's media player entity. This allows you to add a media player widget to an activity and see the response within an activity because you can't add sensors to activities as there's no widget for them.
+
 ## [0.7.0] - 2025-03-08
 
 ### Added

README.md

@@ -17,11 +17,11 @@ Using [uc-integration-api](https://github.com/aitatoi/integration-python-library
   - [1 - Wake-on-lan](#1---wake-on-lan)
     - [Supported parameters](#supported-parameters)
   - [2 - HTTP requests](#2---http-requests)
-    - [Expected http request server response](#expected-http-request-server-response)
-    - [Server response sensor entity](#server-response-sensor-entity)
+    - [Expected http request server response code](#expected-http-request-server-response-code)
     - [Additional command parameters](#additional-command-parameters)
     - [SSL verification \& Fire and forget mode](#ssl-verification--fire-and-forget-mode)
     - [Use case examples](#use-case-examples)
+    - [Show (parts) of the server response text in the remote ui](#show-parts-of-the-server-response-text-in-the-remote-ui)
     - [Legacy syntax](#legacy-syntax)
   - [3 - Text over TCP](#3---text-over-tcp)
     - [Control characters](#control-characters)
@@ -92,16 +92,12 @@ All parameters from [pywakeonlan](https://github.com/remcohaszing/pywakeonlan) a
 
 Enter the desired url (including http(s)://). Additional parameters can be added (see below).
 
-#### Expected http request server response
+#### Expected http request server response code
 
 Your server needs to respond with a *200 OK* status or any other informational or redirection http status code (100s, 200s or 300s). If the server's response content is not empty it will be shown in the integration log. In case of a client or server error (400s or 500s) the command will fail on the remote and the error message and status code will be shown in the integration log.
 
 If you activate the fire and forget mode the remote will always receive a *200 OK* status code (see below).
 
-#### Server response sensor entity
-
-The integration also exposes a sensor entity that shows the server response from the last executed http request command. The output can be parsed to only show a specific part of the response message using regular expressions. These can be configured in the advanced setup. Sites like [regex101.com](https://regex101.com) can help you with finding matching expressions. By default the complete response message will be used if no regular expression has been set or no matches have been found.
-
 #### Additional command parameters
 
 Almost all parameters from the Python requests module like `timeout`, `verify`, `data`, `json` or `headers` are supported (see [Python requests module parameters](https://requests.readthedocs.io/en/latest/api/#requests.request)) although not all of them have been tested with this integration. Simply separate them with a comma.
@@ -125,6 +121,12 @@ If you activate the option to ignore HTTP requests errors in the integration set
 | Adding json payload data (content type is set automatically)                 | `json`    |  `url="https://httpbin.org/post", json="{'key1':'value1','key2':'value2'}"` |
 | Adding xml payload data                   | `data` and `headers` |  `url="https://httpbin.org/post", data="<Tests Id='01'><Test TestId='01'><Name>Command name</Name></Test></Tests>", headers="{'Content-Type':'application/xml'}"` |
 
+#### Show (parts) of the server response text in the remote ui
+
+The integration exposes a sensor entity that shows the text of the response body from the last executed http request command. Responses are also used for the media_title attribute of the associated request method's media player entity. This allows you to add a media player widget to an activity and see the response within an activity because you can't add sensors to activities as there's no widget for them.
+
+The output can be parsed to only show a specific part of the response message using regular expressions. These can be configured in the advanced setup. Sites like [regex101.com](https://regex101.com) or the AI model of your choice can help you with finding matching expressions. By default the complete response message will be used if no regular expression has been set or no matches have been found.
+
 #### Legacy syntax
 
 ⚠️ Used before v0.6.0 and support will be removed in a future version

driver.json

@@ -1,7 +1,7 @@
 {
   "driver_id": "requests",
-  "version": "0.7.0",
-  "release_date": "2025-03-08",
+  "version": "0.7.1",
+  "release_date": "2025-03-16",
   "min_core_api": "0.24.3",
   "name": { 
       "en": "HTTP requests, WoL & text over TCP",

intg-requests/config.py

@@ -62,7 +62,7 @@ class Setup:
     @staticmethod
     def get(key):
         """Get the value from the specified key in __conf"""
-        if Setup.__conf[key] == "" and key is not "rq_response_regex": #rq_response_regex can be empty
+        if Setup.__conf[key] == "" and key != "rq_response_regex": #rq_response_regex can be empty
             raise ValueError("Got empty value for " + key + " from config storage")
         return Setup.__conf[key]
 
@@ -179,7 +179,7 @@ def load():
                 else:
                     _LOG.info("Using the default http requests syntax as it has not been changed during setup. \
 The Default value " + str(Setup.get("rq_legacy")) + " will be used")
-                    
+
                 if "rq_response_regex" in configfile:
                     Setup.__conf["rq_response_regex"] = configfile["rq_response_regex"]
                     _LOG.info("Loaded rq_response_regex: " + str(configfile["rq_response_regex"]) + " flag into runtime storage from " + Setup.__conf["cfg_path"])

intg-requests/driver.py

@@ -49,7 +49,10 @@ async def add_mp(entity_id: str, entity_name: str):
     definition = ucapi.MediaPlayer(
         entity_id,
         entity_name,
-        [ucapi.media_player.Features.SELECT_SOURCE],
+        [
+            ucapi.media_player.Features.SELECT_SOURCE, \
+            ucapi.media_player.Features.MEDIA_TITLE
+        ],
         attributes={ucapi.media_player.Attributes.STATE: ucapi.media_player.States.ON},
         cmd_handler=mp_cmd_handler
     )
@@ -171,6 +174,7 @@ def setup_logger():
     logging.getLogger("ucapi.entity").setLevel(level)
     logging.getLogger("driver").setLevel(level)
     logging.getLogger("media_player").setLevel(level)
+    logging.getLogger("sensor").setLevel(level)
     logging.getLogger("setup").setLevel(level)
     logging.getLogger("config").setLevel(level)
     logging.getLogger("getmac").setLevel(level)

intg-requests/media_player.py

@@ -10,7 +10,7 @@
 import ast
 import shlex
 
-from re import sub, match, IGNORECASE
+from re import sub, match, search, IGNORECASE
 from ipaddress import ip_address, IPv4Address, IPv6Address, AddressValueError
 import urllib3 #Needed to optionally deactivate requests ssl verify warning message
 
@@ -23,6 +23,7 @@
 
 import config
 import sensor
+import driver
 
 _LOG = logging.getLogger(__name__)
 
@@ -128,6 +129,57 @@ def replace_control_hex(match):
     return data
 
 
+def parse_rq_response(response: str):
+    """Parse http request response with configured regular expression"""
+
+    regex = config.Setup.get("rq_response_regex")
+
+    if regex == "":
+        parsed_response = response
+        _LOG.debug("No regular expression set for the http request response sensor. The complete response will be used")
+    else:
+        match = search(regex, response)
+        if match:
+            parsed_response = match.group(1)
+            _LOG.debug("Parsed response from configured regex: " + parsed_response)
+        else:
+            parsed_response = response
+            _LOG.warning("No matches found in the http request response for the regular expression " + regex + ". \
+The complete response will be used")
+
+    return parsed_response
+
+
+
+def update_response(method:str, response: str):
+    """Update the response in the sensor entity and media player widget"""
+
+    entity_id = "http-" + method
+
+    parsed_response = parse_rq_response(response)
+
+    sensor.update_rq_sensor(config.Setup.get("id-rq-sensor"), parsed_response)
+
+    update_rq_media_widget(entity_id, parsed_response)
+
+
+
+def update_rq_media_widget(entity_id:str, response: str):
+    """Update the response in the media player widget"""
+
+    attributes_to_send = {ucapi.media_player.Attributes.MEDIA_TITLE: response}
+
+    try:
+        api_update_attributes = driver.api.configured_entities.update_attributes(entity_id, attributes_to_send)
+    except Exception as e:
+        raise Exception("Error while updating attributes for entity id " + entity_id) from e
+
+    if not api_update_attributes:
+        raise Exception("Entity " + entity_id + " not found. Please make sure it's added as a configured entity on the remote")
+    else:
+        _LOG.info("Updated entity attribute(s) " + str(attributes_to_send) + " for " + entity_id)
+
+
 
 def rq_cmd(method: str, cmd_param: str=None) -> int:
     """Send a requests command to the passed url with the passed data and return the status code"""
@@ -262,7 +314,7 @@ def rq_cmd(method: str, cmd_param: str=None) -> int:
         _LOG.info("Sent http-" + method + " request to: " + url)
         if response.text != "":
             _LOG.info("Server response: " + response.text)
-            sensor.update_rq_sensor(config.Setup.get("id-rq-sensor"), response.text)
+            update_response(method, response.text)
         else:
             _LOG.debug("Received 200 - OK status code")
         return ucapi.StatusCodes.OK
@@ -276,7 +328,7 @@ def rq_cmd(method: str, cmd_param: str=None) -> int:
             if response.status_code == 404:
                 if response.text != "":
                     _LOG.info("Server response: " + response.text)
-                    sensor.update_rq_sensor(config.Setup.get("id-rq-sensor"), response.text)
+                    update_response(method, response.text)
                 return ucapi.StatusCodes.NOT_FOUND
             return ucapi.StatusCodes.BAD_REQUEST
         return ucapi.StatusCodes.SERVER_ERROR
@@ -285,7 +337,7 @@ def rq_cmd(method: str, cmd_param: str=None) -> int:
         _LOG.info("Received informational or redirection http status code: " + str(response.status_code))
         if response.text != "":
             _LOG.info("Server response: " + response)
-            sensor.update_rq_sensor(config.Setup.get("id-rq-sensor"), response.text)
+            update_response(method, response.text)
         return ucapi.StatusCodes.OK
 
 

intg-requests/sensor.py

@@ -3,17 +3,13 @@
 """Module that includes functions to add a http request response sensor entity"""
 
 import logging
-
 import ucapi
-from re import search
-
-import config
 import driver
 
 _LOG = logging.getLogger(__name__)
 
 #TODO Add possibility to add additional sensor entities in advanced setup. Each sensor then can be linked to a specific http request command by using a special command parameter
-
+#TODO Use media player title, artist, album or media type to also show the response because sensors cant be added to activities and have no widgets
 
 
 async def add_rq_sensor(ent_id: str, name: str):
@@ -37,24 +33,7 @@ async def add_rq_sensor(ent_id: str, name: str):
 def update_rq_sensor(entity_id: str, response: str):
     """Parse http request response with configured regular expression and update sensor entity value"""
 
-    regex = config.Setup.get("rq_response_regex")
-
-    if regex == "":
-        parsed_response = response
-        _LOG.debug("No regular expression set for the http request response sensor. The complete response will be sent to the http request response sensor")
-    else:
-        match = search(regex, response)
-        if match:
-            parsed_response = match.group(1)
-            _LOG.debug("Parsed response: " + parsed_response)
-        else:
-            parsed_response = response
-            _LOG.warning("No matches found in the http request response for the regular expression " + regex + ". \
-The complete response will be sent to the http request response sensor")
-
-    value = parsed_response
-
-    attributes_to_send = {ucapi.sensor.Attributes.STATE: ucapi.sensor.States.ON, ucapi.sensor.Attributes.VALUE: value}
+    attributes_to_send = {ucapi.sensor.Attributes.STATE: ucapi.sensor.States.ON, ucapi.sensor.Attributes.VALUE: response}
 
     try:
         api_update_attributes = driver.api.configured_entities.update_attributes(entity_id, attributes_to_send)
@@ -65,4 +44,4 @@ def update_rq_sensor(entity_id: str, response: str):
     if not api_update_attributes:
         raise Exception("Sensor entity " + entity_id + " not found. Please make sure it's added as a configured entity on the remote")
 
-    _LOG.info("Updated http request response sensor value to " + value)
+    _LOG.info("Updated http request response sensor value to " + response)

intg-requests/setup.py

@@ -111,7 +111,7 @@ async def handle_driver_setup(msg: ucapi.DriverSetupRequest,) -> ucapi.SetupActi
                   "id": "tcp_text_timeout",
                   "label": {
                             "en": "Timeout for Text over TCP (max. 30 seconds):",
-                            "de": "Timeout für Text over TCP (max. 30 Sekunden):"
+                            "de": "Timeout für Text über TCP (max. 30 Sekunden):"
                             },
                    "field": {"number": {
                                     "value": tcp_text_timeout,