This is legacy documentation for our discontinued SPARK MAX Client Software. If you are interested in running a SPARK MAX via a computer, please see our newer documentation: Getting Started with the REV Hardware Client.
Update, configure, and test your SPARK MAX Motor Controller with the SPARK MAX Client application.
For instructions on how to access this legacy software, please email support@revrobotics.com
The SPARK MAX Client will not work with SPARK MAX beta units distributed by REV to the SPARK MAX beta testers. It is only compatible with units received after 12/21/2018.
Windows 10 64-bit
Windows 7 64-bit might work but it is not supported.
Internet connection for automatic updates
Download the SPARK MAX Client installer above.
Run the installer. Windows may require approval to install the application.
During the installation process, separate driver installation windows may appear. Some driver installations may fail if you already have the driver installed from a previously installed Client, this is expected.
Once installed, run the application. If prompted, be sure to grant network access. Without network access, the client software won't be able to download the latest SPARK MAX firmware and client updates.
This is legacy documentation for our discontinued SPARK MAX Client Software. If you are interested in running a SPARK MAX via a computer, please see our newer documentation: Getting Started with the REV Hardware Client.
The Navigation bar is visible on all tabs of the SPARK MAX Client and allows you to select with SPARK MAX the Client is connected to.
Identify Device: The status LED of a selected device will blink. This is helpful when troubleshooting or configuring multiple devices.
Device Selection: See each SPARK MAX connected to the SPARK MAX Client. This includes other devices connected via CAN if running firmware 1.4.0 or later.
Rescan: Looks for additional SPARK MAX devices connected to the SPARK MAX Client. This includes other devices connect via CAN if running firmware 1.4.0 or later.
Connect/Disconnect: After selecting a device connecting to the device pulls all the configuration parameters set on the device.
Tabs: Select one of the five tabs to gain access to configure, update, and run SPARK MAX.
The Basic Tab is used to set the most common parameters for the SPARK MAX
Configurations: This drop down allows you to select pre-existing configurations store on the Windows machine running the SPARK MAX Client or to pull the existing parameters stored on in RAM on the SPARK MAX. This is helpful when configuring multiple motor controllers to the same settings.
CAN ID: This assigns a SPARK MAX a CAN ID for identification over the CAN BUS. Any configured SPARK MAX must have a CAN ID.
Configured Parameters: Change the motor type, sensor type, idle mode behavior, and more.
The Advanced Tab allows for changing all configurable parameters of the SPARK MAX without needing to set them in code.
Search Parameters: Allows for easy look up of a specific parameter for editing.
Parameter Table: Select the arrow to show all configurable parameters within a specific group. For more information on each parameter type see Configuration Parameters.
The Run Tab allows for the SPARK MAX to operate over USB or a USB to CAN Bridge without the need for a full control system. This is helpful for testing mechanisms and tuning their control loops.
Bar Select: Select from either run, parameters, or signals to provide information and feedback when operating SPARK MAX.
Signal Chart: Shows any added signals in graph form when running a SPARK MAX. This is helpful when tuning control loops.
PIDF: Update PIDF parameters on the fly to tune control loops on the SPARK MAX.
Run: Choose setpoints to run a motor connected to a SPARK MAX using various modes, including position, velocity, and duty cycle.
The three icons for bar select change the bottom third of the Run Tab for configuration. Once signals and other parameters are configured selecting the run bar icon will allow for running of a motor with the SPARK MAX Client.
The Network Tab shows all connected devices via USB and the USB to CAN interface. From the Network Tab each device can be identified and firmware updated.
Device Select: Select a device to update firmware.
Load Firmware: Select what firmware to update onto selected devices.
For more information on the firmware updating process see Updating Device Firmware for both single device and multiple device updates.
This is legacy documentation for our discontinued SPARK MAX Client Software. If you are interested in running a SPARK MAX via a computer, please see our newer documentation:
If this is the first time installing the SPARK MAX Client or connecting a SPARK MAX in Recovery Mode, you may see an error the first time you try to update firmware on your computer. The DFU driver is one of two drivers installed by the Client and is used for updating firmware. It may not install completely until a SPARK MAX in DFU Mode (Recovery Mode) is plugged into the computer.
If you see an error during your first firmware update, please do the following:
Close the Client application.
Unplug the SPARK MAX from the computer.
Plug the SPARK MAX back into the computer.
Open the Client application.
Alternatively, you can preemptively finalize the DFU driver installation by following the steps before using the Client for the first time.
We are aware of this issue and will release a fix in a future update of the SPARK MAX Client.
As we get feedback from users and identify exact causes for issues, please look back here for troubleshooting help. If you are running into issues running the SPARK MAX Client try the following BEFORE contacting :
Try running the SPARK MAX Client as an Administrator
Make sure that Windows is fully up-to-date. Some computers have Windows Update disabled and need to be updated manually.
Check the Device Manager and verify that the SPARK MAX shows up as one of the following two devices with no caution symbols:
Normal operating mode: Device Manager -> Ports (COM & LPT) -> USB Serial Device (COMx)
Recovery mode: Device Manager -> Universal Serial Bus Controllers -> STM Device in DFU Mode
If the device shows up with errors or as STM32 BOOTLOADER, try installing the separately.
This is legacy documentation for our discontinued SPARK MAX Client Software. If you are interested in running a SPARK MAX via a computer, please see our newer documentation:
When updating the firmware on the SPARK MAX, it is possible for the process to be interrupted or for the firmware to be corrupted by a bad download. In this state, the Status LED will be dark and the SPARK MAX will fail to operate. SPARK MAX has a built-in recovery mode that can force it to accept new firmware even if the controller seems to be bricked. The following procedure requires a small tool, like a straightened paper clip, to press the Mode Button, a USB C cable, and a computer with the installed:
With the SPARK MAX powered off completely, press and hold the Mode Button.
While still holding the Mode Button, connect the SPARK MAX to the computer using the USB cable. The Status LED will not illuminate, this is expected.
Wait a few seconds for the computer to recognize the connected device, then release the Mode Button.
Open the SPARK MAX Client Application. The SPARK MAX will remain dark and it will not connect to the Client, this is expected.
Navigate to the Network tab and click the Rescan arrows at the top of the window.
The SPARK MAX will be listed under Devices in Recovery Mode. Click the checkbox next to the device.
Click the Load Firmware button.
Select the latest firmware file and click Open.
The firmware should load successfully and the SPARK MAX will now connect to the Client.
This is legacy documentation for our discontinued SPARK MAX Client Software. If you are interested in running a SPARK MAX via a computer, please see our newer documentation:
Follow the steps below to update the firmware on your SPARK MAX:
Connect your SPARK MAX Motor Controller to your computer with a USB-C cable.
Open the REV SPARK MAX Client application.
The Client should automatically scan and connect to your SPARK MAX. If your SPARK MAX is running outdated firmware, you will be notified with a pop-up window like the one pictured below:
If your SPARK MAX is running firmware older than 1.4.0, you may not see a pop-up and will need to proceed directly to the Network tab and click Scan Bus manually.
Click Open Network Tab & Scan Bus and proceed to the next step.
Your SPARK MAX should now be listed in the device list. Click the checkbox next to the SPARK MAX you wish to update, and click Load Firmware.
Select the latest firmware file in the firmware directory that the client created on startup. If there isn't a firmware directory, you can also navigate to a file that was downloaded manually. Click Open once the appropriate firmware file is selected:
Click Yes to confirm the update.
Once complete, the Client will rescan the bus and display the updated controllers.
SPARK MAX Firmware Version 1.5.0 includes a USB-to-CAN Bridge feature that allows a single USB-connected SPARK MAX to act as a bridge to the entire CAN bus it is connected to. This allows for configuration and simultaneous updating of multiple SPARK MAX controllers without having to connect to each one individually. Using this feature requires the following:
A USB-connected SPARK MAX that is updated to firmware version 1.5.0 or newer to act as the Bridge.
Other SPARK MAXs connected on the CAN bus must be individually updated to firmware version 1.4.0 before they are able to receive mass-updates from the Bridging SPARK MAX.
Once these requirements are satisfied, navigate to the Network tab, select the controllers you wish to update, and follow the same firmware update procedure described above starting at Step 4.
When complete, the Client will display the number of successfully updated controllers.
If your SPARK MAX is listed and you are unable to click the checkbox next to it, you must put your SPARK MAX into .
If a controller fails to update it is usually due to the process being interrupted by a bad power or CAN connection. Severe interruptions can cause the firmware update to be corrupted. A corrupted controller can no longer be updated over the USB-to-CAN Bridge, however, it can be recovered by connecting to the controller directly over USB and putting it in .
