M81-SSM firmware update

Firmware update process

This process is not capable of handling a full OS update, which is required for some versions of firmware. See instructions for the update process.

NOTE: OS version 3 and higher requires the firmware to be version 2 and higher.

The easiest way to update instrument firmware is online:

1. Provide the instrument with an Internet connection using Wi-Fi or Ethernet
2. Access the update screen (System settings > Update)
3. The instrument will detect the latest firmware version, follow on-screen prompts to download and install the update

Updating an offline instrument is accomplished with the following steps:

1. Click on the desired version number below, which links to the .lsfw firmware update file.
2. Copy or save the .lsfw file onto the root directory of a USB flash drive. Make sure it is the only .lsfw file in that location.
3. Plug the flash drive into the USB-C port on the back of the instrument; if you don't have a newer flash drive with a USB-C connection, use the adapter supplied with the instrument.
4. On the M81-SSM front panel, tap the Settings menu (top left corner of the screen). Then tap System settings. Touch Update.
5. Click “Updates are available. Click here to install” and follow the on-screen instructions to update the firmware.

Note: Firmware comprises many files aggregated to form a Lake Shore firmware (.lsfw) package. The instrument stores versions of its .lsfw packages in its internal memory. This local memory location is called the “local repository.” This allows you to downgrade the firmware to older versions that remain on the instrument in the local repository.

M81-SSM Firmware Changelog

2.1.2024120307 — 24-12-10

Added

• Measure autoranging during a sweep
• Separate queries for requested and actual averaging time

Changed

• Show dashes in lock-in DC reading when high-pass digital filter is disabled
• Reorganized module settings on UI
• Enabled guard drive by default

Fixed

• Averaging time UI not updating from remote commands and UI showing invalid values

2.1.2024100910 — 24-10-17

Added

• Links to Lake Shore website when required
• Minimum and maximum dashboard values
• Data stream setup example in manual
• Service that detects orientation and notifies of changes
• Graph to better explain AC measurements in manual
• Edit and add info to parameter sweep manual page
• Range value added to % of range in banner
• DC measurement access in lock-in mode
• Sync sources invalid indicator
• Source autoranging functionality in a parameter sweep
• Suggested steps in manual for unused modules in experiments
• Helpful info when tapping resistance warning messages

Changed

• Pinned all Python requirements versions for manual
• Improved event handling subscription in setting view models
• Cleaned up SCPI doc wording
• Minor manual wording improvements and consolidation
• Reduced SingleReading memory allocations
• Audited info circles
• Moved guard setting from advanced to basic settings
• Moved CMR to advanced settings
• Removed relative baseline setting, made editable in banner
• Consolidated VS-10 DC range to one line
• Edited averaging time info circle
• Prohibited frequency source module from setting itself as the sync reference source
• Changed custom resistance tap symbol to an omega symbol
• Changed measure module AC mode "Observation Time" to "Averaging Time"
• Removed separate amplitude setting and moved capabilities into banner
• Renamed Common Mode Rejection to Common Mode Feedback and feedback source to common mode node
• Updated source frequency, roll-off, and BCS coupling to new default values (new source frequency = 11 Hz; new roll-off = 24 dB/oct; new BCS coupling = DC)
• Auto-couple to frequency of synced source if sync is enabled
• Removed offset and frequency settings, edit values from banner
• Renamed lock-in filters
• Corrected NPLC resolution for 60 Hz regions

Fixed

• Relative zero/clear text not updating
• Reworded settings profile message so text is not cut off
• Global autorange settle affecting seamless ranging
• Bug where amplitude zeroed from another channel changing ranges
• Lock-in blank page on startup
• Resistance reading added back to dashboard
• Variations in lock-in readings when doing ref in + digital high-pass filter
• Retain CMR SCPI command backwards functionality via aliases
• BCS-10 autocoupling not using sync source when sync enabled

