fixes bug with apply() if called from higher class

to more accurately describe its purpose.

CHANGELOG.md

@@ -11,15 +11,21 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 -   [x]
 
-## [2.1.0] - 2023-07-05
+## [2.1.2] - 2023-07-05
 
 ### Added
 
--   `sendtext_only` kwarg let's you disable incoming rt packets. Essentially the interface will work only in one direction (out).
+-   `outbound` kwarg let's you disable incoming rt packets. Essentially the interface will work only in one direction.
 
-This is useful if you are only interested in sending script commands out to voicemeeter but don't need to receive parameter states.
+This is useful if you are only interested in sending commands out to voicemeeter but don't need to receive parameter states.
 
-By default sendtext_only is False.
+By default outbound is False.
+
+-   sendtext logging added in base class.
+
+### Fixed
+
+-   Bug in apply() if invoked from a higher class (not base class)
 
 ## [2.0.0] - 2023-06-25
 

README.md

@@ -461,7 +461,7 @@ You may pass the following optional keyword arguments:
 -   `pdirty`: boolean=False, parameter updates
 -   `ldirty`: boolean=False, level updates
 -   `timeout`: int=5, amount of time (seconds) to wait for an incoming RT data packet (parameter states).
--   `sendtext_only`: boolean=False, set `True` if you are only interested in sending script commands (no rt packets will be received)
+-   `outbound`: boolean=False, set `True` if you are only interested in sending commands. (no rt packets will be received)
 
 #### `vban.pdirty`
 
@@ -479,8 +479,6 @@ Sends a script block as a string request, for example:
 vban.sendtext("Strip[0].Mute=1;Bus[0].Mono=1")
 ```
 
-note. if you are ONLY interested in sending script commands you may set sendtext_only kwarg to True
-
 #### `vban.public_packet`
 
 Returns a `VbanRtPacket`. Designed to be used internally by the interface but available for parsing through this read only property object. 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vban-cmd"
-version = "2.1.0"
+version = "2.1.2"
 description = "Python interface for the VBAN RT Packet Service (Sendtext)"
 authors = ["onyx-and-iris <code@onyxandiris.online>"]
 license = "MIT"

vban_cmd/factory.py

@@ -71,7 +71,7 @@ class FactoryBase(VbanCmd):
             "channel": 0,
             "ratelimit": 0.01,
             "timeout": 5,
-            "sendtext_only": False,
+            "outbound": False,
             "sync": False,
             "pdirty": False,
             "ldirty": False,

vban_cmd/iremote.py

@@ -102,7 +102,7 @@ class IRemote(metaclass=ABCMeta):
     def setter(self, param, val):
         """Sends a string request RT packet."""
         self.logger.debug(f"setter: {self._cmd(param)}={val}")
-        self._remote._set_rt(self.identifier, param, val)
+        self._remote._set_rt(self._cmd(param), val)
 
     def _cmd(self, param):
         cmd = (self.identifier,)
@@ -141,10 +141,10 @@ class IRemote(metaclass=ABCMeta):
             else:
                 target = getattr(self, attr)
                 target.apply(val)
+
+        self._remote.sendtext(self._remote._script)
         return self
 
     def then_wait(self):
-        self.logger.debug(self._remote._script)
-        self._remote.sendtext(self._remote._script)
         self._remote._script = str()
         time.sleep(self._remote.DELAY)

vban_cmd/vbancmd.py

@@ -48,6 +48,7 @@ class VbanCmd(metaclass=ABCMeta):
         self.cache = {}
         self._pdirty = False
         self._ldirty = False
+        self._script = str()
 
     @abstractmethod
     def __str__(self):
@@ -85,8 +86,8 @@ class VbanCmd(metaclass=ABCMeta):
         return self
 
     def login(self):
-        """Starts the subscriber and updater threads (unless sendtext_only mode)"""
-        if not self.sendtext_only:
+        """Starts the subscriber and updater threads (unless in outbound mode)"""
+        if not self.outbound:
             self.running = True
             self.event.info()
 
@@ -101,34 +102,28 @@ class VbanCmd(metaclass=ABCMeta):
 
         self.logger.info(f"{type(self).__name__}: Successfully logged into {self}")
 
-    def _set_rt(
-        self,
-        id_: str,
-        param: Optional[str] = None,
-        val: Optional[Union[int, float]] = None,
-    ):
+    def _set_rt(self, cmd: str, val: Union[str, float]):
         """Sends a string request command over a network."""
-        cmd = f"{id_}={val};" if not param else f"{id_}.{param}={val};"
         self.socks[Socket.request].sendto(
-            self.packet_request.header + cmd.encode(),
+            self.packet_request.header + f"{cmd}={val};".encode(),
             (socket.gethostbyname(self.ip), self.port),
         )
         self.packet_request.framecounter = (
             int.from_bytes(self.packet_request.framecounter, "little") + 1
         ).to_bytes(4, "little")
-        if param:
-            self.cache[f"{id_}.{param}"] = val
+        self.cache[cmd] = val
 
     @script
-    def sendtext(self, cmd):
+    def sendtext(self, script):
         """Sends a multiple parameter string over a network."""
         self.socks[Socket.request].sendto(
-            self.packet_request.header + cmd.encode(),
+            self.packet_request.header + script.encode(),
             (socket.gethostbyname(self.ip), self.port),
         )
         self.packet_request.framecounter = (
             int.from_bytes(self.packet_request.framecounter, "little") + 1
         ).to_bytes(4, "little")
+        self.logger.debug(f"sendtext: [{self.ip}:{self.port}] {script}")
         time.sleep(self.DELAY)
 
     @property
@@ -185,7 +180,6 @@ class VbanCmd(metaclass=ABCMeta):
             else:
                 raise ValueError(obj)
 
-        self._script = str()
         [param(key).apply(datum).then_wait() for key, datum in data.items()]
 
     def apply_config(self, name):