v0.7.2

Author: kennymc-c

.pylintrc

@@ -23,6 +23,7 @@ disable=
     broad-exception-caught,
     broad-exception-raised,
     logging-not-lazy,
+    logging-fstring-interpolation,
     fixme # temporary
 
 [STRING]

CHANGELOG.md

@@ -5,6 +5,16 @@ 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.2] - 2025-04-04
+
+### Fixed
+
+- Changed handling of an exception that could occur if the http response sensor was never added as a configured entity. Instead of an exception now only an info log message is shown.
+
+### Added
+
+- Added an option to change what should be shown in the http response sensor and media player title if no match has been found for the configured regular expression
+
 ## [0.7.1] - 2025-03-16
 
 ### Changed

README.md

@@ -123,9 +123,9 @@ If you activate the option to ignore HTTP requests errors in the integration set
 
 #### 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 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. If the sensor entity has not been added as a configured entity in the web configurator a info message will be shown in the integration log.
 
-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.
+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. The advanced setup has an option to use an empty response or show an error message instead if no match has been found.
 
 #### Legacy syntax
 

driver.json

@@ -1,7 +1,7 @@
 {
   "driver_id": "requests",
-  "version": "0.7.1",
-  "release_date": "2025-03-16",
+  "version": "0.7.2",
+  "release_date": "2025-04-04",
   "min_core_api": "0.24.3",
   "name": { 
       "en": "HTTP requests, WoL & text over TCP",
@@ -10,7 +10,7 @@
   "icon": "uc:webhook",
   "description": {
       "en": "A network multi tool integration to send HTTP get/post/patch/put/delete/head requests, wake-on-LAN magic packets and text over tcp",
-      "de": "Eine Netzwerk Multitool-Integration zum Senden von HTTP Get/Post/Patch/Put/Delete/Head-Anfragen, Wake-on-LAN Magic Pakets und Text über TCP"
+      "de": "Eine Netzwerk Multi-Tool-Integration zum Senden von HTTP Get/Post/Patch/Put/Delete/Head-Anfragen, Wake-on-LAN Magic Pakets und Text über TCP"
   },
   "port": 9081,
   "developer": {

intg-requests/config.py

@@ -25,6 +25,12 @@ class Setup:
         "rq_fire_and_forget": False,
         "rq_legacy": False,
         "rq_response_regex": "",
+        "rq_response_nomatch_option": "full",
+        "rq_response_nomatch_dropdown_items": [
+                                                {"id": "full", "label": {"en": "Full", "de": "Komplett"}},
+                                                {"id": "empty", "label": {"en": "Empty", "de": "Leer"}},
+                                                {"id": "error", "label": {"en": "Error", "de": "Fehler"}}
+                                                ],  
         "id-rq-sensor": "http-response",
         "name-rq-sensor": {
                         "en": "HTTP Request Response",
@@ -51,9 +57,10 @@ class Setup:
                         },
     }
     __setters = ["standby", "setup_complete", "setup_reconfigure", "tcp_text_timeout", "rq_timeout", "rq_user_agent", "rq_ssl_verify", \
-                 "rq_fire_and_forget", "rq_legacy", "rq_response_regex", "bundle_mode", "cfg_path"]
+                 "rq_fire_and_forget", "rq_legacy", "rq_response_regex", "rq_response_nomatch_option", "bundle_mode", "cfg_path"]
     #Skip runtime only related values in config file
-    __storers = ["setup_complete", "tcp_text_timeout", "rq_timeout", "rq_user_agent", "rq_ssl_verify", "rq_fire_and_forget", "rq_legacy", "rq_response_regex"]
+    __storers = ["setup_complete", "tcp_text_timeout", "rq_timeout", "rq_user_agent", "rq_ssl_verify", "rq_fire_and_forget", "rq_legacy", \
+    "rq_response_regex", "rq_response_nomatch_option"]
 
     all_cmds = ["get", "post", "patch", "put", "delete", "head", "wol", "tcp-text"]
     rq_ids = [__conf["id-rq-sensor"], __conf["id-get"], __conf["id-post"], __conf["id-patch"], __conf["id-put"], __conf["id-delete"], __conf["id-head"]]

intg-requests/driver.py

@@ -147,10 +147,12 @@ async def on_subscribe_entities(entity_ids: list[str]) -> None:
     """
     _LOG.info("Received subscribe entities event for entity ids: " + str(entity_ids))
 
-    config.Setup.set("standby", False)
+    #TODO #WAIT Add api.configured_entities.add(definition) when the unsubscribe event is handled by the integration API
 
+    config.Setup.set("standby", False)
 
 
+# Doesn't work as the unsubscribe event is not handled by the integration API
 @api.listens_to(ucapi.Events.UNSUBSCRIBE_ENTITIES)
 async def on_unsubscribe_entities(entity_ids: list[str]) -> None:
     """
@@ -162,6 +164,8 @@ async def on_unsubscribe_entities(entity_ids: list[str]) -> None:
     """
     _LOG.info("Unsubscribe entities event for entity ids: %s", entity_ids)
 
+    #TODO #WAIT Add api.configured_entities.remove(entity_ids) when the unsubscribe event is handled by the integration API
+
 
 
 def setup_logger():

intg-requests/media_player.py

@@ -30,7 +30,7 @@
 
 
 def get_mac(param: str):
-    """Accepts mac, ip addresses or hostnames. Get the mac address or checks if the mac address is valid.\
+    """Accepts mac, ip addresses or host names. Get the mac address or checks if the mac address is valid.\
     If the mac address can not be discovered a value error is raised"""
 
     try:
@@ -63,7 +63,7 @@ def get_mac(param: str):
                     _LOG.info("Got mac address from entered ipv4 ip: " + param)
                 if param == "" or param is None:
                     raise OSError("Could not convert ipv4 with getmac module. Discover the mac address from an ip address or a hostname may not work on all systems. \
-    Please refer to the getmac supported platforms (https://github.com/GhostofGoes/getmac?tab=readme-ov-file#platforms-currently-supported)")
+Please refer to the getmac supported platforms (https://github.com/GhostofGoes/getmac?tab=readme-ov-file#platforms-currently-supported)")
             except AddressValueError:
                 try:
                     IPv6Address(param)
@@ -75,7 +75,7 @@ def get_mac(param: str):
                         _LOG.info("Got mac address from entered ipv6 ip: " + param)
                     if param == "" or param is None:
                         raise OSError("Could not convert ipv6 with getmac module. Discover the mac address from an ip address or a hostname may not work on all systems. \
-    Please refer to the getmac supported platforms (https://github.com/GhostofGoes/getmac?tab=readme-ov-file#platforms-currently-supported)")
+Please refer to the getmac supported platforms (https://github.com/GhostofGoes/getmac?tab=readme-ov-file#platforms-currently-supported)")
                 except AddressValueError as v:
                     raise ValueError(v) from v
 
@@ -133,6 +133,7 @@ def parse_rq_response(response: str):
     """Parse http request response with configured regular expression"""
 
     regex = config.Setup.get("rq_response_regex")
+    nomatch_option = config.Setup.get("rq_response_nomatch_option")
 
     if regex == "":
         parsed_response = response
@@ -143,9 +144,18 @@ def parse_rq_response(response: str):
             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")
+            _LOG.warning("No matches found in the http request response for the regular expression " + regex)
+
+            if nomatch_option == "full":
+                _LOG.debug("The full response will be used instead")
+                parsed_response = response
+            elif nomatch_option == "error":
+                _LOG.debug("An error message will be used instead")
+                #TODO #WAIT Add a translation for the error message when get_localization_cfg() is implemented in the Python API
+                parsed_response = "No match found"
+            elif nomatch_option == "empty":
+                _LOG.debug("An empty response will be used instead")
+                parsed_response = ""
 
     return parsed_response
 
@@ -158,7 +168,12 @@ def update_response(method:str, response: str):
 
     parsed_response = parse_rq_response(response)
 
-    sensor.update_rq_sensor(config.Setup.get("id-rq-sensor"), parsed_response)
+    try:
+        sensor.update_rq_sensor(config.Setup.get("id-rq-sensor"), parsed_response)
+    except ModuleNotFoundError as f:
+        _LOG.info(f)
+    except Exception as e:
+        _LOG.error(e)
 
     update_rq_media_widget(entity_id, parsed_response)
 
@@ -445,7 +460,8 @@ async def mp_cmd_assigner(entity_id: str, cmd_name: str, params: dict[str, Any]
 
             try:
                 #TODO Run via asyncio.gather() to prevent potential blocking the event loop
-                send_magic_packet(*macs, **params) #Unpack macs list with * and params dicts list with **
+                await asyncio.gather(asyncio.to_thread(send_magic_packet, *macs, *params), asyncio.sleep(0)) #Unpack macs list with * and params dicts list with **
+                #send_magic_packet(*macs, **params) #Unpack macs list with * and params dicts list with **
             except ValueError as v:
                 _LOG.error(v)
                 return ucapi.StatusCodes.BAD_REQUEST

intg-requests/sensor.py

@@ -8,8 +8,8 @@
 
 _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
+#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
 
 
 async def add_rq_sensor(ent_id: str, name: str):
@@ -42,6 +42,6 @@ def update_rq_sensor(entity_id: str, response: str):
         raise Exception("Error while updating sensor value for entity id " + entity_id) from e
 
     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")
+        raise ModuleNotFoundError("Sensor entity " + entity_id + " not found or added as configured entity. Skipping update.")
 
     _LOG.info("Updated http request response sensor value to " + response)

intg-requests/setup.py

@@ -89,13 +89,18 @@ async def handle_driver_setup(msg: ucapi.DriverSetupRequest,) -> ucapi.SetupActi
             #TODO Remove legacy syntax in a future version
             rq_legacy = config.Setup.get("rq_legacy")
             rq_response_regex = config.Setup.get("rq_response_regex")
+            rq_response_nomatch_option = config.Setup.get("rq_response_nomatch_option")
+            rq_response_nomatch_dropdown_items = config.Setup.get("rq_response_nomatch_dropdown_items")
         except ValueError as v:
             _LOG.error(v)
 
+        #TODO Remove legacy syntax in a future version
         _LOG.debug("Currently stored - tcp_text_timeout: " + str(tcp_text_timeout) + " , rq_timeout: " + str(rq_timeout) + " , \
 rq_ssl_verify: " + str(rq_ssl_verify) + " , rq_fire_and_forget: " + str(rq_fire_and_forget) + ", \
-rq_user_agent: " + str(rq_user_agent) + ",  rq_legacy: " + str(rq_legacy) + ", rq_response_regex: " + str(rq_response_regex))
+rq_user_agent: " + str(rq_user_agent) + ",  rq_legacy: " + str(rq_legacy) + ", rq_response_regex: " + str(rq_response_regex) + ", \
+rq_response_options: " + str(rq_response_nomatch_option))
 
+        #TODO Remove legacy syntax in a future version
         return ucapi.RequestUserInput(
             {
                 "en": "Configuration",
@@ -174,6 +179,18 @@ async def handle_driver_setup(msg: ucapi.DriverSetupRequest,) -> ucapi.SetupActi
                                         }
                             },
                 },
+                {
+                    "id": "rq_response_nomatch_option",
+                    "label": {
+                        "en": "Response if no match for the regular expression has been found:",
+                        "de": "Antwort, falls keine Übereinstimmung mit dem regulären Ausdruck gefunden wurde:"
+                        },
+                    "field": {"dropdown": {
+                                        "value": rq_response_nomatch_dropdown_items[0]["id"],
+                                        "items": rq_response_nomatch_dropdown_items
+                                        }
+                            },
+                },
                 {
                     "id": "rq_ssl_verify",
                     "label": {
@@ -239,6 +256,7 @@ async def  handle_user_data_response(msg: ucapi.UserDataResponse) -> ucapi.Setup
     #TODO Remove legacy syntax in a future version
     rq_legacy = msg.input_values["rq_legacy"]
     rq_response_regex = msg.input_values["rq_response_regex"]
+    rq_response_nomatch_option = msg.input_values["rq_response_nomatch_option"]
 
     rq_timeout = int(rq_timeout)
     tcp_text_timeout = int(tcp_text_timeout)
@@ -275,6 +293,14 @@ async def  handle_user_data_response(msg: ucapi.UserDataResponse) -> ucapi.Setup
         return ucapi.SetupError()
     _LOG.info("Http request response regular expression: \"" +  str(rq_response_regex) + "\"")
 
+    try:
+        config.Setup.set("rq_response_nomatch_option", rq_response_nomatch_option)
+    except Exception as e:
+        _LOG.error(e)
+        config.Setup.set("setup_complete", False)
+        return ucapi.SetupError()
+    _LOG.info("Http request response option: \"" +  str(rq_response_nomatch_option) + "\"")
+
     if rq_ssl_verify == "true": #Boolean in quotes as all values are returned as strings
         try:
             config.Setup.set("rq_ssl_verify", True)