.. _changelog_v1_5_0:

v1.5.0
======

v1.5.0 updates the core to **MicroPython v1.8**, enables the :mod:`machine`
module, re-implements **line filters with Python callbacks**, switches to
MicroPython's SD-card module, and adds bootloader filesystem-erase and
binary-image loading options. The MicroPython bump is a behavior change — read
the breaking changes below.

.. contents:: On this page
   :local:
   :depth: 1

Highlights
----------

- **MicroPython v1.8** core update.
- :mod:`machine` module enabled.
- **Python line filters** — line filters re-implemented with Python
  callbacks.
- **SD card** — now uses MicroPython's SD-card module.
- **Breaking:** MicroPython was updated to v1.8 — see the breaking changes.

New features
------------

- Enabled the MicroPython :mod:`machine` module; re-implemented line filters
  with Python callbacks (with a ``line_filter.py`` example); added a
  timer-callback example and an updated PWM example.
- **Bootloader / pydfu** — added an option to erase the filesystem sectors,
  support for loading binary images from ``pydfu.py``, and a combined binary
  for the programming jig.

Other changes and improvements
------------------------------

- Updated the bundled MicroPython to v1.8 (and updated the firmware code for
  it); enabled some MicroPython optimizations; switched the SD card to
  MicroPython's SD-card module; removed the old CC3000 (CC3K) WiFi driver
  code.

Bug fixes
---------

- Fixed MLX / :mod:`fir` memory issues and the base priority during a
  soft-reset.

Breaking API changes
--------------------

User-visible API breaks between v1.4.0 and v1.5.0. Scope: Python C-modules in
``modules/`` and Python libraries in ``scripts/libraries/``.

The breaking change is a *behavior* change (same API, different results) —
re-check affected scripts. Each commit hash links to its diff on GitHub.

.. _v1_5_0_micropython:

MicroPython updated to v1.8 *(behavior)*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The bundled MicroPython core was updated to v1.8. Standard-library and
language behavior follows upstream MicroPython 1.8; re-check scripts that
depend on version-specific :mod:`micropython` / standard-module behavior.

*Commits:* `8e503f414 <https://github.com/openmv/openmv/commit/8e503f414>`__

.. _v1_5_0_migration:

Migration checklist
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Re-validate scripts that depend on version-specific MicroPython behavior
against v1.8 (:ref:`the MicroPython bump <v1_5_0_micropython>`). All other
scripts run unchanged.