Many issues can be solved by systematic troubleshooting without needing to contact REV Support. Take a look at the troubleshooting tips below for help in determining the cause of the issue you are seeing. Should you need to contact us, describing the steps you've taken in detail will help us get you up and running quickly.
The key to effective troubleshooting is isolating the issue. Many issues can show the same symptom, so eliminating failure points one at a time is critical to finding the root cause.
If possible, try to eliminate a section of the system when troubleshooting. For example:
Rule out a code or control wiring issue:
Use the REV Hardware Client to run the SPARK MAX over USB.
Please be aware of the CAN lockout feature of the SPARK MAX. If it has been connected to the roboRIO's CAN bus, a safety feature within the SPARK MAX will lock out USB communication. Disconnecting from the CAN bus and power-cycling the MAX will release the lock.
If this is your first time running the REV Hardware client, see the Getting Started with the REV Hardware Client for a tour of the software and its features.
Rule out a code issue:
Create a simple test program using our SPARK MAX Example Code.
Rule out a mechanical issue:
Remove the motor from the mechanism or use a different, free spinning motor.
An extremely useful set of tools can be found on the Driver Station:
Use the Driver Station Log File Viewer
Look at the PDP channel current draw:
Higher than expected current on a channel can indicate both mechanical and electrical issues.
Look at the battery voltage:
Large dips in the battery voltage around the time of an issue can indicate battery health issues that cause brownouts.
Use the CAN/Power Tab
Look at the CAN Bus Utilization.
Look at CAN Faults.
Look at Comms Faults:
Comms faults can affect the SPARK MAX. If it loses communication with the roboRIO, it will go to its safe disabled state. This can look like a momentary glitch in a motor spinning if the comms faults are infrequent and irregular.
It is also very useful to log or plot operating values internal to the SPARK MAX. These values can be accessed using the SPARK MAX APIs. Useful values to log:
getAppliedOutput()
This value will show what the SPARK MAX is actually applying to the motor output. This can illuminate issues with closed loop control tuning.
getOutputCurrent()
This value will show the output current going to the phases of the motor. Output current won't always be the same as the Input current measured by the PDP. Knowing the output current is useful to diagnose current-limit issues if motors are overheating.
getBusVoltage()
A way to measure the input voltage right at the controller.
getStickyFaults()
A sticky fault indicates if a fault has occurred since the last time the faults were reset. Checking these can provide a lot of insight into what the controller is experiencing.
Below you will find some troubleshooting steps for some common faults and issues related to operating the SPARK MAX.
Sometimes, when updating the firmware on a SPARK MAX, it is possible for the process to be interrupted or for the firmware to be corrupted by a bad download or other type of interruption in data transfer. In this state, the Status LED will be dark or dim and the device will fail to operate. There is a built-in recovery mode that can force your device to accept new firmware even if the controller seems to be bricked and the procedure is outlined below:
Please note, performing this procedure will erase all data and settings on the device. To perform the procedure a small tool, like a straightened paper clip, is necessary to press the Mode Button (located to the right of the Status LED), the orange USB-C cable that came with the unit (or a DATA capable USB-C cable), and a native Windows based computer with the REV Hardware Client installed:
With the SPARK MAX disconnected from power, press and hold the Mode Button
While still holding the Mode Button, connect the Device to the computer using the USB-C cable - the Status LED will not illuminate - this is expected.
With the REV Hardware Client running on the computer, wait a few seconds for the audible tone or icon for the device to be recognized in recovery mode then release the Mode Button - no lights will be present on the SPARK MAX during this stage of the process, this is expected
Select the SPARK MAX in Recovery Mode from the REV Hardware Client window
From the "Choose a Device" type dropdown, choose - SPARK MAX
Choose the latest version of the firmware from the dropdown and then click update
Wait for the software update to complete
Power cycle unit (unplug and plug in USB-C) click on SPARK MAX icon, clear any sticky faults - the recovery should be complete!
Measure the continuity between each of the motor phase wires and the sensor wire, as pictured here. Also, check the resistance between wires of the sensor cable and motor wires. Reach out to support@revrobotics.com with results for each phase wire.