################################################################################
# MU_3SL Library
################################################################################

RELEASE NOTES
*************


Version 3.2.0 (May 16, 2023)
============================

NEW:
* Add support for iC-MU150 revision 3

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision B3
* Corresponds to the iC-MU datasheet revision F2,
                     iC-MU150 datasheet revision E1,
                     iC-MU200 datasheet revision B2
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2/Y2H(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11), 3(0x13),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 21H2

================================================================================

Version 3.1.0 (January 27, 2023)
================================

NEW:
* Add new functions MU_generateBissIdentifier and MU_generateBissProfileId
* Add new function MU_Calibration_numberOfAcquiredNoniusPeriods
* Add new function MU_Calibration_getOptimizedNoniusTrackOffsetTableBaseOnly

BUGFIXES:
* Error handling on nonius analysis fail in MU_Calibration_analyzeRawData
* Empty string termination for logDest in MU_Calibration_getAnalyzeResultLog
* Improvement of the function error handling of MU_SwitchToBiss and
  MU_SwitchToBiss_ex, if no chip revision is set
* Master and nonius track raw data interchanged detection in the function
  MU_Calibration_analyzeRawData
* Improvement of the error handling of the function
  MU_Calibration_analyzeRawData
* Improve the handling of (nonius) calibrations with a small number of samples.
* The number of revolutions is now calculated with the configured number of
  master periods.
* MU_GetParam with MU_SPO_15 now limits the value from -8 to 7.
* Writing multiple registers via BiSS (parameters with multiple registers) now
  works as intended.
* MT offset calculation error in function MU_MtSync_analyzeData in case of
  SBL_MT < 3.

ENHANCEMENT:
* Now it is possible to set MU_BP to 0 with MU_SetConfig to disable automatic
  update
* MU_Calibration_getAnalyzeResultLog now prints the number of detected nonius
  periods on note level
* Improved log error text of function MU_Calibration_getAnalyzeResultLog at less
  than 16 samples per period for analog calibration.

