Skip to main content

Kollmorgen Support Network

Retrofit KAS EtherCAT Backups with AKD2G Firmware | 30 Jan 2024 | |

Retrofit KAS EtherCAT Backups with AKD2G Firmware

The AKD2G drives with firmware versions 02-12-00-001 (and later) do not support downgrading the firmware to the versions 02-12-00-000 (or earlier).

The KAS EtherCAT backups created using AKD2G firmware 02-12-00-000 (or earlier) are not capable of restoring the drive’s configuration once any AKD2G drive in the EtherCAT network were either updated or replaced with the firmware version 02-12-00-001 (or later).

The utility provided here retrofits an old KAS EtherCAT backup file with the new AKD2G firmware. This allows the KAS customers to use their old backup to restore their AKD2G drives’ configuration when the drive firmware is updated.

NOTE This utility only modifies the AKD2G devices found in the EtherCAT backup and does not affect any other non-AKD2G devices in the backup.

Requirements

 Software

  • Windows 10/11
  • Python 3.10 or later (to use the updateAkd2gBackup.py file).

  Files

  • EtherCAT Backup (i.e., KAS-network-backup.tgz)
    This TGZ file was previously backed up and exported from the PxMM controller.
  • AKD2G with FS1 Servo Drive Firmware (e.g., AKD2G-02-12-00-001-User.zip).
    Downloaded this file from here: AKD2G Servo Drive

Important Notes

  • File names are examples only - use the latest downloaded files. 
  • This example procedure assumes the default TGZ and ZIP file names remain the same. 
  • If these file names were changed, locate the applicable files and use them.

Retrofit Procedure

  1. On a Windows computer, create a new backup folder.
    This is where the updated EtherCAT backup is created.
    This procedure uses C:\KAS-Backup folder as the example.
  2. Copy the KAS-network-backup.tgz and AKD2G-(version)-User.zip to the C:\KAS-Backup folder. 
  3. Create another folder and copy the KAS-network-backup.tgz file BEFORE it’s updated. 
  4. Download the attached RetrofitEtherCATBackup.zip file.
  5. Extract the contents of RetrofitEtherCATBackup.zip into the C:\KAS-Backup folder.
    The ZIP file has these files:
    • updateAkd2gBackup.exe
    • updateAkd2gBackup.py
    • README.pdf
  6. Open a text editor (e.g., Notepad++).
  7. Copy the Path Format text into the text editor.
    • Path Format
      • updateAkd2gBackup.exe --backup_filepath "C:\path\(filename).tgz" --firmware_filepath "C:\path\ AKD2G-(version)-User.zip" --destination "C:\path\destination"
        Text editor with Path Format text.
  8. Use the text editor to change the path arguments to use the new backup folder paths (see Path Example).
    • Path Example 
      • updateAkd2gBackup.exe --backup_filepath "C:\KAS-Backup\ Before-Retro\KAS-network-backup.tgz" --firmware_filepath "C:\KAS-Backup\AKD2G-02-12-00-001-User.zip" --destination "C:\KAS-Backup"
        Text editor with Path Example text.
  9. Copy the edited text to the clipboard.
  10. Open Windows File Explorer and navigate to the new backup folder.
  11. In the address bar, remove or overwrite the contents with cmd and press <Enter>.
    This opens a Command Prompt in the current directory pointing to the new folder (e.g., C:\KAS-Backup).
    cmd to open the Command Prompt window

    Blank Command Prompt window
  12. At the Command Prompt, paste the copied path argument and press <Enter>. 
    A new backup file is created or overwrites the existing backup file.
    Command Prompt window with successful retrofit file.
  13. Navigate to the backup folder (e.g., C:\KAS-Backup) to view and use the updated EtherCAT backup file.

Python Script Procedure

If the Retrofit Procedure fails, a Python script is available to retrofit the AKD2G firmware in the EtherCAT backup.

Important Python 3.10 or later must be installed to run this script.
  1. Complete Steps 1 to 6 in the Retrofit Procedure.
  2. For Retrofit Procedure Steps 7 and 8, use this Python file path:
    • Path Format:
      • python updateAkd2gBackup.py --backup_filepath "C:\path\f(filename).tgz" --firmware_filepath "C:\path\AKD2G-(version)-User.zip" --destination "C:\path\destination"
    • Path Example:
      • python updateAkd2gBackup.py --backup_filepath "C:\KAS-Backup\Before-Retro\KAS-network-backup.tgz" --firmware_filepath "C:\KAS-Backup\AKD2G-02-12-00-001-User.zip" –destination "C:\KAS-Backup"
  3. Continue the Retrofit Procedure for Step 9 and 10.
  4. At the Command Prompt, enter the edited path argument and press <Enter>.
    A new backup file is created or overwrites the existing backup file.
    Python success.
  5. Navigate to the backup folder (e.g., C:\KAS-Backup) to view and use the updated EtherCAT backup file.

 

Back to top