2.0.2024010821 (OS update required) — 24-01-12

Added

• Rounding of dwell time to fit timing resolution
• Operating system update to support current development tools (Note: This and future updates include/require updated OS)
• Frequency sweeps added to parameter sweeping functionality
• Send remote NaN while source output change is still settling
• Detailed module communications readback errors
• AC amplitude sweeps added to parameter sweep function
• AC offset sweeps added to parameter sweep function

Changed

• Removed channel averaging reset after every step in a sweep
• Differentiated hybrid DAC AC ranges from "main" ranges
• Removed navigation animation to improve U/I response rates
• Sped up DAC code table calculation to improve source parameter update rates
• Hid relative baseline setting when in lock-in mode
• Frequency setting set to max allowable value when switching from DC to AC source mode
• Clarified minimum dwell time validation error message
• Updated the current protection level when the current measure changes the current range
• Make autorange decisions even if the measure isn't settled to improve throughput
• Hid amplitude RMS/PEAK display “chips” when RMS entry not supported
• Improved event logging details
• SCPI READ queries now asynchronous, pollable measurements
• Put all measures into a settling state if any module changes range

Fixed

• Settings profiles not updating properly
• Issues with the recently added validation for when both source and measure were set to current
• External web page links added in the manual's Remote Operation section
• Issue where SOURx:SWE:TIME does not take round-trip timing into account
• Backward SCPI SweepSubsystem command summaries
• Undo profile restore action
• Issue where all toolbar items are shown briefly on startup
• Round trip sweeps, DC sweeps continuing after aborting, late sweep status after aborting
• App crash when using SYStem:PREset and then setting up the lock-in
• Multi-channel sweeps end abruptly
• Source banners missing values in landscape orientation
• Seamless ranging discontinuity
• Validation error on startup
• Source amplitude display “chip” styling
• Invalid ranges sometimes displayed
• Sweep status to only change when a sweep actually starts
• Settings profiles not restoring periodically
• Empty tabs getting stuck in the home tab control

1.7.2023072809 — 23-08-09

Added

• Slow source value ramp down shutdown in error restart condition
• Model info circles containing general info and module pinout diagrams
• Support for importing and exporting settings profiles
• General improvements to the manual
• Source banners improved formatting
• Module revision compatibility check and validation error
• Show the USB icon when an external storage device is connected
• Re-add head calibration factors to source readback

Changed

• Loading any module will now load all connected and unloaded modules
• Reworded inaccurate validation error messages
• Replace inaccurate output limit errors messages
• Corrected ref in polarity inversion
• Reset FIR averaging when settings change for any channel
• Better FIR rejection of unwanted signals, 1 update per averaging time with update rate ceiling set to 1 update per second

Fixed

• Issue where settings profiles did not restore BCS disable on overload state
• Erroneous peak indications
• Monitor out configuration no longer shows unavailable channels for M81-2 and M81-4
• Issue where module name and notes section did not update after being edited by the user
• BCS and CM modules ranging transition/selection at full-scale issues improved
• Missing line on LIA ref in settings
• Ensure new indication offset self-calibration values to default to zero to prevent CM intermittent overload
• High-pass filter corner frequency limit
• Settings profiles not restoring
• Prevent display mode race condition from causing app crash
• Reset resistance source and relative baseline on module settings reset
• CM bias voltage resolution and accuracy
• Backwards signs on averaging window recalculation hysteresis
• Improve conditional source ranging transitions
• Update the peak detection window when the reference frequency changes
• Return actual range value instead of enumeration from FETCh:MULTiple?
• Issue where the z in mHz got cut off UI due to the width of the text
• Account for FIR and IIR enable setting in the digital high-pass filter

1.6.2022101919 — 22-10-25

Added

