Skip to content

Changelog

All notable changes to this project will be documented in this file. The format uses NEW (added), CHG (changed), FIX (fixed) markers.

1.0.2 — 2026-04-03

  • CHG: Package documentation now published to official DSPC dochub site; Markdown docs no longer distributed within the package (smaller package, fewer dependencies)
  • CHG: Changelog using leaner formatting now

1.0.1 — 2026-01-26

  • FIX: Package description fixed

1.0.0 — 2026-01-21

  • CHG: License update and version bump for first public release

0.9.1 — 2025-12-08

  • FIX: AweCmdCreateLookupTable handles a payload now

0.9.0 — 2025-09-30

  • CHG: Parser change for ClassLayout_Constructor to support old and new AWE8 protocol formats (protocol break in AWE8); only parsing is safe — no AWB content creation yet

0.8.0 — 2025-07-04

  • NEW: AWB files with Bundle packets can be flattened via flatten()

0.7.1 — 2025-06-24

  • FIX: Payload of BundlePacket commands is no longer ignored

0.7.0 — 2025-06-16

  • NEW: order_by_core_id_list() for splitting/combining AWB data (separating early/late audio commands)
  • CHG: Class ID list updated with Subcanvas related modules
  • CHG: Internal CM/CI changes; UV installer used as backend for hatch

0.6.1 — 2025-06-05

  • CHG: Internal CM/CI changes only

0.6.0 — 2025-06-03

  • NEW: Support for PFID_SetProfilingStatus, PFID_GetProfilingStatus, PFID_SetProfilingOptions, PFID_GetProfilingOptions, PFID_ClearProfilingValues, PFID_ResetState, PFID_ResetModule, PFID_BundlePackets

0.5.0 — 2025-04-11

  • NEW: Dumping AWB content now shows class name alongside classID value (e.g. classID = (enum) ModuleAGCLimiterCoreV2 3203336429)
  • CHG: class_id_counts() now returns classId -> {'cnt': ..., 'name': ...} instead of just count

0.4.3 — 2024-02-11

  • FIX: AWB split via AwbFile.split no longer produces destroy/audio-start commands with length 0 (corrected to 2)

0.4.2 — 2024-12-16

  • CHG: awb-docs script renders HTML documentation differently; use pip install pyawe_awb[doc] for on-the-fly generation

0.4.1 — 2024-12-16

  • FIX: AwbFile.build handles empty objects and objects without EOF marker

0.4.0 — 2024-12-09

  • NEW: --show-cmdindex flag to include command index when printing file info
  • NEW: --cmdindex parameter to pick a specific command by index
  • NEW: split() to split AWB files along coreId/endpointId
  • NEW: AwbFile.build to serialize AwbFile instance data into raw bytes
  • NEW: --as_string parameter to interpret payload.values as ASCII string
  • NEW: class_id_counts property
  • NEW: Constructor methods for creating from stream or buffer
  • CHG: BREAKING — AWB commands now use consistent PFID names (e.g. create_wire → ClassWire_Constructor)
  • CHG: Complete file printout no longer shows ListContainer; uses a plain list

0.3.0 — 2024-04-08

0.2.0 — 2024-03-27

  • NEW: awb-trace script for pretty-printing packet.log and matlab_command.log
  • NEW: Query AWB data for module IDs and coreIds (multi-instance)
  • NEW: verify_against() to check which IDs are used by an AWB
  • NEW: diff() to compare two AWB files; also available via awb-diff
  • NEW: awb-docs script to show HTML documentation in the browser
  • CHG: BREAKING — AwbFile now created with AwbFile.from_file("filename")
  • CHG: BREAKING — All scripts now prefixed with awb-
  • CHG: --layout parameter renamed to --show-pininfo
  • FIX: Size calculation for -p parameter of awb-file
  • FIX: --coreid allows setting to 0

0.1.0 — 2023-11-22

  • NEW: First version of AWB file reader
  • NEW: awe-awbfile script for command line usage
  • NEW: Properties for querying I/O pin info and number of instances encoded in the AWB file