Ataraxis-communication-interface

Minor Feature Update

1. Introduces a global extract_logged_hardware_module_data() function that can be used to extract the data logged by a ModuleInterface instance without initialized ModuleInterface and MicroControllerInterface objects. Primarily, this allows parallelizing data processing.
2. MicroControllerInterface now has a 'log_path' property which returns the Path to the compressed .npz archive. This path can be provided to the global extraction function to parse the data stored in the archive. Note, the extraction function also requires the module-type and module_id codes available as properties of ModuleInterface class instances.
3. Also includes minor ReadMe and docstring optimizations.

What's Changed
* Added multiprocessing-safe, instance-independent log parsing by Inkaros in https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/pull/5


**Full Changelog**: https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/compare/3.0.2...3.1.0

Minor Bugfix

1. Fixed MicroControllerInterface runtime cycle error that prevented it from properly working with modules whose parse_mqtt_command method returned None due to directly submitting the message to the microcontroller transmission queue.

What's Changed
* Minor bugfix by Inkaros in https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/pull/4


**Full Changelog**: https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/compare/3.0.1...3.0.2

Minor Bugfix and ModuleInterface API enhancement
- Critically, added a new abstract method to ModuleInterface. The method allows cleaning up interface assets that were initialized in the remote communication process.

What's Changed
* Bugfixes by Inkaros in https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/pull/3


**Full Changelog**: https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/compare/3.0.0...3.0.1

Major API changes and QoL updates
-- Critically, the library now depends on ataraxis-data-structures 3.0.0.
-- Added support for python 3.13.
-- Added the ability to send data to the communication process directly from ModuleInterface classes.
-- Expanded log parsing to extract more data for each module.
-- Improved MicroControllerInterface resource management and cleanup during unexpected (error) shut-downs
-- Reworked ModuleInterface abstract methods to give developers more freedom for implementing custom data processing and routing logic. This change breaks all existing ModuleInterfaces however, as it involved refactoring one method and adding a new
method.

What's Changed
* 2.0.1 by Inkaros in https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/pull/2


**Full Changelog**: https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/compare/2.0.0...3.0.0

Major Version
- Refactored UnityCommunication to MQTTCommunication. This better communicates the purpose of the communication class and its ability to interact with any other process or client, local or remote, over MQTT protocol.

What's Changed
* Refactored UnityCommunication to MQTTCommunication by Inkaros in https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/pull/1

New Contributors
* Inkaros made their first contribution in https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/pull/1

**Full Changelog**: https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/compare/1.0.0...2.0.0

First Release

**Full Changelog**: https://github.com/Sun-Lab-NBB/ataraxis-communication-interface/commits/1.0.0