• Resistance calculation display panel to dashboard view.
• SCPI commands to set the type and a query to get the type for each source module.
• Steps to self-calibrate to account for offsets of 6 dB and 12 dB filter buffers.
• A check for DC mode to prevent the output from being reset if an AC range is commanded.
• Ability to query the scaling value of the currently configured module in the "Monitor out configuration."
• RMS conversion of hardware peak ranges when in AC mode.
• "READ[:MULTiple]?" query for simultaneous new measurement acquisition.
• Persistent user-customizable notes for modules.
• Summary query of settings profiles.
• Undo option for an applied settings profile.
• Dashboard panels show unloaded state of modules.
• Option to fully disable IIR filter.
• Square and triangle wave charts to the manual.
• Ref in voltage limits to the manual.
• Relative reading subtraction feature to DC and AC RMS modes.
• Reference source amplitude and offset to measure tab when in lock-in.
• Self-calibration status history information in dashboard panels.
• Info circle to observation/averaging time setting.
• Visible indication in tabs when a source is enabled.
• Resistance display of simple amplitude voltage divided by current quotient.
• Digital high-pass filter before lock-in detector and calculated measurement.
• Min and max readings calculator.
• Reset parameter to factory reset SCPI command description in manual.
• Shimmer animation when loading views after swiping to a different module.
• Info circle for new resistance calculation feature.
• Additional SCPI commands to the manual.

Changed

• Refactored the module load function to load all connected but presently unloaded modules.
• Return NaN value for resistance when source is in V. Limit or I. Limit.
• Update digital high-pass filter title to match front panel.
• Clarified difference between DC and AC for source peak commands/queries in the manual.
• Hide IIR filter when not in lock-in mode.
• Improved documentation of frequency range threshold.
• Improved manual to be clearer about SCPI command/response terminators.
• Improved info circle for resistance calculation.
• Improved digital high-pass filter corrections to account for the user-selected harmonic.
• Sped up remote communication output update rate.
• Improved peak window size decision in lock-in mode.
• Updated firmware installation/update instructions in manual and website.
• Updated info circle description for observation/averaging time.
• Limited voltage biasing enabled on the M81-CM-10 100 mA range.
• Switched to Open Sans font for the PDF manual.
• Updated table in manual to include 0.01% settle time.
• Improved info circle description of FIR filter.
• Increased max FIR cycle limit to 1 million cycles.
• Updated description for fetch immediate in manual.
• Ref out now allowed to output without source enabled.

Fixed

• Settings profile UNDO snackbar action.
• Measure NaN when the reference frequency is very small.
• Errant underlining on frequency dashboard card when module is unloaded.
• SCPI error queue related app crash.
• Self-calibration failure when pressing run all self cals button.
• Removed shimmer animation on an active measure module tab.
• Properly update measure frequency when locked into a synced source.
• Bug where all VS modules shared a single DC servo setpoint.
• Corrections for high-pass filter.
• Bug in the lock-in external reference present check.
• Improved high-pass filter calculation precision.
• Source amplitude/offset validation error.
• Corrected SCPI MRMS data source mnemonic.
• Increased CM self-calibration settle times to eliminate false self-calibration failures.
• Menu icon unusable after changing screen orientation.
• Cancel button when changing amplitude of source from a dashboard panel.
• Improved formatting of online manual SCPI command reference.
• Reference phase shift value not underlined.

1.5.2022032315 — 22-3-25

Changed

• Manual description of filter optimizations and how certain selections affect available measurement ranges; range and filter optimization info circles now explain that available ranges can change based on filter optimization settings
• Instrument now informs the user of unexpected errors that require restarting the instrument before resuming use
• Manual description explains read query versus fetch query operation regarding existing versus newly obtained measurements
• Data streaming mode rate consistency significantly improved for longer duration measurement runs and UI remains active during acquisition

Fixed

• Enabled functionality of "reset settings," "unload," and "load" buttons when front panel keypad access is locked
• Self-calibration of CM-10 when using 50 Hz power line regions provides sufficient range settling times, reducing chances of errors

