Skip to main content
Beacon Diagnostics Magic Script

Learn how to collect robot diagnostics for Beacon Support

Doug Ayers avatar
Written by Doug Ayers
Updated over a week ago

For security, never use a USB drive or files from untrusted sources. If in doubt, contact your IT department or Beacon Support.

See Magic Scripts Overview to learn more about these kinds of files.

When reaching out to Beacon Support, you might be asked to execute a magic script to gather robot diagnostics. These diagnostics aid in troubleshooting network connectivity, software updates, or other issues. This guide walks you through the process of running the Beacon Diagnostics magic script on your robot to collect the necessary data.

Prepare Your USB Drive for Magic Scripts

Follow this article to prepare your USB drive then proceed to the next step.

Download the Magic Script to Your USB Drive

Download the Beacon Diagnostics magic script to the root directory of your USB drive from any computer.

  1. Ensure your USB drive is properly formatted.

  2. Insert your USB drive into your computer.

  3. Right-click the link Beacon Diagnostics magic script and select “Save Link As…”
    Note, terminology may differ across browsers, like “Download Linked File As…”

  4. Choose your USB drive when prompted for a download location.
    The file might automatically download to your computer's Downloads folder. If so then move the file to your USB drive.

With the script downloaded, it's time to execute it on your robot.

Run the Magic Script on Your Robot

After downloading the magic script onto your USB drive, insert your USB drive into the port at the top of your robot's teach pendant. The script will execute automatically, providing status messages on the teach pendant screen.

  1. Insert your USB drive into the port at the top of the teach pendant. The script will start automatically.

  2. When starting, a red "! USB !" warning will display on the teach pendant screen.
    Do not remove your USB drive while the script is executing.

  3. When finished, a green "<- USB" will appear on the teach pendant screen.

  4. Remove your USB drive from the teach pendant.

If after three minutes the green "<- USB" message does not appear then unplug the USB drive. Contact Beacon Support to let them know that the magic script failed, and please share with them the generated “output.log” file on the USB drive for troubleshooting.

If successful then the script will generate a zip file on your USB drive named “beacon_diagnostics_<serial_number>_<timestamp>.zip”.

Once the diagnostics are collected, proceed to share the results with Beacon Support.

Share the Results with Beacon Support

With the Beacon Diagnostics file ready, it's time to forward the results to Beacon Support for further analysis.

  1. Insert the USB drive to a computer to access the “beacon_diagnostics_<serial_number>_<timestamp>.zip” file.

  2. Share the file with Beacon Support either via email or in-app support.

    1. To share the file via email, send an email to support@hirebotics.com with the diagnostics zip file attached.

    2. To share the file via in-app support, log in to Beacon at https://beacon.hirebotics.io on your computer then navigate to Support then attach the diagnostics zip file to a message for Beacon Support.

Once received, Beacon Support will analyze the diagnostics to help further troubleshoot any issues.

Did this answer your question?