.. _breaking_changes:

Breaking Changes
================

2026.7.0
---------

**Unified option enumeration for acquisition devices**

The vendor-specific methods for enumerating device options have been removed and replaced by a single unified method:

- :py:class:`VimbaCompatibleCamera <herosdevices.hardware.allied_vision.vimba_camera.VimbaCompatibleCamera>`: ``get_config_features()`` → use ``get_available_options()``
- :py:class:`DcamCompatibleCamera <herosdevices.hardware.hamamatsu.dcam_camera.DcamCompatibleCamera>`: ``get_all_properties()`` → use ``get_available_options()``
- :py:class:`PeakCompatibleCamera <herosdevices.hardware.ids.peak_camera.PeakCompatibleCamera>`: ``get_config_nodes()`` → use ``get_available_options()``

The public method ``get_available_options()`` is now defined on :py:class:`herosdevices.core.templates.acq_device.AcquisitionDeviceTemplate` and returns a ``dict`` mapping option names to their properties.


**DCAM return type change**

:py:class:`~herosdevices.hardware.hamamatsu.dcam_camera.DcamCompatibleCamera` now returns a ``dict`` keyed by property name from ``get_available_options()`` instead of a ``list[tuple]``. Each entry contains the property ``id`` (hex string) and ``value``:

.. code-block:: python

    # before
    [("0x10000001: ", "DCAM_IDPROP.TRIGGERSOURCE", 1), ...]

    # after
    {"DCAM_IDPROP.TRIGGERSOURCE": {"id": "0x10000001", "value": 1}, ...}