1.4.2022021701 — 22-3-2

Changed

• CM module self-calibration function unavailable while module high reserve filter function is enabled

Fixed

• External reference input now detects when input signal has been stopped or cable is removed
• Improved stability when long term, high reading rate remote PC queries are being conducted

1.3.2022012604 — 22-1-28

Added

• Added front panel load/unload function to allow remote modules to be connected and disconnected without cycling instrument main power for quick module setup reconfiguration; prior to power on module disconnect, select unload at bottom of module interface screen; upon module connection, follow on-screen prompts to load module to activate/use each module connected while power is applied
• Added module reset at bottom of module interface screen to restore all module settings to default settings, thus avoiding module disconnect/reconnect process to reset a single module; other connected modules are not affected, only the module linked to the interface screen being reset
  

Changed

• Source module frequency setting is read-only when module has sync mode enabled
• Improved startup error message when line frequency detection fails on power-up due to noisy power line conditions
• Default state of BCS disable output on compliance feature is now off by default; for voltage-sensitive devices, recommended to set BCS to standby before connecting or disconnecting from DUT

Fixed

• A bug where "disabled due to compliance" message was being erroneously displayed on the BCS module screen
• A bug where in certain conditions the monitor output scaling is incorrect
• A bug where VM peak readings would indicate zero when autoranging and near range boundaries
• A bug where measurement modules' lock-in frequency reading was incorrect when the reference source for a given module was set to 'Ref in'

1.2.2021121002 — 21-12-20

Added

• Calibration page has calibration information for all modules and a button to run all self-calibrations
• M81-2 and M81-4 now filter out irrelevant channels
• BCS module will disable its output upon a compliance condition by default (user defeatable)
• FIR PSD filter cycles can now be configured on applicable modules
• Frequency range threshold can now be configured on applicable measure modules
• 'IMMediate' queries were added to the 'FETCh' subsystem to allow for returning data without waiting for settling
• Source amplitude now has the ability to be viewed and entered in either RMS or peak values
• Bias voltage amplitude control dashboard panel for CM-10

Changed

• The trace subsystem and the questionable condition register (DSOV bit) now report instrument to host PC data streaming overflows; internal data streaming overflows are still reported as runtime errors
  
• When high-speed data streaming, the instrument will show a lockout screen to help prevent data streaming overflows
• Auto-range logic now uses peak indication instead of raw peak ADC codes
• When source coupling is set to automatic and the output frequency is 100 Hz or lower, the instrument will use DC coupling
• Current compliance now has a minimum value of 1 nA
• Various UI interaction improvements including increased touch detection areas for small/corner buttons
• Auto source coupling now selects DC coupling when the source shape is set to square
• SCPI controls for Disable on Compliance setting

Fixed

• Dashboard scrolling issue
• Issue where crash logs were not automatically being saved
• 'TRACe:FORMat:HEADer?' source limit units
• The trace subsystem and the questionable condition register (DSOV bit) now report instrument to host PC data streaming overflows; internal data streaming overflows are still reported as runtime errors
• Issue where an instrument to host PC data streaming overflow would also cause an internal overflow
• Issue where the measure frequency dashboard panel showed a mode conflict when in lock-in mode
• issue where some settings were not being displayed properly on startup
• Issue where the 'READ' subsystem SCPI errors were all generic system errors
• Issue where calibration temperature does not show on the UI in some instances
• Fixed issue where the instrument could hang when setting an invalid square wave frequency
• Fixed issue where range based frequency validation was falsely generating errors in DC mode

1.1.2021080613 — 1-08-18

Added

• Dashboard view
• Settings profiles
• Option to disable module LEDs (dark mode)
• READ? query
• Built-in calculation of settle time and equivalent noise bandwidth (ENBW)

Changed

• CM-10 autorange now makes range decisions based on both frequency and amplitude

Fixed

• Various bug fixes

[1.0] — First release