CHANGES:
* MB3U_BISS set the PIN 3 (MU1D demo board NSEL_BISS) to low

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision B2
* Corresponds to the iC-MU datasheet revision F2,
                     iC-MU150 datasheet revision D2,
                     iC-MU200 datasheet revision B2
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2/Y2H(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 21H2

================================================================================

Version 3.0.1 (June 29, 2022)
=============================

BUGFIXES:
* MU_activateMtSyncConfig backup OUT_LSB and set to 0
  (MU_deactivateMtSyncConfig restore OUT_LSB)
* MU_acquireMtSyncData now correctly includes OFF_ABZ in
  internalSingleTurnPosition
* MU_Calibration_adjustAnalogByAnalyzeResult and
  MU_Calibration_isAnalogAnalyzeResultAdjustable works now as intended with
  automatic phase range changes
* MU_ReadStatus and MU_ReadGain error handling improvement for non-BiSS
  connections (SPI)

CHANGES:
* Change byte order for parameter SERIAL to big-endian (as specified in the
  datasheet)

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision B1
* Corresponds to the iC-MU datasheet revision F2,
                     iC-MU150 datasheet revision D2,
                     iC-MU200 datasheet revision B2
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 21H2

================================================================================

Version 3.0.0 (December 10, 2021)
=================================

First release of new version 3.0

ENHANCEMENT:
* New analog and nonius calibration interface
* New analog calibration algorithm
* New multi turn synchronization interface

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision B1
* Corresponds to the iC-MU datasheet revision F2,
                     iC-MU150 datasheet revision D2,
                     iC-MU200 datasheet revision B2
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 21H1

================================================================================

Version 2.2.4 (Dec 1, 2021)
===============================

ENHANCEMENT:
* Interface MB3U_SPI performance enhancement

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A3
* Corresponds to the iC-MU datasheet revision F2,
                     iC-MU150 datasheet revision D2,
                     iC-MU200 datasheet revision B2
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 21H1

================================================================================

Version 2.2.2 (July 7, 2021)
===============================

ENHANCEMENT:
* MU_3TrackMtAnalyse: improvement of the calculation of the parameter SPO_MT

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A3
* Corresponds to the iC-MU datasheet revision F1,
                     iC-MU150 datasheet revision D1,
                     iC-MU200 datasheet revision B1
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 1909

================================================================================

Version 2.2.0 (April 13, 2021)
===============================

NEW:
* Add configuration option MU_ENABLE_TTL (MU_ConfigDataEnum) for MU_SetConfig and MU_GetConfig

BUGFIXES:
* MU_MtSyncActivateCfg enable GET_MT SSI write
* MU_SetConfig with MU_READ_STATUS_ENABLE and MU_READ_GAIN_ENABLE
* MU_3TrackMtAnalyse spo_MT output parameter

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A3
* Corresponds to the iC-MU datasheet revision F1,
                     iC-MU150 datasheet revision D1,
                     iC-MU200 datasheet revision B1
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 1909

================================================================================

Version 2.1.9 (February 5, 2021)
===============================

NEW:
* Function MU_CalculateSingleturnPosition to calculate an array with the singleturn position data
  at any sample of the (internal stored) master and nonius track raw data.

BUGFIXES:
* Continuous register read of status and gain (at any MU_ReadSens call)
* MU_MtSyncActivateCfg now writes the correct singleturn length to OUT_MSB
* MU_ReadSens interprets now the MODE_MT "data interpreted as ST" correct
* Calculation of output multiturn bit length
* switchToBiss bug if bank != 0
* MU_MtSyncDeactivateCfg with MB4U
* MU_GetCalData with MU_REFCONT and without external ref. data
* Minor bug fixes

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A2
* Corresponds to the iC-MU datasheet revision F1,
                     iC-MU150 datasheet revision D1,
                     iC-MU200 datasheet revision B1
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 1909

================================================================================

Version 2.1.7 (January 7, 2021)
===============================

BUGFIXES:
* Calibration issues fixed in a multichip application (more than one iC-MU).
* Minor bug fixes

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A1
* Corresponds to the iC-MU datasheet revision E3,
                     iC-MU150 datasheet revision C3,
                     iC-MU200 datasheet revision A3
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 1909

================================================================================

Version 2.1.6 (December 18, 2020)
===============================

BUGFIXES:
* Minor bug fixes

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A1
* Corresponds to the iC-MU datasheet revision E3,
                     iC-MU150 datasheet revision C3,
                     iC-MU200 datasheet revision A3
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 1909

================================================================================

Version 2.1.5 (December 2, 2020)
===============================

BUGFIXES:
* The update of BiSS profile ID and device ID now works as intended

CHANGES:
* Optimization of analog phase calibration (+-0.5 LSB better PH_M & PH_N) with iC-MU150 & iC-MU200

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A1
* Corresponds to the iC-MU datasheet revision E3,
                     iC-MU150 datasheet revision C3,
                     iC-MU200 datasheet revision A3
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 1909

================================================================================

Version 2.1.3 (October 1, 2020)
===============================

BUGFIXES:
* Add a hysteresis in the analog calibration phase adjustment of MU150 & MU200 for range selection parameters PHR_M and PHR_N

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A1
* Corresponds to the iC-MU datasheet revision E3,
                     iC-MU150 datasheet revision C3,
                     iC-MU200 datasheet revision A3
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 1909

================================================================================

Version 2.1.2 (August 28, 2020)
===============================

BUGFIXES:
* Backup and restore of parameters in MU_ActivateCalCfg, MU_DeactivateCalCfg, MU_FullCalibration, and MU_FullAcquisition
* MB4U & MB5U timeout on low frame rates (T >= 3.75ms)

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A1
* Corresponds to the iC-MU datasheet revision E3,
                     iC-MU150 datasheet revision C3,
                     iC-MU200 datasheet revision A3
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 1909

================================================================================

Version 2.1.1 (August 21, 2020)
===============================

BUGFIXES:
* Auto convert gray code to binary in MU_ReadSens if GSSI = 1
* Stability and performance upgrades for BiSS-Communication with adapters: MB4U & MB5U
* Use the calibration configuration value FREQ_SPI for the SPI communication with the functions: MU_Acquire, MU_FullCalibration, MU_FullAcquisition
* MU_EnableGetMT - switch to BiSS MT position dependent fail fix
* MU_DeactivateCalCfg parameter restore
* USB data loss detection in functions MU_Acquire, MU_FullAcquisition, and MU_FullCalibration
* BiSS Profile 3 (BP3) generation
* MB3U CRC check in MU_ReadSens
* MU_Adjust with three track mode

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A1
* Corresponds to the iC-MU datasheet revision E3,
                     iC-MU150 datasheet revision C3,
                     iC-MU200 datasheet revision A3
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 1909

================================================================================

Version 2.1.0 (July 20, 2020)
===============================

FEATURES:
* First stable release of this major version
* Chip communication support with iC-Haus USB-BiSS/SPI Adapters

NEW:
* This software supports iC-MU, iC-MU150 and iC-MU200. It replaces the individual chip specific libraries.
* Function for chip revision selection (MU_UseRevision(...))
  and many other functions for that handling.

CHANGES:
* Type of MU_Handle
* Naming of struct members
* Naming of enumerations
* Interface const correctness fixes
* Changed driver for the iC-Haus USB adapters MB4U and MB5U to libusb.
  The installation of the new iC-Haus USB drivers is required for using the current software version.
  After the installation of the new adapter drivers other iC-Haus GUI software might not work anymore due to using a different driver and should be updated.
  If you have problems please contact iC-Haus for assistance.

NOTES:
* Corresponds to the iC-MU Series Library Interface Description revision A1
* Corresponds to the iC-MU datasheet revision E3,
                     iC-MU150 datasheet revision C3,
                     iC-MU200 datasheet revision A3
* Supported iC-MU revisions: Y(0x05), Y1(0x06), Y2(0x07),
            iC-MU150 revisions: 0(0x10), 1(0x11),
            iC-MU200 revision: 0(0x20)
* Successfully tested on Windows 10 Version 1909

================================================================================

Version 2.0.3 beta (March 24, 2020)
===================================

BUGFIXES:
* Many smaller bug fixes

NOTES:
* Corresponding to the iC-MU Series Library INTERFACE DESCRIPTION version A0.9
================================================================================

Version 1.0 (March 27, 2019)
============================

FEATURES:
* Initial Release

NOTES:
* Corresponding library interface description soon available


================================================================================
Software Disclaimer

Software and its documentation is provided by iC-Haus GmbH or contributors
"AS IS" and is subject to the ZVEI General Conditions for the Supply of
Products and Services with iC-Haus amendments and the ZVEI Software clause with
iC-Haus amendments (www.ichaus.com/EULA).
================================================================================
