Touch Encoder Help

Flashdrive

1. Overview

This document describes how to update the Firmware and/or Project on a Grayhill Touch Encoder (TE) or Software Development Kit (SDK) via a USB drive.

These instructions apply to all TE units with an "A" or "B" in the serial number or with a part number ending in "U" (USB version) regardless of serial number. Starting in October 2022, Grayhill made significant upgrades to the TE electrical hardware. One of those upgrades was the separation of the USB and CAN communication lines. This means that TEs with a "C" at the end of the part number (CAN version) and a "C" or later in the serial number (made in or after October 2022) can no longer communicate over USB, this includes USB flash drives. To update CAN units with a "C" in the serial number, see the instructions located below.

Order matters for TEs starting from firmwares earlier than v3.5.2.p10, always update the Bootloader before the Firmware and always use the Bootloader file that was supplied with the Firmware you are updating to. The Bootloader and Firmware should always be updated together, you should never update one without the other. For TEs starting from firmwares v3.5.2.p10 and later, updates should be done using the .tepkg file format. This file format includes the firmware and bootloader together. These files can be treated as firmware files and do not require a separate update for the bootloader. In order to update a TE with firmware prior to v3.5.2.p10 to firmware after v3.5.2.p10, Grayhill recommends updating from old to v3.5.2.p10, then onto the latest version.

To ensure proper Project operation, it is recommended that the "Config" and "Storage" be Reset prior to loading or updating Bootloader/Firmware.

  • Clearing Config will reset the unit to the factory configuration see GUIDE Communication Protocol Document GUIDE or iPad Communication Protocol Document for reference.

    • When running Projects created on the iPad app (TE-MX):

    • When running Projects created on the PC app (GH GUIDE):

  • Clearing Storage will remove any project that is currently on the TE. If a new project is not loaded after clearing the "Storage" the TE will default to the TE test project which consists of 4 arrow screens, each waiting for a swipe in the direction indicated, followed by a screen with an encoder controlled value widget. The value ranges from 0-32 and changes with the encoder knob position.

1.1 Equipment List(s)

  1. Update Cable - T18908 or T18912-2, available from Grayhill or Digikey (GH7915-ND or TBD respectively)

    T18908 TE Update Cable
    T18912-2 TE Update Cable Current

  2. Power Supply - 4.75 to 18Vdc

  3. USB Drive - Drive must contain the files below in the root directory for the firmware version to be updated to, Grayhill released versions available in Downloads.

    • Starting from firmware earlier that v3.5.2.p10

    • Starting from firmware v3.5.2.p10 or later

  • Current SDKs cannot be updated via USB flash drive. All updates must be performed over Live Update.

  1. Update Cable - T11917, available from Grayhill or Digikey (1568-1211-ND).

    TE Update Cable

  2. Power Supply - 5Vdc

  3. Power Cable - T11927, available from Grayhill or StarTech (USB to 5.5mm Power Cable, Type N Barrel, 1m)

    TE Update Cable

  4. USB Drive - Drive must contain the files below in the root directory for the firmware version to be updated to, Grayhill released versions available in Downloads.

    • Starting from firmware earlier that v3.5.2.p10

    • Starting from firmware v3.5.2.p10 or later

1.2 Setup

  1. Insert USB drive into the update cable.

  2. Plug the round 5 pin connector of the update cable into the main connector of the TE

  3. Plug the update cable into the power supply

  • Current SDKs cannot be updated via USB flash drive. All updates must be performed over Live Update.

  1. Insert USB drive into the update cable.

  2. Insert the micro USB of the update cable into the SDK

  3. Insert the barrel connector of the power cable into the SDK

    SDK Setup

  4. Plug the USB end of the power cable into the power supply

2. Update Procedure

