Changelog¶
What changed in each release of the driver. Entries under Breaking need source changes in code that used the affected API.
[Unreleased]¶
Added¶
- First version: a C++20 driver for the PyroScience FDO2-G2 and the legacy FDO2 optical oxygen modules on UART.
- Start-up,
#MOXYand#MRAWmeasurements, the oxygen fraction from the module's pressure, identity and capabilities by firmware revision. - A status policy (
Datasheetby default,Documented) and plausibility windows. - Calibration (zero, high, air), the checksum, the baud rate, the broadcast stream, the measurement mode and the
user memory. Every command that writes flash needs
allow_persistent_writesand is counted againstmax_flash_writes; none is ever repeated. - Blocking calls and start calls with
Poll(), with or without a clock in the port. - A host example and ESP-IDF examples (blocking and non-blocking).
- Flash-write guard: every flash command is preceded by a
#VERSidentity check, and#CALOand#CAHIby a#MOXYreading that must be good, warmed up and near the value to store (Config::cal_window_pct,cal_window_min_mhpa,Error::NotReady).FlashWritePending()andStreamSilentMs()observers. Resync()tries both checksum settings at each rate.- A host test of the ESP32 example port against stubs of the ESP-IDF headers.
- Not verified on hardware.
Changed¶
CalibrateHigh()accepts 10 to 2000 hPa.Deinitialize()returnsBusywhile a flash write is pending;PowerCycle()waits for it; an aborted or failedEnsureInitialized()leaves the driver uninitialised so the next call identifies the module again.- An unexpected
#ERROon a flash write leaves the stateStateUnknown. - The reference circuit for a 5 V controller uses a 10 kOhm and 12 kOhm divider (3.0 V at 5.5 V on RXD, below the 3.3 V maximum).
Fixed¶
#MOXYis documented without an argument (the examples showed#MOXY 1).- Getters no longer return the value of an earlier call after a failed one;
Resync()no longer overwrites the stored identity and works inStateUnknownwhile streaming. EncodeCommand()andFindCommand()no longer read outside their tables.- The ESP32 example runs with the default power pin -1.
- The ESP32 examples list the
esp_timercomponent they include. - Characters are no longer used as numbers in the protocol layer (MISRA C++:2023 Rule 7.0.3).