vban-cmd-python/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Before any major/minor/patch bump all unit tests will be run to verify they pass.

[Unreleased]

[2.0.0] - 2023-06-25

This update introduces some breaking changes:

Changed

• strip[i].comp now references StripComp class

  • To change the comp knob you should now use the property strip[i].comp.knob

• strip[i].gate now references StripGate class

  • To change the gate knob you should now use the property strip[i].gate.knob

• bus[i].eq now references BusEQ class

  • To set bus[i].{eq,eq_ab} as before you should now use bus[i].eq.on and bus[i].eq.ab

• new error class VBANCMDConnectionError raised when a connection fails or times out.

There are other non-breaking changes:

Changed

• now using a producer thread to send events to the updater thread.
• factory.request_vbancmd_obj simply raises a VBANCMDError if passed an incorrect kind.
• module level loggers implemented (with class loggers as child loggers)

Added

• strip[i].eq added to PhysicalStrip

[1.8.0]

Added

• Connection section to README.

Changed

• now using clear_dirty() when sync enabled.

Fixed

• bug in set_rt() where multiple commands sent in single request packet.
• bug in apply where index was sent twice.

[1.7.0]

Added

• ability to read conn info from vban.toml config

Changed

• assume a vban.toml in examples. README's modified.

[1.6.0] - 2022-10-06

Added

• fadeto(), fadeby() methods added to strip/bus classes.
• OBS example added.

Changed

• Event class add/remove now accept iterables.
• property setters added to Event class.
• ldirty logic moved into VbanRtPacket class.
• in util, threshold a level is considered dirty moved to 7200 (-72.0)
• now print bus levels in observer example.

Fixed

• initialize comps in updater thread. fixes bug when switching to a kind before any level updates

[1.5.0] - 2022-09-28

Changed

• Logging module used in place of print statements across the interface.
• base error name changed (VBANCMDError)

Fixed

• Timeout and raise connection error when socket connection fails.
• Bug in observer example

[1.4.0] - 2022-09-03

Added

• tomli/tomllib compatibility layer to support python 3.10

[1.3.0] - 2022-08-02

Added

• Keyword argument subs for vban_cmd.api. Provides control over which updates to receive.
• Event class added to misc. Toggle events, get list of currently subscribed.
• vban_cmd.api section added to README in Base Module section.
• observer example updated to reflect changes.
• alias property isdirty for is_updated in strip/bus levels

Changed

• By default no longer listen for level updates (high volume). Should be enabled explicitly with subs kwarg.

[1.2.0] - 2022-07-15

Added

• get() added to bus mode mixin. returns the current bus mode.
• support for setting bus mode in toml config
• levels, gainlayers, bus modes sections added to readme.
• test_configs to unit tests
• test_factory to unit tests

Changed

• type checks removed.
• inputlevels/outputlevels in VBAN_VMRT_Packet_Data now generator functions

Fixed

• is_updated in strip/bus levels now returns a bool, is level dirty or not?

[1.1.0] - 2022-06-20

Added

• pre-commit.ps1 added for use with git hook

Changed

• No longer passing data in ldirty notification.

Fixed

• bug fixed in TOMLStrBuilder.

[1.0.0] - 2022-06-16

Added

• project now packaged with poetry and added to pypi.

Changed

• factory method now using director/builder classes.
• config now using loader to manage configs in memory.
• TOMLStrBuilder added to config, builds a config as a string for the toml parser.
• kinds mapped as dataclasses
• major version bump due to dependency change. Now requires python 3.11+

[0.4.0] - 2022-04-14

Added

• support for observers added.
• pdirty, ldirty notifications defined.

[0.3.0] - 2022-04-01

Added

• strip_levels, bus_levels property objects added to base class. These now return the full level array.
• filter out empty values from strip_levels/bus_levels
• script decorator added to sendtext() in base class. Now supports passing a nested dict, similar to apply()
• pre-commit.ps1 added for use with git hook. test badges added to readme.
• genbadge added to development dependencies in setup.py
• Lower tests added.

Changed

• mc getter implemented in strip class
• bus modes meta function reworked.
• sendtext() now for multi set operationis (used by apply() method)
• tests now run according to a kind, for a single run version is random.
• now using psuedo decorator functions cache_bool and cache_string to handle caching.
• meta functions reworked.
• strip bool props moved into factory function.

Fixed

• fixed size of recvfrom buffer for self.rt_packet_socket in base class
• nose tests migrated to pytest as nose will not be supported in python 3.10+
• sendtext() removed from readme. Still in interface but not advised to use since it doesn't update cache.

[0.2.0] - 2022-03-29

Added

• profiles module
• example profiles added to _profiles/ directory.

Changed

• setup/teardown moved into login()/logout() functions in base class.
• now using black formatter, code style badge added to readme.

Fixed

• bus/strip labels split at null terminator in ascii string.
• all gainlayers added to isdirty() function in VBAN_VMRT_Packet_Data

[0.1.0] - 2022-03-21

Added

• gain property added to strip class.
• added worker2 thread for keeping the public packet constantly updated in the background.
• self.running flag for notifying threads when to stop.
• docstrings added to base class.
• apply() added to base class and strip/bus classes. supports setting parameters through dict.
• bus modes mixin added to bus class
• isdirty() added to VBAN_VMRT_Packet_Data for precisely defining the dirty parameter.

Changed

• underscore removed from package name. https://peps.python.org/pep-0008/#package-and-module-names
• readme updated to reflect changes.
• boolean strip/bus properties now defined by meta functions.

Fixed

• fixed kind map ins, outs order. (causing error with basic version)

[0.0.1] - 2022-02

Added

• Create the base class, setup entry point to interface.
• worker thread added to keep interface registered to the rt packet service
• Added definitions for rt packet data and the various packet headers, as dataclasses.
• Property objects in data packet dataclass for returning byte tuples/parsing string params.
• Adding kinds module for mapping each Voicemeeter version to a namedtuple.
• Added meta module.
• Strip/Bus modules added.
• Modes dataclass for defining strip states through bit modes.
• GainLayer added to strip module. gainlayer properties added as mixin.
• Higher unit tests added.
• show(), hide(), shutdown() and restart() added to base class.
• Add initial version of readme.
• add property objects sr, nbc and streamname to TextRequestHeader. Now settable by kwargs.