In the images that follow, the existing bootloader and firmware on the TE/SDK prior to being updated is v1.3.0.p8 and v3.0.4.p8 respectively. We will be updating to v1.4.1.p10 and 3.5.2.p10 respectively. If your TE/SDK has firmware prior to 3.0.4.p8 follow the steps outlined in the "Software Update Guide" for TE OS Version < 1.0.0 (no UtilityApp) located here or contact Grayhill (te_support@grayhill.com) before following these instructions.

2.1 Check Current Settings

  1. Tap "Utilities" on the main Utility App screen

    Tap Utilities

  2. Tap "Info"

    Tap Info

  3. Check Current Settings

    • The current Bootloader version shows 1.3.0.p8 as expected

    • The current Firmware version shows 3.0.4.p8 as expected

    • The current Communication Protocol shows CAN J1939 with a Baud Rate of 250 kbits/s

    Current Settings

  4. Tap the Home button until you are back to the main Utility App screen

2.2 Update Bootloader

  1. Tap "Update"

    Tap Update

  2. Tap "System"

    Tap System

  3. Tap "Boot"

    Tap Boot

  4. Select the desired Bootloader via the encoder, te_mx_v1.4.1.p10.tebl.manifest in the example shown

  5. Tap "Update"

    Tap Update

  6. Tap "Reboot" after the update is complete

    Tap Reboot

2.3 Update Firmware

  1. Tap "Update"

    Tap Update

  2. Tap "System"

    Tap System

  3. Tap "Firmware"

    Tap Firmware

  4. Select the desired Firmware via the encoder, te_mx_v3.5.2.p10.tefw.manifest in the example shown

  5. Tap "Update"

    Tap Update

  6. Tap "Reboot" after the update is complete

    Tap Reboot

2.4 Confirm Bootloader/Firmware Update

  1. Tap "Utilities" on the main Utility App screen

    Tap Utilities

  2. Tap "Info"

    Tap Info

  3. Check Updated Settings

    • The current Bootloader version now shows 1.4.1.p10

    • The current Firmware version shows 3.5.2.p10 as expected

    • The current Communication Protocol shows CAN J1939 with a Baud Rate of 250 kbits/s

    • If Grayhill has created a Custom Module for your application, that information will show here as well

    Updated Settings

  4. Tap Home button until you are back to the main Utility App Screen

2.5 Reset Config and Storage

  1. Tap "Utilities"

    Tap Utilities

  2. Tap "Reset"

    Tap Reset

  3. Tap "Config"

    Tap Config

  4. Wait for "Success" and tap Home

    Success

  5. Tap "Storage"

    Tap Storage

  6. Wait for "Success" and tap Home until you are back to the main Utility App screen

2.6 Update Current Project

  1. Tap "Update"

    Tap Update

  2. Tap "Project"

    Tap Project

  3. Select the desired Project via the encoder, Vehicle App.zip in the example shown

  4. Tap "Update"

    Tap Update

  5. Wait for "Update Successful." and tap Home until you are back to the main utility app

2.7 Change Communication Protocol

  1. Tap "Utilities"

    Tap Utilities

  2. Tap "Comm"

    Tap Comm

  3. Select the desired Communication Protocol via the encoder, "USB HID" in the example shown

  4. Tap "Set"

    Tap Set

  5. Tap Home until you are back to the main Utility App screen

  6. Tap "Reboot"

    Tap Reboot

  7. Verify the Communication is set to the desired Protocol by following Section 2.1

3. Problems, Issues, Concerns

If the Bootloader, Firmware, Communication Protocol, or Project do not update as expected please try the steps outlined above again to see if that fixes the issue. If problems persist contact Grayhill at te_support@grayhill.com

As part of your inquiry please include the information below. This will help Grayhill Engineering in troubleshooting the issue and providing quick, accurate feedback.

  1. Grayhill Part Number

    • This will appear on a label on the back of the unit and will start with "TE-M" or "TEYY"

  2. Firmware version

    • Both current and the desired version to be updated to

  3. Bootloader version

    • Both current and the desired version to be updated to

  4. Project Import Code if available

Last modified: 29 April 2024
Firmware UpdateProduct Advisory Notice