« Close

Datasheets and User Guides

App Notes

Software & Driver

 

24.1 Cleanse

The Cleanse function will reset non-volatile user data and settings to the factory defaults.

To prevent errors the WiFi module will be disabled.

Requires firmware 1.0225.

 

Triggering a Cleanse:

To trigger a cleans write 0x5317052E to the CLEANSE register. Once triggered the below listed items will be cleared.

The LEDs will blink in an alternating pattern to show that the cleanse is in progress. If the LEDs blink in unison then an error has occurred.

The CLEANSE function will take a few seconds to complete. This will cause LJM to throw a LJME_RECONNECT_FAILED error (#1239). To prevent this error LJM's timeout needs to be increased. Alternatively, the error can be ignored and the CLEANSE_LAST_ERROR register can be read to retrieve any thrown errors.

 

Items Cleared:

  • Device Name
  • AIN_EF Settings
  • DIO_EF Settings
  • DIO States and Directions
  • AIN Settings
  • Watchdog Timer
  • Lua Startup Settings
  • Lua Startup Script
  • Flash User Space
  • Battery Backed RAM (Pro only)
  • Ethernet Settings
  • Some WiFi Settings

 

Cleared:

  • Settings stored in the WiFi module are not erased. Settings in the WiFi module are SSID and Password. To clear settings stored in the module use Kipling to write dummy values.