CTRE Phoenix 6 C++ 24.50.0-alpha-2
StatusCodes.h
Go to the documentation of this file.
1/*
2 * Copyright (C) Cross The Road Electronics.  All rights reserved.
3 * License information can be found in CTRE_LICENSE.txt
4 * For support and suggestions contact support@ctr-electronics.com or file
5 * an issue tracker at https://github.com/CrossTheRoadElec/Phoenix-Releases
6 */
7#pragma once
8
9#ifdef __cplusplus
10
11/* Make sure this is still compiled with C++ linkage
12 * when included from an `extern "C"` block */
13extern "C++" {
14
15#include <ostream>
16
17namespace ctre
18{
19 namespace phoenix
20 {
21
22 /**
23 * \brief Status codes reported by APIs, including OK,
24 * warnings, and errors.
25 */
27 {
28 int value;
29
30 public:
31 /**
32 * \brief No Error
33 */
34 static constexpr int OK = 0;
35 /**
36 * \brief Diagnostic Server is busy with another command.
37 */
38 static constexpr int TaskIsBusy = -100;
39 /**
40 * \brief InvalidDeviceSpec
41 */
42 static constexpr int InvalidDeviceSpec = -101;
43 /**
44 * \brief Device is not present. Verify the device is connected and powered, and
45 * that the CAN bus is terminated.
46 */
47 static constexpr int EcuIsNotPresent = -102;
48 /**
49 * \brief Could not put the device into bootloader mode.
50 */
51 static constexpr int CouldNotEnterBl = -103;
52 /**
53 * \brief Could not confirm the device has entered the bootloader.
54 */
55 static constexpr int CouldNotConfirmBl = -104;
56 /**
57 * \brief Could not erase flash.
58 */
59 static constexpr int CouldNotErase = -105;
60 /**
61 * \brief Could not field upgrade the device.
62 */
63 static constexpr int CouldNotSendFlash = -106;
64 /**
65 * \brief Bootloader could not verify integrity of the flashed application.
66 */
67 static constexpr int CouldNotValidate = -107;
68 /**
69 * \brief Could not run the device firmware application.
70 */
71 static constexpr int CouldNotRunApp = -108;
72 /**
73 * \brief Unable to set ID to this device.
74 */
75 static constexpr int CouldNotReqSetId = -109;
76 /**
77 * \brief Could not verify that the changed ID took effect.
78 */
79 static constexpr int CouldNotConfirmId = -110;
80 /**
81 * \brief Device field upgrade was successful.
82 */
83 static constexpr int FlashWasGood = -111;
84 /**
85 * \brief Device firmware application is too old.
86 */
87 static constexpr int AppTooOld = -112;
88 /**
89 * \brief Unable to set name to this device.
90 */
91 static constexpr int CouldNotReqSetDesc = -113;
92 /**
93 * \brief CompileSzIsWrong
94 */
95 static constexpr int CompileSzIsWrong = -114;
96 /**
97 * \brief Cannot set the ID of a gadgeteer device.
98 */
99 static constexpr int GadgeteerDeviceNoSetId = -115;
100 /**
101 * \brief This diagnostic action is not supported.
102 */
103 static constexpr int InvalidTask = -116;
104 /**
105 * \brief Not Implemented, check latest installer.
106 */
107 static constexpr int NotImplemented = -117;
108 /**
109 * \brief NoDevicesOnBus
110 */
111 static constexpr int NoDevicesOnBus = -118;
112 /**
113 * \brief MoreThanOneFile
114 */
115 static constexpr int MoreThanOneFile = -119;
116 /**
117 * \brief Specified device was not found. Verify the device is connected and
118 * powered, and that the CAN bus is terminated.
119 */
120 static constexpr int NodeIsInvalid = -120;
121 /**
122 * \brief InvalidDeviceDescriptor
123 */
124 static constexpr int InvalidDeviceDescriptor = -121;
125 /**
126 * \brief CouldNotSendCanFrame
127 */
128 static constexpr int CouldNotSendCanFrame = -123;
129 /**
130 * \brief NormalModeMsgNotPresent
131 */
132 static constexpr int NormalModeMsgNotPresent = -124;
133 /**
134 * \brief This feature is not supported.
135 */
136 static constexpr int FeatureNotSupported = -125;
137 /**
138 * \brief The diagnostic server is not field upgrading any devices.
139 */
140 static constexpr int NotUpdating = -126;
141 /**
142 * \brief CorruptedPOST
143 */
144 static constexpr int CorruptedPOST = -127;
145 /**
146 * \brief This device did not report any available configs. Verify firmware and
147 * diagnostics are up-to-date.
148 */
149 static constexpr int NoConfigs = -128;
150 /**
151 * \brief ConfigFailed
152 */
153 static constexpr int ConfigFailed = -129;
154 /**
155 * \brief Unable to factory default this device.
156 */
157 static constexpr int CouldNotReqFactoryDefault = -130;
158 /**
159 * \brief CustomNameNotSupported
160 */
161 static constexpr int CustomNameNotSupported = -131;
162 /**
163 * \brief The configs read from the device do not match the configs that were
164 * written.
165 */
166 static constexpr int ConfigReadWriteMismatch = -132;
167 /**
168 * \brief Could not apply the device configs.
169 */
170 static constexpr int CouldNotReqSetConfigs = -133;
171 /**
172 * \brief InsufficientSz
173 */
174 static constexpr int InsufficientSz = -134;
175 /**
176 * \brief This feature is not supported for this device model.
177 */
178 static constexpr int InvalidModel = -135;
179 /**
180 * \brief CouldNotReqDevInfo
181 */
182 static constexpr int CouldNotReqDevInfo = -140;
183 /**
184 * \brief This device does not support new controls.
185 */
186 static constexpr int NoControls = -141;
187 /**
188 * \brief DeviceIsNull
189 */
190 static constexpr int DeviceIsNull = -142;
191 /**
192 * \brief DeviceDidNotRespondToDiagReq
193 */
194 static constexpr int DeviceDidNotRespondToDiagReq = -143;
195 /**
196 * \brief This feature requires Tuner X.
197 */
198 static constexpr int OnlySupportedInTunerX = -144;
199 /**
200 * \brief Command-line issue with caniv.
201 */
202 static constexpr int CanivCliError = -145;
203 /**
204 * \brief InvalidCrfBadHeader
205 */
206 static constexpr int InvalidCrfBadHeader = -200;
207 /**
208 * \brief InvalidCrfFileSzInvald
209 */
210 static constexpr int InvalidCrfFileSzInvald = -201;
211 /**
212 * \brief Specified CRF is for the wrong product.
213 */
214 static constexpr int InvalidCrfWrongProduct = -202;
215 /**
216 * \brief InvalidCrfNoSects
217 */
218 static constexpr int InvalidCrfNoSects = -203;
219 /**
220 * \brief InvalidCrfBadSectHeader
221 */
222 static constexpr int InvalidCrfBadSectHeader = -204;
223 /**
224 * \brief InvalidCrfBadSectSize
225 */
226 static constexpr int InvalidCrfBadSectSize = -205;
227 /**
228 * \brief Specified CRF file could not be found.
229 */
230 static constexpr int NoCrfFile = -206;
231 /**
232 * \brief CouldNotFindDynamicId
233 */
234 static constexpr int CouldNotFindDynamicId = -300;
235 /**
236 * \brief DidNotGetDhcp
237 */
238 static constexpr int DidNotGetDhcp = -301;
239 /**
240 * \brief DidNotGetFullDhcp
241 */
242 static constexpr int DidNotGetFullDhcp = -302;
243 /**
244 * \brief InvalidLicenseResp
245 */
246 static constexpr int InvalidLicenseResp = -350;
247 /**
248 * \brief InvalidCanivCache
249 */
250 static constexpr int InvalidCanivCache = -351;
251 /**
252 * \brief CannotOpenSerialPort
253 */
254 static constexpr int CannotOpenSerialPort = -500;
255 /**
256 * \brief CannotWriteSerialPort
257 */
258 static constexpr int CannotWriteSerialPort = -501;
259 /**
260 * \brief CannotReadSerialPort
261 */
262 static constexpr int CannotReadSerialPort = -502;
263 /**
264 * \brief CannotSerialToDevice
265 */
266 static constexpr int CannotSerialToDevice = -503;
267 /**
268 * \brief NoSerialControlFrameResp
269 */
270 static constexpr int NoSerialControlFrameResp = -504;
271 /**
272 * \brief CannotOpenUdpPort
273 */
274 static constexpr int CannotOpenUdpPort = -600;
275 /**
276 * \brief CannotWriteUdpPort
277 */
278 static constexpr int CannotWriteUdpPort = -601;
279 /**
280 * \brief CannotReadUdpPort
281 */
282 static constexpr int CannotReadUdpPort = -602;
283 /**
284 * \brief CannotUdpToDevice
285 */
286 static constexpr int CannotUdpToDevice = -603;
287 /**
288 * \brief NoUdpControlFrameResp
289 */
290 static constexpr int NoUdpControlFrameResp = -604;
291 /**
292 * \brief TimeoutIso15Response
293 */
294 static constexpr int TimeoutIso15Response = -605;
295 /**
296 * \brief InvalidJson
297 */
298 static constexpr int InvalidJson = -700;
299 /**
300 * \brief The user application is shutting down.
301 */
302 static constexpr int AppIsTerminating = -800;
303 /**
304 * \brief CAN message is stale, data is valid but old. Check the CAN bus wiring,
305 * CAN bus utilization, and power to the device.
306 */
307 static constexpr int CanMessageStale = 1000;
308 /**
309 * \brief Buffer is full, cannot insert more data.
310 */
311 static constexpr int BufferFull = 1006;
312 /**
313 * \brief PulseWidthSensorNotPresent
314 */
315 static constexpr int PulseWidthSensorNotPresent = 1010;
316 /**
317 * \brief General Warning Occurred.
318 */
319 static constexpr int GeneralWarning = 1100;
320 /**
321 * \brief Firm Vers could not be retrieved. Use Phoenix Tuner X to check ID and
322 * firmware(CRF) version.
323 */
324 static constexpr int FirmVersionCouldNotBeRetrieved = 1103;
325 /**
326 * \brief This feature will be supported in a future update.
327 */
328 static constexpr int FeaturesNotAvailableYet = 1104;
329 /**
330 * \brief The control mode is not valid for this function.
331 */
332 static constexpr int ControlModeNotValid = 1105;
333 /**
334 * \brief This control mode is not supported yet. A future release will
335 * supported this soon.
336 */
337 static constexpr int ControlModeNotSupportedYet = 1106;
338 /**
339 * \brief Motor Controller must have >= 3.2 firmware for motion profile control
340 * mode.
341 */
342 static constexpr int MotProfFirmThreshold = 1109;
343 /**
344 * \brief Motor Controller must have >= 3.4 firmware for advanced PID0/PID1
345 * features.
346 */
347 static constexpr int MotProfFirmThreshold2 = 1110;
348 /**
349 * \brief SimDeviceNotFound
350 */
351 static constexpr int SimDeviceNotFound = 1200;
352 /**
353 * \brief SimPhysicsTypeNotSupported
354 */
355 static constexpr int SimPhysicsTypeNotSupported = 1201;
356 /**
357 * \brief SimDeviceAlreadyExists
358 */
359 static constexpr int SimDeviceAlreadyExists = 1202;
360 /**
361 * \brief Could not transmit CAN Frame.
362 */
363 static constexpr int TxFailed = -1001;
364 /**
365 * \brief An invalid argument was passed into the function/VI, such as a null
366 * pointer.
367 */
368 static constexpr int InvalidParamValue = -1002;
369 /**
370 * \brief CAN frame not received/too-stale. Check the CAN bus wiring, CAN bus
371 * utilization, and power to the device.
372 */
373 static constexpr int RxTimeout = -1003;
374 /**
375 * \brief CAN Transmit timed out.
376 */
377 static constexpr int TxTimeout = -1004;
378 /**
379 * \brief ArbID is incorrect.
380 */
381 static constexpr int UnexpectedArbId = -1005;
382 /**
383 * \brief CanOverflowed
384 */
385 static constexpr int CanOverflowed = -1006;
386 /**
387 * \brief Sensor Not Present.
388 */
389 static constexpr int SensorNotPresent = -1007;
390 /**
391 * \brief Firmware Too Old. Use Phoenix Tuner X to field upgrade your CTRE CAN
392 * device firmware(CRF). Then restart your robot application to clear
393 * this error.
394 */
395 static constexpr int FirmwareTooOld = -1008;
396 /**
397 * \brief Control Frame Period could not be changed. Most likely it is not
398 * being transmitted.
399 */
400 static constexpr int CouldNotChangePeriod = -1009;
401 /**
402 * \brief BufferFailure
403 */
404 static constexpr int BufferFailure = -1010;
405 /**
406 * \brief Firmware is legacy non-FRC version. Use Phoenix Tuner X to field
407 * upgrade your CTRE CAN device firmware(CRF). Firmware greater than
408 * 20.0 required.
409 */
410 static constexpr int FirmwareNonFRC = -1011;
411 /**
412 * \brief General Error Occurred.
413 */
414 static constexpr int GeneralError = -1100;
415 /**
416 * \brief No new response to update signal.
417 */
418 static constexpr int SigNotUpdated = -1200;
419 /**
420 * \brief NotAllPIDValuesUpdated
421 */
422 static constexpr int NotAllPIDValuesUpdated = -1201;
423 /**
424 * \brief GEN_PORT_ERROR
425 */
426 static constexpr int GEN_PORT_ERROR = -1300;
427 /**
428 * \brief PORT_MODULE_TYPE_MISMATCH
429 */
430 static constexpr int PORT_MODULE_TYPE_MISMATCH = -1301;
431 /**
432 * \brief GEN_MODULE_ERROR
433 */
434 static constexpr int GEN_MODULE_ERROR = -1400;
435 /**
436 * \brief MODULE_NOT_INIT_SET_ERROR
437 */
438 static constexpr int MODULE_NOT_INIT_SET_ERROR = -1401;
439 /**
440 * \brief MODULE_NOT_INIT_GET_ERROR
441 */
442 static constexpr int MODULE_NOT_INIT_GET_ERROR = -1402;
443 /**
444 * \brief Wheel Radius is too small, cannot get distance traveled.
445 */
446 static constexpr int WheelRadiusTooSmall = -1500;
447 /**
448 * \brief Ticks per revolution is 0, cannot get heading.
449 */
450 static constexpr int TicksPerRevZero = -1501;
451 /**
452 * \brief Distance between wheels is too small, cannot get heading.
453 */
454 static constexpr int DistanceBetweenWheelsTooSmall = -1502;
455 /**
456 * \brief GainsAreNotSet
457 */
458 static constexpr int GainsAreNotSet = -1503;
459 /**
460 * \brief Use RemoteLimitSwitchSource instead of LimitSwitchSource.
461 */
462 static constexpr int WrongRemoteLimitSwitchSource = -1504;
463 /**
464 * \brief Motor Controller Voltage Compensation should not be used with
465 * setVoltage(). This causes compensation to happen twice. Disable
466 * Voltage Compensation by calling enableVoltageCompensation(false) in
467 * order to use setVoltage().
468 */
469 static constexpr int DoubleVoltageCompensatingWPI = -1505;
470 /**
471 * \brief CANdleAnimSlotOutOfBounds
472 */
473 static constexpr int CANdleAnimSlotOutOfBounds = -1506;
474 /**
475 * \brief IncompatibleMode
476 */
477 static constexpr int IncompatibleMode = -1600;
478 /**
479 * \brief Handle passed into function is incorrect.
480 */
481 static constexpr int InvalidHandle = -1601;
482 /**
483 * \brief Features requires newer firmware version.
484 */
485 static constexpr int FeatureRequiresHigherFirm = -1700;
486 /**
487 * \brief Config factory default features require firmware >=3.10.
488 */
489 static constexpr int ConfigFactoryDefaultRequiresHigherFirm = -1702;
490 /**
491 * \brief Config Motion S Curve Strength features require firmware >=4.16.
492 */
493 static constexpr int ConfigMotionSCurveRequiresHigherFirm = -1703;
494 /**
495 * \brief Talon FX(Falcon 500) Firmware Too Old. Use Phoenix Tuner to field
496 * upgrade your CTRE CAN device firmware(CRF) to >=20.3. Then restart
497 * your robot application to clear this error.
498 */
499 static constexpr int TalonFXFirmwarePreVBatDetect = -1704;
500 /**
501 * \brief CANdleAnimationsRequireHigherFirm
502 */
503 static constexpr int CANdleAnimationsRequireHigherFirm = -1705;
504 /**
505 * \brief LibraryCouldNotBeLoaded
506 */
507 static constexpr int LibraryCouldNotBeLoaded = -1800;
508 /**
509 * \brief MissingRoutineInLibrary
510 */
511 static constexpr int MissingRoutineInLibrary = -1801;
512 /**
513 * \brief ResourceNotAvailable
514 */
515 static constexpr int ResourceNotAvailable = -1802;
516 /**
517 * \brief Could not find music file specified, try specifying an absolute path.
518 */
519 static constexpr int MusicFileNotFound = -1900;
520 /**
521 * \brief Music file size is incorrect, could not parse correctly. Ensure you're
522 * using Tuner to generate file.
523 */
524 static constexpr int MusicFileWrongSize = -1901;
525 /**
526 * \brief Music file version is too new, update Phoenix to utilize this file.
527 */
528 static constexpr int MusicFileTooNew = -1902;
529 /**
530 * \brief Music file is invalid. Ensure you're using Tuner to generate file.
531 */
532 static constexpr int MusicFileInvalid = -1903;
533 /**
534 * \brief An invalid orchestra action occurred. Ensure a music file is loaded.
535 */
536 static constexpr int InvalidOrchestraAction = -1904;
537 /**
538 * \brief This music file version is too old. Regenerate file using Tuner.
539 */
540 static constexpr int MusicFileTooOld = -1905;
541 /**
542 * \brief Music interrupted due to one of the instruments being commanded a
543 * different control mode. Press Play to resume music.
544 */
545 static constexpr int MusicInterrupted = -1906;
546 /**
547 * \brief This device doesn't support MusicTone control mode.
548 */
549 static constexpr int MusicNotSupported = -1907;
550 /**
551 * \brief kInvalidInterface
552 */
553 static constexpr int kInvalidInterface = -2000;
554 /**
555 * \brief kInvalidGuid
556 */
557 static constexpr int kInvalidGuid = -2001;
558 /**
559 * \brief kInvalidClass
560 */
561 static constexpr int kInvalidClass = -2002;
562 /**
563 * \brief kInvalidProtocol
564 */
565 static constexpr int kInvalidProtocol = -2003;
566 /**
567 * \brief kInvalidPath
568 */
569 static constexpr int kInvalidPath = -2004;
570 /**
571 * \brief kGeneralWinUsbError
572 */
573 static constexpr int kGeneralWinUsbError = -2005;
574 /**
575 * \brief kFailedSetup
576 */
577 static constexpr int kFailedSetup = -2006;
578 /**
579 * \brief kListenFailed
580 */
581 static constexpr int kListenFailed = -2007;
582 /**
583 * \brief kSendFailed
584 */
585 static constexpr int kSendFailed = -2008;
586 /**
587 * \brief kReceiveFailed
588 */
589 static constexpr int kReceiveFailed = -2009;
590 /**
591 * \brief kInvalidRespFormat
592 */
593 static constexpr int kInvalidRespFormat = -2010;
594 /**
595 * \brief kWinUsbInitFailed
596 */
597 static constexpr int kWinUsbInitFailed = -2011;
598 /**
599 * \brief kWinUsbQueryFailed
600 */
601 static constexpr int kWinUsbQueryFailed = -2012;
602 /**
603 * \brief kWinUsbGeneralError
604 */
605 static constexpr int kWinUsbGeneralError = -2013;
606 /**
607 * \brief kAccessDenied
608 */
609 static constexpr int kAccessDenied = -2014;
610 /**
611 * \brief kFirmwareInvalidResponse
612 */
613 static constexpr int kFirmwareInvalidResponse = -2015;
614 /**
615 * \brief This StatusCode has not been initialized. Make sure the StatusCode is
616 * getting assigned to the return of a method.
617 */
618 static constexpr int StatusCodeNotInitialized = -10000;
619 /**
620 * \brief WarningNotInitialized
621 */
622 static constexpr int WarningNotInitialized = 10000;
623 /**
624 * \brief The timestamp reported by CANivore is at least 10ms older than the
625 * timestamp reported by the system, indicating it's fallen out of sync.
626 * This does not impact the data of this message, only the timing.
627 */
628 static constexpr int HwTimestampOutOfSync = 10001;
629 /**
630 * \brief InvalidNetwork
631 */
632 static constexpr int InvalidNetwork = -10001;
633 /**
634 * \brief The CAN bus does not support multi-signal synchronization.
635 */
636 static constexpr int MultiSignalNotSupported = -10002;
637 /**
638 * \brief Could not cast from base value to this particular signal's type
639 */
640 static constexpr int CouldNotCast = -10003;
641 /**
642 * \brief Could not find this value when searching for it
643 */
644 static constexpr int NotFound = -10004;
645 /**
646 * \brief This is not supported
647 */
648 static constexpr int NotSupported = -10005;
649 /**
650 * \brief Could not determine context from this device hash
651 */
652 static constexpr int MissingContext = -10006;
653 /**
654 * \brief Model name in license file does not match model name of selected
655 * device.
656 */
657 static constexpr int ModelMismatch = -10007;
658 /**
659 * \brief Serial Number in license file does not match model name of selected
660 * device.
661 */
662 static constexpr int SerialMismatch = -10008;
663 /**
664 * \brief Could not find specified file.
665 */
666 static constexpr int NoFile = -10009;
667 /**
668 * \brief License did not successfully download to Device.
669 */
670 static constexpr int LicenseDownloadFailed = -10010;
671 /**
672 * \brief Self Test report does not have any values, is the firmware up to date?
673 */
674 static constexpr int SelfTestIsEmpty = -10011;
675 /**
676 * \brief Failed to lookup signal properties. This can happen if the fimware is
677 * too new and supports signals that older APIs do not support.
678 */
679 static constexpr int SignalLookupFailed = -10012;
680 /**
681 * \brief The current mode of the device is invalid for getting this signal.
682 */
683 static constexpr int InvalidModeToGetSignal = -10013;
684 /**
685 * \brief Device is not licensed. Cannot get any data from it.
686 */
687 static constexpr int UnlicensedDevice = -10014;
688 /**
689 * \brief Size is invalid.
690 */
691 static constexpr int InvalidSize = -10015;
692 /**
693 * \brief InvalidLicenseResponse
694 */
695 static constexpr int InvalidLicenseResponse = -10016;
696 /**
697 * \brief InvalidContext
698 */
699 static constexpr int InvalidContext = -10017;
700 /**
701 * \brief InternalError
702 */
703 static constexpr int InternalError = -10018;
704 /**
705 * \brief kDeviceResponseIncorrect
706 */
707 static constexpr int kDeviceResponseIncorrect = -10019;
708 /**
709 * \brief kErrorPollingForDevices
710 */
711 static constexpr int kErrorPollingForDevices = -10020;
712 /**
713 * \brief Device firmware could not be retrieved. Check that the device is
714 * running v6 firmware, the device ID is correct, the specified CAN bus
715 * is correct, and the device is powered.
716 */
717 static constexpr int CouldNotRetrieveV6Firmware = -10021;
718 /**
719 * \brief Device firmware could not be decoded. Check that the device is running
720 * v6 firmware, the device ID is correct, the specified CAN bus is
721 * correct, and the device is powered.
722 */
723 static constexpr int CouldNotDecodeDeviceFirmware = -10022;
724 /**
725 * \brief The values specified for master are in valid. Make sure the Device ID
726 * of master are correct.
727 */
728 static constexpr int InvalidIDToFollow = -10023;
729 /**
730 * \brief Using a Pro only feature on an unlicensed device. The device may not
731 * behave as expected if it continues to operate while unlicensed.
732 */
733 static constexpr int UsingProFeatureOnUnlicensedDevice = -10024;
734 /**
735 * \brief Firmware Too New. Use Phoenix Tuner X to field upgrade your CTRE CAN
736 * device firmware(CRF) to a compatible version. Then restart your robot
737 * application to clear this error.
738 */
739 static constexpr int FirmwareTooNew = -10025;
740 /**
741 * \brief The data frame could not be serialized for transmit.
742 */
743 static constexpr int CouldNotSerialize = -10026;
744 /**
745 * \brief The mechanism is disabled due to a fault in one of the devices.
746 */
747 static constexpr int MechanismFaulted = -10027;
748 /**
749 * \brief Firmware version is not compatible with this version of Phoenix. Make
750 * sure your firmware and API major versions match.
751 */
752 static constexpr int FirmwareVersNotCompatible = -10028;
753 /**
754 * \brief Could not find specified directory.
755 */
756 static constexpr int DirectoryMissing = -10029;
757 /**
758 * \brief This API version is too old for the firmware on the device. Either
759 * upgrade the API to a newer version or downgrade the device firmware to
760 * an older version for correct behavior.
761 */
762 static constexpr int ApiTooOld = -10030;
763 /**
764 * \brief The signal logger is not running. Start the signal logger before
765 * writing any signals.
766 */
767 static constexpr int LoggerNotRunning = -10031;
768 /**
769 * \brief Blocking operations, such as configs, cannot have a timeout of 0. Pass
770 * in a non-zero timeout (typically 0.050+ seconds) for normal operation.
771 */
772 static constexpr int TimeoutCannotBeZero = -10032;
773 /**
774 * \brief Device cannot be licensed while it is control enabled. Disable and
775 * neutral the device to apply the licenses.
776 */
777 static constexpr int CannotLicenseWhileEnabled = -10033;
778 /**
779 * \brief Could not open or read the given file.
780 */
781 static constexpr int InvalidFile = -10034;
782 /**
783 * \brief The given hoot log requires an older version of Phoenix API.
784 */
785 static constexpr int HootLogTooOld = -10035;
786 /**
787 * \brief The given hoot log requires a newer version of Phoenix API.
788 */
789 static constexpr int HootLogTooNew = -10036;
790 /**
791 * \brief Hoot log is not licensed. Cannot get any data from it.
792 */
793 static constexpr int UnlicensedHootLog = -10037;
794 /**
795 * \brief The simulation timing cannot be advanced by a time step while
796 * unpaused. Pause the simulator before advancing time.
797 */
798 static constexpr int CannotStepWhileUnpaused = -10038;
799 /**
800 * \brief Hoot replay does not support replaying multiple files. Ensure that
801 * only one file is loaded at a time.
802 */
803 static constexpr int MultipleReplayNotSupported = -10039;
804 /**
805 * \brief The maximum number of loggable user signals has been exceeded.
806 * Additional user signals will not be logged.
807 */
808 static constexpr int UserSignalLimitExceeded = -10040;
809 /**
810 * \brief The provided model was not a valid device type.
811 */
812 static constexpr int InvalidDeviceModel = -10041;
813
814 constexpr StatusCode(int val) : value{val} {}
816
817 constexpr operator int() const { return this->value; }
818
819 constexpr bool operator==(StatusCode data) const
820 {
821 return this->value == data.value;
822 }
823 constexpr bool operator==(int data) const
824 {
825 return this->value == data;
826 }
827 constexpr bool operator!=(StatusCode data) const
828 {
829 return this->value != data.value;
830 }
831 constexpr bool operator!=(int data) const
832 {
833 return this->value != data;
834 }
835 constexpr bool operator<(StatusCode data) const
836 {
837 return this->value < data.value;
838 }
839 constexpr bool operator<(int data) const
840 {
841 return this->value < data;
842 }
843
844 /**
845 * \returns true if this code is an error
846 */
847 constexpr bool IsError() const { return value < 0; }
848 /**
849 * \returns true if this code is a warning
850 */
851 constexpr bool IsWarning() const { return value > 0; }
852 /**
853 * \returns true if this code is OK
854 */
855 constexpr bool IsOK() const { return value == OK; }
856
857 /**
858 * Gets the name of this StatusCode
859 *
860 * \returns Name of this StatusCode
861 */
862 constexpr const char *GetName() const
863 {
864 switch (value)
865 {
866 case 0: return "OK";
867 case -100: return "TaskIsBusy";
868 case -101: return "InvalidDeviceSpec";
869 case -102: return "EcuIsNotPresent";
870 case -103: return "CouldNotEnterBl";
871 case -104: return "CouldNotConfirmBl";
872 case -105: return "CouldNotErase";
873 case -106: return "CouldNotSendFlash";
874 case -107: return "CouldNotValidate";
875 case -108: return "CouldNotRunApp";
876 case -109: return "CouldNotReqSetId";
877 case -110: return "CouldNotConfirmId";
878 case -111: return "FlashWasGood";
879 case -112: return "AppTooOld";
880 case -113: return "CouldNotReqSetDesc";
881 case -114: return "CompileSzIsWrong";
882 case -115: return "GadgeteerDeviceNoSetId";
883 case -116: return "InvalidTask";
884 case -117: return "NotImplemented";
885 case -118: return "NoDevicesOnBus";
886 case -119: return "MoreThanOneFile";
887 case -120: return "NodeIsInvalid";
888 case -121: return "InvalidDeviceDescriptor";
889 case -123: return "CouldNotSendCanFrame";
890 case -124: return "NormalModeMsgNotPresent";
891 case -125: return "FeatureNotSupported";
892 case -126: return "NotUpdating";
893 case -127: return "CorruptedPOST";
894 case -128: return "NoConfigs";
895 case -129: return "ConfigFailed";
896 case -130: return "CouldNotReqFactoryDefault";
897 case -131: return "CustomNameNotSupported";
898 case -132: return "ConfigReadWriteMismatch";
899 case -133: return "CouldNotReqSetConfigs";
900 case -134: return "InsufficientSz";
901 case -135: return "InvalidModel";
902 case -140: return "CouldNotReqDevInfo";
903 case -141: return "NoControls";
904 case -142: return "DeviceIsNull";
905 case -143: return "DeviceDidNotRespondToDiagReq";
906 case -144: return "OnlySupportedInTunerX";
907 case -145: return "CanivCliError";
908 case -200: return "InvalidCrfBadHeader";
909 case -201: return "InvalidCrfFileSzInvald";
910 case -202: return "InvalidCrfWrongProduct";
911 case -203: return "InvalidCrfNoSects";
912 case -204: return "InvalidCrfBadSectHeader";
913 case -205: return "InvalidCrfBadSectSize";
914 case -206: return "NoCrfFile";
915 case -300: return "CouldNotFindDynamicId";
916 case -301: return "DidNotGetDhcp";
917 case -302: return "DidNotGetFullDhcp";
918 case -350: return "InvalidLicenseResp";
919 case -351: return "InvalidCanivCache";
920 case -500: return "CannotOpenSerialPort";
921 case -501: return "CannotWriteSerialPort";
922 case -502: return "CannotReadSerialPort";
923 case -503: return "CannotSerialToDevice";
924 case -504: return "NoSerialControlFrameResp";
925 case -600: return "CannotOpenUdpPort";
926 case -601: return "CannotWriteUdpPort";
927 case -602: return "CannotReadUdpPort";
928 case -603: return "CannotUdpToDevice";
929 case -604: return "NoUdpControlFrameResp";
930 case -605: return "TimeoutIso15Response";
931 case -700: return "InvalidJson";
932 case -800: return "AppIsTerminating";
933 case 1000: return "CanMessageStale";
934 case 1006: return "BufferFull";
935 case 1010: return "PulseWidthSensorNotPresent";
936 case 1100: return "GeneralWarning";
937 case 1103: return "FirmVersionCouldNotBeRetrieved";
938 case 1104: return "FeaturesNotAvailableYet";
939 case 1105: return "ControlModeNotValid";
940 case 1106: return "ControlModeNotSupportedYet";
941 case 1109: return "MotProfFirmThreshold";
942 case 1110: return "MotProfFirmThreshold2";
943 case 1200: return "SimDeviceNotFound";
944 case 1201: return "SimPhysicsTypeNotSupported";
945 case 1202: return "SimDeviceAlreadyExists";
946 case -1001: return "TxFailed";
947 case -1002: return "InvalidParamValue";
948 case -1003: return "RxTimeout";
949 case -1004: return "TxTimeout";
950 case -1005: return "UnexpectedArbId";
951 case -1006: return "CanOverflowed";
952 case -1007: return "SensorNotPresent";
953 case -1008: return "FirmwareTooOld";
954 case -1009: return "CouldNotChangePeriod";
955 case -1010: return "BufferFailure";
956 case -1011: return "FirmwareNonFRC";
957 case -1100: return "GeneralError";
958 case -1200: return "SigNotUpdated";
959 case -1201: return "NotAllPIDValuesUpdated";
960 case -1300: return "GEN_PORT_ERROR";
961 case -1301: return "PORT_MODULE_TYPE_MISMATCH";
962 case -1400: return "GEN_MODULE_ERROR";
963 case -1401: return "MODULE_NOT_INIT_SET_ERROR";
964 case -1402: return "MODULE_NOT_INIT_GET_ERROR";
965 case -1500: return "WheelRadiusTooSmall";
966 case -1501: return "TicksPerRevZero";
967 case -1502: return "DistanceBetweenWheelsTooSmall";
968 case -1503: return "GainsAreNotSet";
969 case -1504: return "WrongRemoteLimitSwitchSource";
970 case -1505: return "DoubleVoltageCompensatingWPI";
971 case -1506: return "CANdleAnimSlotOutOfBounds";
972 case -1600: return "IncompatibleMode";
973 case -1601: return "InvalidHandle";
974 case -1700: return "FeatureRequiresHigherFirm";
975 case -1702: return "ConfigFactoryDefaultRequiresHigherFirm";
976 case -1703: return "ConfigMotionSCurveRequiresHigherFirm";
977 case -1704: return "TalonFXFirmwarePreVBatDetect";
978 case -1705: return "CANdleAnimationsRequireHigherFirm";
979 case -1800: return "LibraryCouldNotBeLoaded";
980 case -1801: return "MissingRoutineInLibrary";
981 case -1802: return "ResourceNotAvailable";
982 case -1900: return "MusicFileNotFound";
983 case -1901: return "MusicFileWrongSize";
984 case -1902: return "MusicFileTooNew";
985 case -1903: return "MusicFileInvalid";
986 case -1904: return "InvalidOrchestraAction";
987 case -1905: return "MusicFileTooOld";
988 case -1906: return "MusicInterrupted";
989 case -1907: return "MusicNotSupported";
990 case -2000: return "kInvalidInterface";
991 case -2001: return "kInvalidGuid";
992 case -2002: return "kInvalidClass";
993 case -2003: return "kInvalidProtocol";
994 case -2004: return "kInvalidPath";
995 case -2005: return "kGeneralWinUsbError";
996 case -2006: return "kFailedSetup";
997 case -2007: return "kListenFailed";
998 case -2008: return "kSendFailed";
999 case -2009: return "kReceiveFailed";
1000 case -2010: return "kInvalidRespFormat";
1001 case -2011: return "kWinUsbInitFailed";
1002 case -2012: return "kWinUsbQueryFailed";
1003 case -2013: return "kWinUsbGeneralError";
1004 case -2014: return "kAccessDenied";
1005 case -2015: return "kFirmwareInvalidResponse";
1006 case -10000: return "StatusCodeNotInitialized";
1007 case 10000: return "WarningNotInitialized";
1008 case 10001: return "HwTimestampOutOfSync";
1009 case -10001: return "InvalidNetwork";
1010 case -10002: return "MultiSignalNotSupported";
1011 case -10003: return "CouldNotCast";
1012 case -10004: return "NotFound";
1013 case -10005: return "NotSupported";
1014 case -10006: return "MissingContext";
1015 case -10007: return "ModelMismatch";
1016 case -10008: return "SerialMismatch";
1017 case -10009: return "NoFile";
1018 case -10010: return "LicenseDownloadFailed";
1019 case -10011: return "SelfTestIsEmpty";
1020 case -10012: return "SignalLookupFailed";
1021 case -10013: return "InvalidModeToGetSignal";
1022 case -10014: return "UnlicensedDevice";
1023 case -10015: return "InvalidSize";
1024 case -10016: return "InvalidLicenseResponse";
1025 case -10017: return "InvalidContext";
1026 case -10018: return "InternalError";
1027 case -10019: return "kDeviceResponseIncorrect";
1028 case -10020: return "kErrorPollingForDevices";
1029 case -10021: return "CouldNotRetrieveV6Firmware";
1030 case -10022: return "CouldNotDecodeDeviceFirmware";
1031 case -10023: return "InvalidIDToFollow";
1032 case -10024: return "UsingProFeatureOnUnlicensedDevice";
1033 case -10025: return "FirmwareTooNew";
1034 case -10026: return "CouldNotSerialize";
1035 case -10027: return "MechanismFaulted";
1036 case -10028: return "FirmwareVersNotCompatible";
1037 case -10029: return "DirectoryMissing";
1038 case -10030: return "ApiTooOld";
1039 case -10031: return "LoggerNotRunning";
1040 case -10032: return "TimeoutCannotBeZero";
1041 case -10033: return "CannotLicenseWhileEnabled";
1042 case -10034: return "InvalidFile";
1043 case -10035: return "HootLogTooOld";
1044 case -10036: return "HootLogTooNew";
1045 case -10037: return "UnlicensedHootLog";
1046 case -10038: return "CannotStepWhileUnpaused";
1047 case -10039: return "MultipleReplayNotSupported";
1048 case -10040: return "UserSignalLimitExceeded";
1049 case -10041: return "InvalidDeviceModel";
1050 default:
1051 /* because we return const char*, we cannot create
1052 * a string with the status error code */
1053 return "Could not find name for StatusCode";
1054 }
1055 }
1056 /**
1057 * Gets the description of this StatusCode
1058 *
1059 * \returns Description of this StatusCode
1060 */
1061 constexpr const char *GetDescription() const
1062 {
1063 switch (value)
1064 {
1065 case 0: return "No Error";
1066 case -100: return "Diagnostic Server is busy with another command.";
1067 case -101: return "InvalidDeviceSpec";
1068 case -102: return "Device is not present. Verify the device is connected and powered, and that the CAN bus is terminated.";
1069 case -103: return "Could not put the device into bootloader mode.";
1070 case -104: return "Could not confirm the device has entered the bootloader.";
1071 case -105: return "Could not erase flash.";
1072 case -106: return "Could not field upgrade the device.";
1073 case -107: return "Bootloader could not verify integrity of the flashed application.";
1074 case -108: return "Could not run the device firmware application.";
1075 case -109: return "Unable to set ID to this device.";
1076 case -110: return "Could not verify that the changed ID took effect.";
1077 case -111: return "Device field upgrade was successful.";
1078 case -112: return "Device firmware application is too old.";
1079 case -113: return "Unable to set name to this device.";
1080 case -114: return "CompileSzIsWrong";
1081 case -115: return "Cannot set the ID of a gadgeteer device.";
1082 case -116: return "This diagnostic action is not supported.";
1083 case -117: return "Not Implemented, check latest installer.";
1084 case -118: return "NoDevicesOnBus";
1085 case -119: return "MoreThanOneFile";
1086 case -120: return "Specified device was not found. Verify the device is connected and powered, and that the CAN bus is terminated.";
1087 case -121: return "InvalidDeviceDescriptor";
1088 case -123: return "CouldNotSendCanFrame";
1089 case -124: return "NormalModeMsgNotPresent";
1090 case -125: return "This feature is not supported.";
1091 case -126: return "The diagnostic server is not field upgrading any devices.";
1092 case -127: return "CorruptedPOST";
1093 case -128: return "This device did not report any available configs. Verify firmware and diagnostics are up-to-date.";
1094 case -129: return "ConfigFailed";
1095 case -130: return "Unable to factory default this device.";
1096 case -131: return "CustomNameNotSupported";
1097 case -132: return "The configs read from the device do not match the configs that were written.";
1098 case -133: return "Could not apply the device configs.";
1099 case -134: return "InsufficientSz";
1100 case -135: return "This feature is not supported for this device model.";
1101 case -140: return "CouldNotReqDevInfo";
1102 case -141: return "This device does not support new controls.";
1103 case -142: return "DeviceIsNull";
1104 case -143: return "DeviceDidNotRespondToDiagReq";
1105 case -144: return "This feature requires Tuner X.";
1106 case -145: return "Command-line issue with caniv.";
1107 case -200: return "InvalidCrfBadHeader";
1108 case -201: return "InvalidCrfFileSzInvald";
1109 case -202: return "Specified CRF is for the wrong product.";
1110 case -203: return "InvalidCrfNoSects";
1111 case -204: return "InvalidCrfBadSectHeader";
1112 case -205: return "InvalidCrfBadSectSize";
1113 case -206: return "Specified CRF file could not be found.";
1114 case -300: return "CouldNotFindDynamicId";
1115 case -301: return "DidNotGetDhcp";
1116 case -302: return "DidNotGetFullDhcp";
1117 case -350: return "InvalidLicenseResp";
1118 case -351: return "InvalidCanivCache";
1119 case -500: return "CannotOpenSerialPort";
1120 case -501: return "CannotWriteSerialPort";
1121 case -502: return "CannotReadSerialPort";
1122 case -503: return "CannotSerialToDevice";
1123 case -504: return "NoSerialControlFrameResp";
1124 case -600: return "CannotOpenUdpPort";
1125 case -601: return "CannotWriteUdpPort";
1126 case -602: return "CannotReadUdpPort";
1127 case -603: return "CannotUdpToDevice";
1128 case -604: return "NoUdpControlFrameResp";
1129 case -605: return "TimeoutIso15Response";
1130 case -700: return "InvalidJson";
1131 case -800: return "The user application is shutting down.";
1132 case 1000: return "CAN message is stale, data is valid but old. Check the CAN bus wiring, CAN bus utilization, and power to the device.";
1133 case 1006: return "Buffer is full, cannot insert more data.";
1134 case 1010: return "PulseWidthSensorNotPresent";
1135 case 1100: return "General Warning Occurred.";
1136 case 1103: return "Firm Vers could not be retrieved. Use Phoenix Tuner X to check ID and firmware(CRF) version.";
1137 case 1104: return "This feature will be supported in a future update.";
1138 case 1105: return "The control mode is not valid for this function.";
1139 case 1106: return "This control mode is not supported yet. A future release will supported this soon.";
1140 case 1109: return "Motor Controller must have >= 3.2 firmware for motion profile control mode.";
1141 case 1110: return "Motor Controller must have >= 3.4 firmware for advanced PID0/PID1 features.";
1142 case 1200: return "SimDeviceNotFound";
1143 case 1201: return "SimPhysicsTypeNotSupported";
1144 case 1202: return "SimDeviceAlreadyExists";
1145 case -1001: return "Could not transmit CAN Frame.";
1146 case -1002: return "An invalid argument was passed into the function/VI, such as a null pointer.";
1147 case -1003: return "CAN frame not received/too-stale. Check the CAN bus wiring, CAN bus utilization, and power to the device.";
1148 case -1004: return "CAN Transmit timed out.";
1149 case -1005: return "ArbID is incorrect.";
1150 case -1006: return "CanOverflowed";
1151 case -1007: return "Sensor Not Present.";
1152 case -1008: return "Firmware Too Old. Use Phoenix Tuner X to field upgrade your CTRE CAN device firmware(CRF). Then restart your robot application to clear this error.";
1153 case -1009: return "Control Frame Period could not be changed. Most likely it is not being transmitted.";
1154 case -1010: return "BufferFailure";
1155 case -1011: return "Firmware is legacy non-FRC version. Use Phoenix Tuner X to field upgrade your CTRE CAN device firmware(CRF). Firmware greater than 20.0 required.";
1156 case -1100: return "General Error Occurred.";
1157 case -1200: return "No new response to update signal.";
1158 case -1201: return "NotAllPIDValuesUpdated";
1159 case -1300: return "GEN_PORT_ERROR";
1160 case -1301: return "PORT_MODULE_TYPE_MISMATCH";
1161 case -1400: return "GEN_MODULE_ERROR";
1162 case -1401: return "MODULE_NOT_INIT_SET_ERROR";
1163 case -1402: return "MODULE_NOT_INIT_GET_ERROR";
1164 case -1500: return "Wheel Radius is too small, cannot get distance traveled.";
1165 case -1501: return "Ticks per revolution is 0, cannot get heading.";
1166 case -1502: return "Distance between wheels is too small, cannot get heading.";
1167 case -1503: return "GainsAreNotSet";
1168 case -1504: return "Use RemoteLimitSwitchSource instead of LimitSwitchSource.";
1169 case -1505: return "Motor Controller Voltage Compensation should not be used with setVoltage(). This causes compensation to happen twice. Disable Voltage Compensation by calling enableVoltageCompensation(false) in order to use setVoltage().";
1170 case -1506: return "CANdleAnimSlotOutOfBounds";
1171 case -1600: return "IncompatibleMode";
1172 case -1601: return "Handle passed into function is incorrect.";
1173 case -1700: return "Features requires newer firmware version.";
1174 case -1702: return "Config factory default features require firmware >=3.10.";
1175 case -1703: return "Config Motion S Curve Strength features require firmware >=4.16.";
1176 case -1704: return "Talon FX(Falcon 500) Firmware Too Old. Use Phoenix Tuner to field upgrade your CTRE CAN device firmware(CRF) to >=20.3. Then restart your robot application to clear this error.";
1177 case -1705: return "CANdleAnimationsRequireHigherFirm";
1178 case -1800: return "LibraryCouldNotBeLoaded";
1179 case -1801: return "MissingRoutineInLibrary";
1180 case -1802: return "ResourceNotAvailable";
1181 case -1900: return "Could not find music file specified, try specifying an absolute path.";
1182 case -1901: return "Music file size is incorrect, could not parse correctly. Ensure you're using Tuner to generate file.";
1183 case -1902: return "Music file version is too new, update Phoenix to utilize this file.";
1184 case -1903: return "Music file is invalid. Ensure you're using Tuner to generate file.";
1185 case -1904: return "An invalid orchestra action occurred. Ensure a music file is loaded.";
1186 case -1905: return "This music file version is too old. Regenerate file using Tuner.";
1187 case -1906: return "Music interrupted due to one of the instruments being commanded a different control mode. Press Play to resume music.";
1188 case -1907: return "This device doesn't support MusicTone control mode.";
1189 case -2000: return "kInvalidInterface";
1190 case -2001: return "kInvalidGuid";
1191 case -2002: return "kInvalidClass";
1192 case -2003: return "kInvalidProtocol";
1193 case -2004: return "kInvalidPath";
1194 case -2005: return "kGeneralWinUsbError";
1195 case -2006: return "kFailedSetup";
1196 case -2007: return "kListenFailed";
1197 case -2008: return "kSendFailed";
1198 case -2009: return "kReceiveFailed";
1199 case -2010: return "kInvalidRespFormat";
1200 case -2011: return "kWinUsbInitFailed";
1201 case -2012: return "kWinUsbQueryFailed";
1202 case -2013: return "kWinUsbGeneralError";
1203 case -2014: return "kAccessDenied";
1204 case -2015: return "kFirmwareInvalidResponse";
1205 case -10000: return "This StatusCode has not been initialized. Make sure the StatusCode is getting assigned to the return of a method.";
1206 case 10000: return "WarningNotInitialized";
1207 case 10001: return "The timestamp reported by CANivore is at least 10ms older than the timestamp reported by the system, indicating it's fallen out of sync. This does not impact the data of this message, only the timing.";
1208 case -10001: return "InvalidNetwork";
1209 case -10002: return "The CAN bus does not support multi-signal synchronization.";
1210 case -10003: return "Could not cast from base value to this particular signal's type";
1211 case -10004: return "Could not find this value when searching for it";
1212 case -10005: return "This is not supported";
1213 case -10006: return "Could not determine context from this device hash";
1214 case -10007: return "Model name in license file does not match model name of selected device.";
1215 case -10008: return "Serial Number in license file does not match model name of selected device.";
1216 case -10009: return "Could not find specified file.";
1217 case -10010: return "License did not successfully download to Device.";
1218 case -10011: return "Self Test report does not have any values, is the firmware up to date?";
1219 case -10012: return "Failed to lookup signal properties. This can happen if the fimware is too new and supports signals that older APIs do not support.";
1220 case -10013: return "The current mode of the device is invalid for getting this signal.";
1221 case -10014: return "Device is not licensed. Cannot get any data from it.";
1222 case -10015: return "Size is invalid.";
1223 case -10016: return "InvalidLicenseResponse";
1224 case -10017: return "InvalidContext";
1225 case -10018: return "InternalError";
1226 case -10019: return "kDeviceResponseIncorrect";
1227 case -10020: return "kErrorPollingForDevices";
1228 case -10021: return "Device firmware could not be retrieved. Check that the device is running v6 firmware, the device ID is correct, the specified CAN bus is correct, and the device is powered.";
1229 case -10022: return "Device firmware could not be decoded. Check that the device is running v6 firmware, the device ID is correct, the specified CAN bus is correct, and the device is powered.";
1230 case -10023: return "The values specified for master are in valid. Make sure the Device ID of master are correct.";
1231 case -10024: return "Using a Pro only feature on an unlicensed device. The device may not behave as expected if it continues to operate while unlicensed.";
1232 case -10025: return "Firmware Too New. Use Phoenix Tuner X to field upgrade your CTRE CAN device firmware(CRF) to a compatible version. Then restart your robot application to clear this error.";
1233 case -10026: return "The data frame could not be serialized for transmit.";
1234 case -10027: return "The mechanism is disabled due to a fault in one of the devices.";
1235 case -10028: return "Firmware version is not compatible with this version of Phoenix. Make sure your firmware and API major versions match.";
1236 case -10029: return "Could not find specified directory.";
1237 case -10030: return "This API version is too old for the firmware on the device. Either upgrade the API to a newer version or downgrade the device firmware to an older version for correct behavior.";
1238 case -10031: return "The signal logger is not running. Start the signal logger before writing any signals.";
1239 case -10032: return "Blocking operations, such as configs, cannot have a timeout of 0. Pass in a non-zero timeout (typically 0.050+ seconds) for normal operation.";
1240 case -10033: return "Device cannot be licensed while it is control enabled. Disable and neutral the device to apply the licenses.";
1241 case -10034: return "Could not open or read the given file.";
1242 case -10035: return "The given hoot log requires an older version of Phoenix API.";
1243 case -10036: return "The given hoot log requires a newer version of Phoenix API.";
1244 case -10037: return "Hoot log is not licensed. Cannot get any data from it.";
1245 case -10038: return "The simulation timing cannot be advanced by a time step while unpaused. Pause the simulator before advancing time.";
1246 case -10039: return "Hoot replay does not support replaying multiple files. Ensure that only one file is loaded at a time.";
1247 case -10040: return "The maximum number of loggable user signals has been exceeded. Additional user signals will not be logged.";
1248 case -10041: return "The provided model was not a valid device type.";
1249 default:
1250 /* because we return const char*, we cannot create
1251 * a string with the status error code */
1252 return "Could not find description for StatusCode";
1253 }
1254 }
1255 friend std::ostream &operator<<(std::ostream &os, StatusCode status)
1256 {
1257 os << status.GetName() << ": " << status.GetDescription();
1258 return os;
1259 }
1260 };
1261
1262 }
1263}
1264
1265} // extern "C++"
1266
1267#else // This is straight-C, so just create a typedef enum to use
1268
1269/**
1270 * \brief Typedef enum of the StatusCode for use in C projects
1271 */
1272typedef enum _StatusCode_t
1273{
1274 /**
1275 * \brief No Error
1276 */
1277 OK = 0,
1278 /**
1279 * \brief Diagnostic Server is busy with another command.
1280 */
1281 TaskIsBusy = -100,
1282 /**
1283 * \brief InvalidDeviceSpec
1284 */
1285 InvalidDeviceSpec = -101,
1286 /**
1287 * \brief Device is not present. Verify the device is connected and powered, and
1288 * that the CAN bus is terminated.
1289 */
1290 EcuIsNotPresent = -102,
1291 /**
1292 * \brief Could not put the device into bootloader mode.
1293 */
1294 CouldNotEnterBl = -103,
1295 /**
1296 * \brief Could not confirm the device has entered the bootloader.
1297 */
1298 CouldNotConfirmBl = -104,
1299 /**
1300 * \brief Could not erase flash.
1301 */
1302 CouldNotErase = -105,
1303 /**
1304 * \brief Could not field upgrade the device.
1305 */
1306 CouldNotSendFlash = -106,
1307 /**
1308 * \brief Bootloader could not verify integrity of the flashed application.
1309 */
1310 CouldNotValidate = -107,
1311 /**
1312 * \brief Could not run the device firmware application.
1313 */
1314 CouldNotRunApp = -108,
1315 /**
1316 * \brief Unable to set ID to this device.
1317 */
1318 CouldNotReqSetId = -109,
1319 /**
1320 * \brief Could not verify that the changed ID took effect.
1321 */
1322 CouldNotConfirmId = -110,
1323 /**
1324 * \brief Device field upgrade was successful.
1325 */
1326 FlashWasGood = -111,
1327 /**
1328 * \brief Device firmware application is too old.
1329 */
1330 AppTooOld = -112,
1331 /**
1332 * \brief Unable to set name to this device.
1333 */
1334 CouldNotReqSetDesc = -113,
1335 /**
1336 * \brief CompileSzIsWrong
1337 */
1338 CompileSzIsWrong = -114,
1339 /**
1340 * \brief Cannot set the ID of a gadgeteer device.
1341 */
1342 GadgeteerDeviceNoSetId = -115,
1343 /**
1344 * \brief This diagnostic action is not supported.
1345 */
1346 InvalidTask = -116,
1347 /**
1348 * \brief Not Implemented, check latest installer.
1349 */
1350 NotImplemented = -117,
1351 /**
1352 * \brief NoDevicesOnBus
1353 */
1354 NoDevicesOnBus = -118,
1355 /**
1356 * \brief MoreThanOneFile
1357 */
1358 MoreThanOneFile = -119,
1359 /**
1360 * \brief Specified device was not found. Verify the device is connected and
1361 * powered, and that the CAN bus is terminated.
1362 */
1363 NodeIsInvalid = -120,
1364 /**
1365 * \brief InvalidDeviceDescriptor
1366 */
1367 InvalidDeviceDescriptor = -121,
1368 /**
1369 * \brief CouldNotSendCanFrame
1370 */
1371 CouldNotSendCanFrame = -123,
1372 /**
1373 * \brief NormalModeMsgNotPresent
1374 */
1375 NormalModeMsgNotPresent = -124,
1376 /**
1377 * \brief This feature is not supported.
1378 */
1379 FeatureNotSupported = -125,
1380 /**
1381 * \brief The diagnostic server is not field upgrading any devices.
1382 */
1383 NotUpdating = -126,
1384 /**
1385 * \brief CorruptedPOST
1386 */
1387 CorruptedPOST = -127,
1388 /**
1389 * \brief This device did not report any available configs. Verify firmware and
1390 * diagnostics are up-to-date.
1391 */
1392 NoConfigs = -128,
1393 /**
1394 * \brief ConfigFailed
1395 */
1396 ConfigFailed = -129,
1397 /**
1398 * \brief Unable to factory default this device.
1399 */
1400 CouldNotReqFactoryDefault = -130,
1401 /**
1402 * \brief CustomNameNotSupported
1403 */
1404 CustomNameNotSupported = -131,
1405 /**
1406 * \brief The configs read from the device do not match the configs that were
1407 * written.
1408 */
1409 ConfigReadWriteMismatch = -132,
1410 /**
1411 * \brief Could not apply the device configs.
1412 */
1413 CouldNotReqSetConfigs = -133,
1414 /**
1415 * \brief InsufficientSz
1416 */
1417 InsufficientSz = -134,
1418 /**
1419 * \brief This feature is not supported for this device model.
1420 */
1421 InvalidModel = -135,
1422 /**
1423 * \brief CouldNotReqDevInfo
1424 */
1425 CouldNotReqDevInfo = -140,
1426 /**
1427 * \brief This device does not support new controls.
1428 */
1429 NoControls = -141,
1430 /**
1431 * \brief DeviceIsNull
1432 */
1433 DeviceIsNull = -142,
1434 /**
1435 * \brief DeviceDidNotRespondToDiagReq
1436 */
1437 DeviceDidNotRespondToDiagReq = -143,
1438 /**
1439 * \brief This feature requires Tuner X.
1440 */
1441 OnlySupportedInTunerX = -144,
1442 /**
1443 * \brief Command-line issue with caniv.
1444 */
1445 CanivCliError = -145,
1446 /**
1447 * \brief InvalidCrfBadHeader
1448 */
1449 InvalidCrfBadHeader = -200,
1450 /**
1451 * \brief InvalidCrfFileSzInvald
1452 */
1453 InvalidCrfFileSzInvald = -201,
1454 /**
1455 * \brief Specified CRF is for the wrong product.
1456 */
1457 InvalidCrfWrongProduct = -202,
1458 /**
1459 * \brief InvalidCrfNoSects
1460 */
1461 InvalidCrfNoSects = -203,
1462 /**
1463 * \brief InvalidCrfBadSectHeader
1464 */
1465 InvalidCrfBadSectHeader = -204,
1466 /**
1467 * \brief InvalidCrfBadSectSize
1468 */
1469 InvalidCrfBadSectSize = -205,
1470 /**
1471 * \brief Specified CRF file could not be found.
1472 */
1473 NoCrfFile = -206,
1474 /**
1475 * \brief CouldNotFindDynamicId
1476 */
1477 CouldNotFindDynamicId = -300,
1478 /**
1479 * \brief DidNotGetDhcp
1480 */
1481 DidNotGetDhcp = -301,
1482 /**
1483 * \brief DidNotGetFullDhcp
1484 */
1485 DidNotGetFullDhcp = -302,
1486 /**
1487 * \brief InvalidLicenseResp
1488 */
1489 InvalidLicenseResp = -350,
1490 /**
1491 * \brief InvalidCanivCache
1492 */
1493 InvalidCanivCache = -351,
1494 /**
1495 * \brief CannotOpenSerialPort
1496 */
1497 CannotOpenSerialPort = -500,
1498 /**
1499 * \brief CannotWriteSerialPort
1500 */
1501 CannotWriteSerialPort = -501,
1502 /**
1503 * \brief CannotReadSerialPort
1504 */
1505 CannotReadSerialPort = -502,
1506 /**
1507 * \brief CannotSerialToDevice
1508 */
1509 CannotSerialToDevice = -503,
1510 /**
1511 * \brief NoSerialControlFrameResp
1512 */
1513 NoSerialControlFrameResp = -504,
1514 /**
1515 * \brief CannotOpenUdpPort
1516 */
1517 CannotOpenUdpPort = -600,
1518 /**
1519 * \brief CannotWriteUdpPort
1520 */
1521 CannotWriteUdpPort = -601,
1522 /**
1523 * \brief CannotReadUdpPort
1524 */
1525 CannotReadUdpPort = -602,
1526 /**
1527 * \brief CannotUdpToDevice
1528 */
1529 CannotUdpToDevice = -603,
1530 /**
1531 * \brief NoUdpControlFrameResp
1532 */
1533 NoUdpControlFrameResp = -604,
1534 /**
1535 * \brief TimeoutIso15Response
1536 */
1537 TimeoutIso15Response = -605,
1538 /**
1539 * \brief InvalidJson
1540 */
1541 InvalidJson = -700,
1542 /**
1543 * \brief The user application is shutting down.
1544 */
1545 AppIsTerminating = -800,
1546 /**
1547 * \brief CAN message is stale, data is valid but old. Check the CAN bus wiring,
1548 * CAN bus utilization, and power to the device.
1549 */
1550 CanMessageStale = 1000,
1551 /**
1552 * \brief Buffer is full, cannot insert more data.
1553 */
1554 BufferFull = 1006,
1555 /**
1556 * \brief PulseWidthSensorNotPresent
1557 */
1558 PulseWidthSensorNotPresent = 1010,
1559 /**
1560 * \brief General Warning Occurred.
1561 */
1562 GeneralWarning = 1100,
1563 /**
1564 * \brief Firm Vers could not be retrieved. Use Phoenix Tuner X to check ID and
1565 * firmware(CRF) version.
1566 */
1567 FirmVersionCouldNotBeRetrieved = 1103,
1568 /**
1569 * \brief This feature will be supported in a future update.
1570 */
1571 FeaturesNotAvailableYet = 1104,
1572 /**
1573 * \brief The control mode is not valid for this function.
1574 */
1575 ControlModeNotValid = 1105,
1576 /**
1577 * \brief This control mode is not supported yet. A future release will
1578 * supported this soon.
1579 */
1580 ControlModeNotSupportedYet = 1106,
1581 /**
1582 * \brief Motor Controller must have &gt;= 3.2 firmware for motion profile
1583 * control mode.
1584 */
1585 MotProfFirmThreshold = 1109,
1586 /**
1587 * \brief Motor Controller must have &gt;= 3.4 firmware for advanced PID0/PID1
1588 * features.
1589 */
1590 MotProfFirmThreshold2 = 1110,
1591 /**
1592 * \brief SimDeviceNotFound
1593 */
1594 SimDeviceNotFound = 1200,
1595 /**
1596 * \brief SimPhysicsTypeNotSupported
1597 */
1598 SimPhysicsTypeNotSupported = 1201,
1599 /**
1600 * \brief SimDeviceAlreadyExists
1601 */
1602 SimDeviceAlreadyExists = 1202,
1603 /**
1604 * \brief Could not transmit CAN Frame.
1605 */
1606 TxFailed = -1001,
1607 /**
1608 * \brief An invalid argument was passed into the function/VI, such as a null
1609 * pointer.
1610 */
1611 InvalidParamValue = -1002,
1612 /**
1613 * \brief CAN frame not received/too-stale. Check the CAN bus wiring, CAN bus
1614 * utilization, and power to the device.
1615 */
1616 RxTimeout = -1003,
1617 /**
1618 * \brief CAN Transmit timed out.
1619 */
1620 TxTimeout = -1004,
1621 /**
1622 * \brief ArbID is incorrect.
1623 */
1624 UnexpectedArbId = -1005,
1625 /**
1626 * \brief CanOverflowed
1627 */
1628 CanOverflowed = -1006,
1629 /**
1630 * \brief Sensor Not Present.
1631 */
1632 SensorNotPresent = -1007,
1633 /**
1634 * \brief Firmware Too Old. Use Phoenix Tuner X to field upgrade your CTRE CAN
1635 * device firmware(CRF). Then restart your robot application to clear
1636 * this error.
1637 */
1638 FirmwareTooOld = -1008,
1639 /**
1640 * \brief Control Frame Period could not be changed. Most likely it is not
1641 * being transmitted.
1642 */
1643 CouldNotChangePeriod = -1009,
1644 /**
1645 * \brief BufferFailure
1646 */
1647 BufferFailure = -1010,
1648 /**
1649 * \brief Firmware is legacy non-FRC version. Use Phoenix Tuner X to field
1650 * upgrade your CTRE CAN device firmware(CRF). Firmware greater than
1651 * 20.0 required.
1652 */
1653 FirmwareNonFRC = -1011,
1654 /**
1655 * \brief General Error Occurred.
1656 */
1657 GeneralError = -1100,
1658 /**
1659 * \brief No new response to update signal.
1660 */
1661 SigNotUpdated = -1200,
1662 /**
1663 * \brief NotAllPIDValuesUpdated
1664 */
1665 NotAllPIDValuesUpdated = -1201,
1666 /**
1667 * \brief GEN_PORT_ERROR
1668 */
1669 GEN_PORT_ERROR = -1300,
1670 /**
1671 * \brief PORT_MODULE_TYPE_MISMATCH
1672 */
1673 PORT_MODULE_TYPE_MISMATCH = -1301,
1674 /**
1675 * \brief GEN_MODULE_ERROR
1676 */
1677 GEN_MODULE_ERROR = -1400,
1678 /**
1679 * \brief MODULE_NOT_INIT_SET_ERROR
1680 */
1681 MODULE_NOT_INIT_SET_ERROR = -1401,
1682 /**
1683 * \brief MODULE_NOT_INIT_GET_ERROR
1684 */
1685 MODULE_NOT_INIT_GET_ERROR = -1402,
1686 /**
1687 * \brief Wheel Radius is too small, cannot get distance traveled.
1688 */
1689 WheelRadiusTooSmall = -1500,
1690 /**
1691 * \brief Ticks per revolution is 0, cannot get heading.
1692 */
1693 TicksPerRevZero = -1501,
1694 /**
1695 * \brief Distance between wheels is too small, cannot get heading.
1696 */
1697 DistanceBetweenWheelsTooSmall = -1502,
1698 /**
1699 * \brief GainsAreNotSet
1700 */
1701 GainsAreNotSet = -1503,
1702 /**
1703 * \brief Use RemoteLimitSwitchSource instead of LimitSwitchSource.
1704 */
1705 WrongRemoteLimitSwitchSource = -1504,
1706 /**
1707 * \brief Motor Controller Voltage Compensation should not be used with
1708 * setVoltage(). This causes compensation to happen twice. Disable
1709 * Voltage Compensation by calling enableVoltageCompensation(false) in
1710 * order to use setVoltage().
1711 */
1712 DoubleVoltageCompensatingWPI = -1505,
1713 /**
1714 * \brief CANdleAnimSlotOutOfBounds
1715 */
1716 CANdleAnimSlotOutOfBounds = -1506,
1717 /**
1718 * \brief IncompatibleMode
1719 */
1720 IncompatibleMode = -1600,
1721 /**
1722 * \brief Handle passed into function is incorrect.
1723 */
1724 InvalidHandle = -1601,
1725 /**
1726 * \brief Features requires newer firmware version.
1727 */
1728 FeatureRequiresHigherFirm = -1700,
1729 /**
1730 * \brief Config factory default features require firmware &gt;=3.10.
1731 */
1732 ConfigFactoryDefaultRequiresHigherFirm = -1702,
1733 /**
1734 * \brief Config Motion S Curve Strength features require firmware &gt;=4.16.
1735 */
1736 ConfigMotionSCurveRequiresHigherFirm = -1703,
1737 /**
1738 * \brief Talon FX(Falcon 500) Firmware Too Old. Use Phoenix Tuner to field
1739 * upgrade your CTRE CAN device firmware(CRF) to &gt;=20.3. Then restart
1740 * your robot application to clear this error.
1741 */
1742 TalonFXFirmwarePreVBatDetect = -1704,
1743 /**
1744 * \brief CANdleAnimationsRequireHigherFirm
1745 */
1746 CANdleAnimationsRequireHigherFirm = -1705,
1747 /**
1748 * \brief LibraryCouldNotBeLoaded
1749 */
1750 LibraryCouldNotBeLoaded = -1800,
1751 /**
1752 * \brief MissingRoutineInLibrary
1753 */
1754 MissingRoutineInLibrary = -1801,
1755 /**
1756 * \brief ResourceNotAvailable
1757 */
1758 ResourceNotAvailable = -1802,
1759 /**
1760 * \brief Could not find music file specified, try specifying an absolute path.
1761 */
1762 MusicFileNotFound = -1900,
1763 /**
1764 * \brief Music file size is incorrect, could not parse correctly. Ensure you're
1765 * using Tuner to generate file.
1766 */
1767 MusicFileWrongSize = -1901,
1768 /**
1769 * \brief Music file version is too new, update Phoenix to utilize this file.
1770 */
1771 MusicFileTooNew = -1902,
1772 /**
1773 * \brief Music file is invalid. Ensure you're using Tuner to generate file.
1774 */
1775 MusicFileInvalid = -1903,
1776 /**
1777 * \brief An invalid orchestra action occurred. Ensure a music file is loaded.
1778 */
1779 InvalidOrchestraAction = -1904,
1780 /**
1781 * \brief This music file version is too old. Regenerate file using Tuner.
1782 */
1783 MusicFileTooOld = -1905,
1784 /**
1785 * \brief Music interrupted due to one of the instruments being commanded a
1786 * different control mode. Press Play to resume music.
1787 */
1788 MusicInterrupted = -1906,
1789 /**
1790 * \brief This device doesn't support MusicTone control mode.
1791 */
1792 MusicNotSupported = -1907,
1793 /**
1794 * \brief kInvalidInterface
1795 */
1796 kInvalidInterface = -2000,
1797 /**
1798 * \brief kInvalidGuid
1799 */
1800 kInvalidGuid = -2001,
1801 /**
1802 * \brief kInvalidClass
1803 */
1804 kInvalidClass = -2002,
1805 /**
1806 * \brief kInvalidProtocol
1807 */
1808 kInvalidProtocol = -2003,
1809 /**
1810 * \brief kInvalidPath
1811 */
1812 kInvalidPath = -2004,
1813 /**
1814 * \brief kGeneralWinUsbError
1815 */
1816 kGeneralWinUsbError = -2005,
1817 /**
1818 * \brief kFailedSetup
1819 */
1820 kFailedSetup = -2006,
1821 /**
1822 * \brief kListenFailed
1823 */
1824 kListenFailed = -2007,
1825 /**
1826 * \brief kSendFailed
1827 */
1828 kSendFailed = -2008,
1829 /**
1830 * \brief kReceiveFailed
1831 */
1832 kReceiveFailed = -2009,
1833 /**
1834 * \brief kInvalidRespFormat
1835 */
1836 kInvalidRespFormat = -2010,
1837 /**
1838 * \brief kWinUsbInitFailed
1839 */
1840 kWinUsbInitFailed = -2011,
1841 /**
1842 * \brief kWinUsbQueryFailed
1843 */
1844 kWinUsbQueryFailed = -2012,
1845 /**
1846 * \brief kWinUsbGeneralError
1847 */
1848 kWinUsbGeneralError = -2013,
1849 /**
1850 * \brief kAccessDenied
1851 */
1852 kAccessDenied = -2014,
1853 /**
1854 * \brief kFirmwareInvalidResponse
1855 */
1856 kFirmwareInvalidResponse = -2015,
1857 /**
1858 * \brief This StatusCode has not been initialized. Make sure the StatusCode is
1859 * getting assigned to the return of a method.
1860 */
1861 StatusCodeNotInitialized = -10000,
1862 /**
1863 * \brief WarningNotInitialized
1864 */
1865 WarningNotInitialized = 10000,
1866 /**
1867 * \brief The timestamp reported by CANivore is at least 10ms older than the
1868 * timestamp reported by the system, indicating it's fallen out of sync.
1869 * This does not impact the data of this message, only the timing.
1870 */
1871 HwTimestampOutOfSync = 10001,
1872 /**
1873 * \brief InvalidNetwork
1874 */
1875 InvalidNetwork = -10001,
1876 /**
1877 * \brief The CAN bus does not support multi-signal synchronization.
1878 */
1879 MultiSignalNotSupported = -10002,
1880 /**
1881 * \brief Could not cast from base value to this particular signal's type
1882 */
1883 CouldNotCast = -10003,
1884 /**
1885 * \brief Could not find this value when searching for it
1886 */
1887 NotFound = -10004,
1888 /**
1889 * \brief This is not supported
1890 */
1891 NotSupported = -10005,
1892 /**
1893 * \brief Could not determine context from this device hash
1894 */
1895 MissingContext = -10006,
1896 /**
1897 * \brief Model name in license file does not match model name of selected
1898 * device.
1899 */
1900 ModelMismatch = -10007,
1901 /**
1902 * \brief Serial Number in license file does not match model name of selected
1903 * device.
1904 */
1905 SerialMismatch = -10008,
1906 /**
1907 * \brief Could not find specified file.
1908 */
1909 NoFile = -10009,
1910 /**
1911 * \brief License did not successfully download to Device.
1912 */
1913 LicenseDownloadFailed = -10010,
1914 /**
1915 * \brief Self Test report does not have any values, is the firmware up to date?
1916 */
1917 SelfTestIsEmpty = -10011,
1918 /**
1919 * \brief Failed to lookup signal properties. This can happen if the fimware is
1920 * too new and supports signals that older APIs do not support.
1921 */
1922 SignalLookupFailed = -10012,
1923 /**
1924 * \brief The current mode of the device is invalid for getting this signal.
1925 */
1926 InvalidModeToGetSignal = -10013,
1927 /**
1928 * \brief Device is not licensed. Cannot get any data from it.
1929 */
1930 UnlicensedDevice = -10014,
1931 /**
1932 * \brief Size is invalid.
1933 */
1934 InvalidSize = -10015,
1935 /**
1936 * \brief InvalidLicenseResponse
1937 */
1938 InvalidLicenseResponse = -10016,
1939 /**
1940 * \brief InvalidContext
1941 */
1942 InvalidContext = -10017,
1943 /**
1944 * \brief InternalError
1945 */
1946 InternalError = -10018,
1947 /**
1948 * \brief kDeviceResponseIncorrect
1949 */
1950 kDeviceResponseIncorrect = -10019,
1951 /**
1952 * \brief kErrorPollingForDevices
1953 */
1954 kErrorPollingForDevices = -10020,
1955 /**
1956 * \brief Device firmware could not be retrieved. Check that the device is
1957 * running v6 firmware, the device ID is correct, the specified CAN bus
1958 * is correct, and the device is powered.
1959 */
1960 CouldNotRetrieveV6Firmware = -10021,
1961 /**
1962 * \brief Device firmware could not be decoded. Check that the device is running
1963 * v6 firmware, the device ID is correct, the specified CAN bus is
1964 * correct, and the device is powered.
1965 */
1966 CouldNotDecodeDeviceFirmware = -10022,
1967 /**
1968 * \brief The values specified for master are in valid. Make sure the Device ID
1969 * of master are correct.
1970 */
1971 InvalidIDToFollow = -10023,
1972 /**
1973 * \brief Using a Pro only feature on an unlicensed device. The device may not
1974 * behave as expected if it continues to operate while unlicensed.
1975 */
1976 UsingProFeatureOnUnlicensedDevice = -10024,
1977 /**
1978 * \brief Firmware Too New. Use Phoenix Tuner X to field upgrade your CTRE CAN
1979 * device firmware(CRF) to a compatible version. Then restart your robot
1980 * application to clear this error.
1981 */
1982 FirmwareTooNew = -10025,
1983 /**
1984 * \brief The data frame could not be serialized for transmit.
1985 */
1986 CouldNotSerialize = -10026,
1987 /**
1988 * \brief The mechanism is disabled due to a fault in one of the devices.
1989 */
1990 MechanismFaulted = -10027,
1991 /**
1992 * \brief Firmware version is not compatible with this version of Phoenix. Make
1993 * sure your firmware and API major versions match.
1994 */
1995 FirmwareVersNotCompatible = -10028,
1996 /**
1997 * \brief Could not find specified directory.
1998 */
1999 DirectoryMissing = -10029,
2000 /**
2001 * \brief This API version is too old for the firmware on the device. Either
2002 * upgrade the API to a newer version or downgrade the device firmware to
2003 * an older version for correct behavior.
2004 */
2005 ApiTooOld = -10030,
2006 /**
2007 * \brief The signal logger is not running. Start the signal logger before
2008 * writing any signals.
2009 */
2010 LoggerNotRunning = -10031,
2011 /**
2012 * \brief Blocking operations, such as configs, cannot have a timeout of 0. Pass
2013 * in a non-zero timeout (typically 0.050+ seconds) for normal operation.
2014 */
2015 TimeoutCannotBeZero = -10032,
2016 /**
2017 * \brief Device cannot be licensed while it is control enabled. Disable and
2018 * neutral the device to apply the licenses.
2019 */
2020 CannotLicenseWhileEnabled = -10033,
2021 /**
2022 * \brief Could not open or read the given file.
2023 */
2024 InvalidFile = -10034,
2025 /**
2026 * \brief The given hoot log requires an older version of Phoenix API.
2027 */
2028 HootLogTooOld = -10035,
2029 /**
2030 * \brief The given hoot log requires a newer version of Phoenix API.
2031 */
2032 HootLogTooNew = -10036,
2033 /**
2034 * \brief Hoot log is not licensed. Cannot get any data from it.
2035 */
2036 UnlicensedHootLog = -10037,
2037 /**
2038 * \brief The simulation timing cannot be advanced by a time step while
2039 * unpaused. Pause the simulator before advancing time.
2040 */
2041 CannotStepWhileUnpaused = -10038,
2042 /**
2043 * \brief Hoot replay does not support replaying multiple files. Ensure that
2044 * only one file is loaded at a time.
2045 */
2046 MultipleReplayNotSupported = -10039,
2047 /**
2048 * \brief The maximum number of loggable user signals has been exceeded.
2049 * Additional user signals will not be logged.
2050 */
2051 UserSignalLimitExceeded = -10040,
2052 /**
2053 * \brief The provided model was not a valid device type.
2054 */
2055 InvalidDeviceModel = -10041,
2056} StatusCode_t;
2057
2058/**
2059 * \brief Get the name of the StatusCode passed
2060 *
2061 * \param value StatusCode to get name of
2062 * \returns const char* Name of StatusCode
2063 */
2064const char *GetStatusCodeName(StatusCode_t value);
2065/**
2066 * \brief Get the description of the StatusCode passed
2067 *
2068 * \param value StatusCode to get description of
2069 * \returns const char* Description of StatusCode
2070 */
2071const char *GetStatusCodeDescription(StatusCode_t value);
2072
2073#endif
Status codes reported by APIs, including OK, warnings, and errors.
Definition: StatusCodes.h:27
static constexpr int CANdleAnimationsRequireHigherFirm
CANdleAnimationsRequireHigherFirm.
Definition: StatusCodes.h:503
static constexpr int InvalidContext
InvalidContext.
Definition: StatusCodes.h:699
static constexpr int PulseWidthSensorNotPresent
PulseWidthSensorNotPresent.
Definition: StatusCodes.h:315
static constexpr int kAccessDenied
kAccessDenied
Definition: StatusCodes.h:609
static constexpr int FirmVersionCouldNotBeRetrieved
Firm Vers could not be retrieved.
Definition: StatusCodes.h:324
static constexpr int NoFile
Could not find specified file.
Definition: StatusCodes.h:666
static constexpr int FeatureRequiresHigherFirm
Features requires newer firmware version.
Definition: StatusCodes.h:485
static constexpr int FirmwareNonFRC
Firmware is legacy non-FRC version.
Definition: StatusCodes.h:410
friend std::ostream & operator<<(std::ostream &os, StatusCode status)
Definition: StatusCodes.h:1255
static constexpr int MusicFileWrongSize
Music file size is incorrect, could not parse correctly.
Definition: StatusCodes.h:524
static constexpr int kGeneralWinUsbError
kGeneralWinUsbError
Definition: StatusCodes.h:573
static constexpr int kWinUsbGeneralError
kWinUsbGeneralError
Definition: StatusCodes.h:605
static constexpr int PORT_MODULE_TYPE_MISMATCH
PORT_MODULE_TYPE_MISMATCH.
Definition: StatusCodes.h:430
static constexpr int SensorNotPresent
Sensor Not Present.
Definition: StatusCodes.h:389
static constexpr int kFirmwareInvalidResponse
kFirmwareInvalidResponse
Definition: StatusCodes.h:613
static constexpr int NotUpdating
The diagnostic server is not field upgrading any devices.
Definition: StatusCodes.h:140
static constexpr int InvalidIDToFollow
The values specified for master are in valid.
Definition: StatusCodes.h:728
static constexpr int CannotStepWhileUnpaused
The simulation timing cannot be advanced by a time step while unpaused.
Definition: StatusCodes.h:798
static constexpr int InternalError
InternalError.
Definition: StatusCodes.h:703
static constexpr int CouldNotChangePeriod
Control Frame Period could not be changed.
Definition: StatusCodes.h:400
static constexpr int IncompatibleMode
IncompatibleMode.
Definition: StatusCodes.h:477
static constexpr int ControlModeNotSupportedYet
This control mode is not supported yet.
Definition: StatusCodes.h:337
static constexpr int NormalModeMsgNotPresent
NormalModeMsgNotPresent.
Definition: StatusCodes.h:132
static constexpr int CouldNotReqDevInfo
CouldNotReqDevInfo.
Definition: StatusCodes.h:182
static constexpr int SimPhysicsTypeNotSupported
SimPhysicsTypeNotSupported.
Definition: StatusCodes.h:355
static constexpr int HootLogTooNew
The given hoot log requires a newer version of Phoenix API.
Definition: StatusCodes.h:789
constexpr const char * GetDescription() const
Gets the description of this StatusCode.
Definition: StatusCodes.h:1061
static constexpr int OK
No Error.
Definition: StatusCodes.h:34
static constexpr int StatusCodeNotInitialized
This StatusCode has not been initialized.
Definition: StatusCodes.h:618
static constexpr int AppIsTerminating
The user application is shutting down.
Definition: StatusCodes.h:302
static constexpr int DoubleVoltageCompensatingWPI
Motor Controller Voltage Compensation should not be used with setVoltage().
Definition: StatusCodes.h:469
static constexpr int GEN_MODULE_ERROR
GEN_MODULE_ERROR.
Definition: StatusCodes.h:434
static constexpr int NotImplemented
Not Implemented, check latest installer.
Definition: StatusCodes.h:107
static constexpr int SignalLookupFailed
Failed to lookup signal properties.
Definition: StatusCodes.h:679
static constexpr int UnlicensedDevice
Device is not licensed.
Definition: StatusCodes.h:687
static constexpr int kInvalidGuid
kInvalidGuid
Definition: StatusCodes.h:557
static constexpr int CouldNotCast
Could not cast from base value to this particular signal's type.
Definition: StatusCodes.h:640
static constexpr int SimDeviceNotFound
SimDeviceNotFound.
Definition: StatusCodes.h:351
static constexpr int CouldNotValidate
Bootloader could not verify integrity of the flashed application.
Definition: StatusCodes.h:67
static constexpr int InvalidCrfNoSects
InvalidCrfNoSects.
Definition: StatusCodes.h:218
static constexpr int CouldNotReqSetDesc
Unable to set name to this device.
Definition: StatusCodes.h:91
static constexpr int CannotUdpToDevice
CannotUdpToDevice.
Definition: StatusCodes.h:286
static constexpr int MusicFileTooOld
This music file version is too old.
Definition: StatusCodes.h:540
static constexpr int InvalidHandle
Handle passed into function is incorrect.
Definition: StatusCodes.h:481
static constexpr int CannotOpenSerialPort
CannotOpenSerialPort.
Definition: StatusCodes.h:254
constexpr bool operator!=(int data) const
Definition: StatusCodes.h:831
static constexpr int kInvalidInterface
kInvalidInterface
Definition: StatusCodes.h:553
static constexpr int ConfigReadWriteMismatch
The configs read from the device do not match the configs that were written.
Definition: StatusCodes.h:166
static constexpr int NotAllPIDValuesUpdated
NotAllPIDValuesUpdated.
Definition: StatusCodes.h:422
static constexpr int TaskIsBusy
Diagnostic Server is busy with another command.
Definition: StatusCodes.h:38
constexpr const char * GetName() const
Gets the name of this StatusCode.
Definition: StatusCodes.h:862
static constexpr int kInvalidProtocol
kInvalidProtocol
Definition: StatusCodes.h:565
static constexpr int CouldNotSendFlash
Could not field upgrade the device.
Definition: StatusCodes.h:63
static constexpr int CannotOpenUdpPort
CannotOpenUdpPort.
Definition: StatusCodes.h:274
static constexpr int CanivCliError
Command-line issue with caniv.
Definition: StatusCodes.h:202
constexpr bool operator!=(StatusCode data) const
Definition: StatusCodes.h:827
static constexpr int InsufficientSz
InsufficientSz.
Definition: StatusCodes.h:174
static constexpr int AppTooOld
Device firmware application is too old.
Definition: StatusCodes.h:87
constexpr bool operator==(int data) const
Definition: StatusCodes.h:823
static constexpr int MultipleReplayNotSupported
Hoot replay does not support replaying multiple files.
Definition: StatusCodes.h:803
static constexpr int WarningNotInitialized
WarningNotInitialized.
Definition: StatusCodes.h:622
static constexpr int MODULE_NOT_INIT_SET_ERROR
MODULE_NOT_INIT_SET_ERROR.
Definition: StatusCodes.h:438
static constexpr int InvalidJson
InvalidJson.
Definition: StatusCodes.h:298
static constexpr int BufferFull
Buffer is full, cannot insert more data.
Definition: StatusCodes.h:311
static constexpr int MusicFileInvalid
Music file is invalid.
Definition: StatusCodes.h:532
static constexpr int DidNotGetFullDhcp
DidNotGetFullDhcp.
Definition: StatusCodes.h:242
static constexpr int CanOverflowed
CanOverflowed.
Definition: StatusCodes.h:385
static constexpr int MotProfFirmThreshold2
Motor Controller must have >= 3.4 firmware for advanced PID0/PID1 features.
Definition: StatusCodes.h:347
static constexpr int FlashWasGood
Device field upgrade was successful.
Definition: StatusCodes.h:83
static constexpr int CouldNotRunApp
Could not run the device firmware application.
Definition: StatusCodes.h:71
static constexpr int CouldNotConfirmBl
Could not confirm the device has entered the bootloader.
Definition: StatusCodes.h:55
static constexpr int GeneralError
General Error Occurred.
Definition: StatusCodes.h:414
static constexpr int GeneralWarning
General Warning Occurred.
Definition: StatusCodes.h:319
static constexpr int HootLogTooOld
The given hoot log requires an older version of Phoenix API.
Definition: StatusCodes.h:785
static constexpr int CouldNotErase
Could not erase flash.
Definition: StatusCodes.h:59
static constexpr int HwTimestampOutOfSync
The timestamp reported by CANivore is at least 10ms older than the timestamp reported by the system,...
Definition: StatusCodes.h:628
static constexpr int CouldNotEnterBl
Could not put the device into bootloader mode.
Definition: StatusCodes.h:51
static constexpr int ModelMismatch
Model name in license file does not match model name of selected device.
Definition: StatusCodes.h:657
static constexpr int NoConfigs
This device did not report any available configs.
Definition: StatusCodes.h:149
constexpr bool IsWarning() const
Definition: StatusCodes.h:851
static constexpr int SerialMismatch
Serial Number in license file does not match model name of selected device.
Definition: StatusCodes.h:662
static constexpr int InvalidLicenseResp
InvalidLicenseResp.
Definition: StatusCodes.h:246
static constexpr int ConfigFailed
ConfigFailed.
Definition: StatusCodes.h:153
static constexpr int InvalidCrfBadHeader
InvalidCrfBadHeader.
Definition: StatusCodes.h:206
static constexpr int CouldNotFindDynamicId
CouldNotFindDynamicId.
Definition: StatusCodes.h:234
static constexpr int GainsAreNotSet
GainsAreNotSet.
Definition: StatusCodes.h:458
static constexpr int BufferFailure
BufferFailure.
Definition: StatusCodes.h:404
static constexpr int OnlySupportedInTunerX
This feature requires Tuner X.
Definition: StatusCodes.h:198
static constexpr int InvalidModel
This feature is not supported for this device model.
Definition: StatusCodes.h:178
static constexpr int CannotWriteSerialPort
CannotWriteSerialPort.
Definition: StatusCodes.h:258
static constexpr int InvalidParamValue
An invalid argument was passed into the function/VI, such as a null pointer.
Definition: StatusCodes.h:368
constexpr StatusCode()
Definition: StatusCodes.h:815
static constexpr int DirectoryMissing
Could not find specified directory.
Definition: StatusCodes.h:756
static constexpr int CanMessageStale
CAN message is stale, data is valid but old.
Definition: StatusCodes.h:307
static constexpr int InvalidCrfBadSectHeader
InvalidCrfBadSectHeader.
Definition: StatusCodes.h:222
static constexpr int kSendFailed
kSendFailed
Definition: StatusCodes.h:585
static constexpr int NoSerialControlFrameResp
NoSerialControlFrameResp.
Definition: StatusCodes.h:270
static constexpr int kInvalidRespFormat
kInvalidRespFormat
Definition: StatusCodes.h:593
static constexpr int TalonFXFirmwarePreVBatDetect
Talon FX(Falcon 500) Firmware Too Old.
Definition: StatusCodes.h:499
static constexpr int ControlModeNotValid
The control mode is not valid for this function.
Definition: StatusCodes.h:332
static constexpr int InvalidOrchestraAction
An invalid orchestra action occurred.
Definition: StatusCodes.h:536
static constexpr int InvalidCrfFileSzInvald
InvalidCrfFileSzInvald.
Definition: StatusCodes.h:210
static constexpr int InvalidModeToGetSignal
The current mode of the device is invalid for getting this signal.
Definition: StatusCodes.h:683
static constexpr int InvalidCrfWrongProduct
Specified CRF is for the wrong product.
Definition: StatusCodes.h:214
constexpr bool operator<(StatusCode data) const
Definition: StatusCodes.h:835
static constexpr int kWinUsbQueryFailed
kWinUsbQueryFailed
Definition: StatusCodes.h:601
static constexpr int SelfTestIsEmpty
Self Test report does not have any values, is the firmware up to date?
Definition: StatusCodes.h:674
static constexpr int NoUdpControlFrameResp
NoUdpControlFrameResp.
Definition: StatusCodes.h:290
static constexpr int DeviceDidNotRespondToDiagReq
DeviceDidNotRespondToDiagReq.
Definition: StatusCodes.h:194
static constexpr int EcuIsNotPresent
Device is not present.
Definition: StatusCodes.h:47
static constexpr int InvalidCrfBadSectSize
InvalidCrfBadSectSize.
Definition: StatusCodes.h:226
static constexpr int CannotReadUdpPort
CannotReadUdpPort.
Definition: StatusCodes.h:282
static constexpr int LoggerNotRunning
The signal logger is not running.
Definition: StatusCodes.h:767
static constexpr int kListenFailed
kListenFailed
Definition: StatusCodes.h:581
constexpr StatusCode(int val)
Definition: StatusCodes.h:814
static constexpr int MotProfFirmThreshold
Motor Controller must have >= 3.2 firmware for motion profile control mode.
Definition: StatusCodes.h:342
static constexpr int FeaturesNotAvailableYet
This feature will be supported in a future update.
Definition: StatusCodes.h:328
static constexpr int TxFailed
Could not transmit CAN Frame.
Definition: StatusCodes.h:363
static constexpr int InvalidTask
This diagnostic action is not supported.
Definition: StatusCodes.h:103
static constexpr int FirmwareVersNotCompatible
Firmware version is not compatible with this version of Phoenix.
Definition: StatusCodes.h:752
static constexpr int UserSignalLimitExceeded
The maximum number of loggable user signals has been exceeded.
Definition: StatusCodes.h:808
static constexpr int InvalidLicenseResponse
InvalidLicenseResponse.
Definition: StatusCodes.h:695
static constexpr int CompileSzIsWrong
CompileSzIsWrong.
Definition: StatusCodes.h:95
static constexpr int CustomNameNotSupported
CustomNameNotSupported.
Definition: StatusCodes.h:161
static constexpr int CouldNotDecodeDeviceFirmware
Device firmware could not be decoded.
Definition: StatusCodes.h:723
static constexpr int InvalidCanivCache
InvalidCanivCache.
Definition: StatusCodes.h:250
static constexpr int FirmwareTooNew
Firmware Too New.
Definition: StatusCodes.h:739
static constexpr int kReceiveFailed
kReceiveFailed
Definition: StatusCodes.h:589
static constexpr int MusicInterrupted
Music interrupted due to one of the instruments being commanded a different control mode.
Definition: StatusCodes.h:545
static constexpr int CouldNotRetrieveV6Firmware
Device firmware could not be retrieved.
Definition: StatusCodes.h:717
static constexpr int CannotReadSerialPort
CannotReadSerialPort.
Definition: StatusCodes.h:262
static constexpr int MissingRoutineInLibrary
MissingRoutineInLibrary.
Definition: StatusCodes.h:511
static constexpr int MusicFileNotFound
Could not find music file specified, try specifying an absolute path.
Definition: StatusCodes.h:519
static constexpr int WrongRemoteLimitSwitchSource
Use RemoteLimitSwitchSource instead of LimitSwitchSource.
Definition: StatusCodes.h:462
static constexpr int MoreThanOneFile
MoreThanOneFile.
Definition: StatusCodes.h:115
static constexpr int kWinUsbInitFailed
kWinUsbInitFailed
Definition: StatusCodes.h:597
static constexpr int CouldNotConfirmId
Could not verify that the changed ID took effect.
Definition: StatusCodes.h:79
constexpr bool IsOK() const
Definition: StatusCodes.h:855
static constexpr int CannotSerialToDevice
CannotSerialToDevice.
Definition: StatusCodes.h:266
static constexpr int LibraryCouldNotBeLoaded
LibraryCouldNotBeLoaded.
Definition: StatusCodes.h:507
static constexpr int NoControls
This device does not support new controls.
Definition: StatusCodes.h:186
static constexpr int ConfigMotionSCurveRequiresHigherFirm
Config Motion S Curve Strength features require firmware >=4.16.
Definition: StatusCodes.h:493
static constexpr int MusicNotSupported
This device doesn't support MusicTone control mode.
Definition: StatusCodes.h:549
static constexpr int GadgeteerDeviceNoSetId
Cannot set the ID of a gadgeteer device.
Definition: StatusCodes.h:99
static constexpr int NodeIsInvalid
Specified device was not found.
Definition: StatusCodes.h:120
static constexpr int InvalidSize
Size is invalid.
Definition: StatusCodes.h:691
static constexpr int TimeoutCannotBeZero
Blocking operations, such as configs, cannot have a timeout of 0.
Definition: StatusCodes.h:772
static constexpr int MODULE_NOT_INIT_GET_ERROR
MODULE_NOT_INIT_GET_ERROR.
Definition: StatusCodes.h:442
static constexpr int CouldNotReqFactoryDefault
Unable to factory default this device.
Definition: StatusCodes.h:157
static constexpr int ConfigFactoryDefaultRequiresHigherFirm
Config factory default features require firmware >=3.10.
Definition: StatusCodes.h:489
static constexpr int FirmwareTooOld
Firmware Too Old.
Definition: StatusCodes.h:395
static constexpr int CorruptedPOST
CorruptedPOST.
Definition: StatusCodes.h:144
static constexpr int LicenseDownloadFailed
License did not successfully download to Device.
Definition: StatusCodes.h:670
static constexpr int FeatureNotSupported
This feature is not supported.
Definition: StatusCodes.h:136
static constexpr int kErrorPollingForDevices
kErrorPollingForDevices
Definition: StatusCodes.h:711
static constexpr int NoCrfFile
Specified CRF file could not be found.
Definition: StatusCodes.h:230
static constexpr int UnexpectedArbId
ArbID is incorrect.
Definition: StatusCodes.h:381
static constexpr int GEN_PORT_ERROR
GEN_PORT_ERROR.
Definition: StatusCodes.h:426
static constexpr int CANdleAnimSlotOutOfBounds
CANdleAnimSlotOutOfBounds.
Definition: StatusCodes.h:473
static constexpr int CouldNotSendCanFrame
CouldNotSendCanFrame.
Definition: StatusCodes.h:128
static constexpr int kInvalidClass
kInvalidClass
Definition: StatusCodes.h:561
static constexpr int WheelRadiusTooSmall
Wheel Radius is too small, cannot get distance traveled.
Definition: StatusCodes.h:446
static constexpr int CouldNotSerialize
The data frame could not be serialized for transmit.
Definition: StatusCodes.h:743
static constexpr int InvalidDeviceSpec
InvalidDeviceSpec.
Definition: StatusCodes.h:42
static constexpr int UnlicensedHootLog
Hoot log is not licensed.
Definition: StatusCodes.h:793
static constexpr int NoDevicesOnBus
NoDevicesOnBus.
Definition: StatusCodes.h:111
static constexpr int MechanismFaulted
The mechanism is disabled due to a fault in one of the devices.
Definition: StatusCodes.h:747
static constexpr int ApiTooOld
This API version is too old for the firmware on the device.
Definition: StatusCodes.h:762
static constexpr int DidNotGetDhcp
DidNotGetDhcp.
Definition: StatusCodes.h:238
static constexpr int InvalidDeviceDescriptor
InvalidDeviceDescriptor.
Definition: StatusCodes.h:124
static constexpr int MusicFileTooNew
Music file version is too new, update Phoenix to utilize this file.
Definition: StatusCodes.h:528
static constexpr int UsingProFeatureOnUnlicensedDevice
Using a Pro only feature on an unlicensed device.
Definition: StatusCodes.h:733
constexpr bool IsError() const
Definition: StatusCodes.h:847
static constexpr int kDeviceResponseIncorrect
kDeviceResponseIncorrect
Definition: StatusCodes.h:707
static constexpr int SimDeviceAlreadyExists
SimDeviceAlreadyExists.
Definition: StatusCodes.h:359
static constexpr int TicksPerRevZero
Ticks per revolution is 0, cannot get heading.
Definition: StatusCodes.h:450
constexpr bool operator==(StatusCode data) const
Definition: StatusCodes.h:819
static constexpr int kFailedSetup
kFailedSetup
Definition: StatusCodes.h:577
static constexpr int CannotLicenseWhileEnabled
Device cannot be licensed while it is control enabled.
Definition: StatusCodes.h:777
static constexpr int CouldNotReqSetConfigs
Could not apply the device configs.
Definition: StatusCodes.h:170
static constexpr int InvalidDeviceModel
The provided model was not a valid device type.
Definition: StatusCodes.h:812
static constexpr int CouldNotReqSetId
Unable to set ID to this device.
Definition: StatusCodes.h:75
static constexpr int kInvalidPath
kInvalidPath
Definition: StatusCodes.h:569
static constexpr int TxTimeout
CAN Transmit timed out.
Definition: StatusCodes.h:377
static constexpr int InvalidNetwork
InvalidNetwork.
Definition: StatusCodes.h:632
static constexpr int MissingContext
Could not determine context from this device hash.
Definition: StatusCodes.h:652
static constexpr int DeviceIsNull
DeviceIsNull.
Definition: StatusCodes.h:190
constexpr bool operator<(int data) const
Definition: StatusCodes.h:839
static constexpr int MultiSignalNotSupported
The CAN bus does not support multi-signal synchronization.
Definition: StatusCodes.h:636
static constexpr int SigNotUpdated
No new response to update signal.
Definition: StatusCodes.h:418
static constexpr int TimeoutIso15Response
TimeoutIso15Response.
Definition: StatusCodes.h:294
static constexpr int CannotWriteUdpPort
CannotWriteUdpPort.
Definition: StatusCodes.h:278
static constexpr int ResourceNotAvailable
ResourceNotAvailable.
Definition: StatusCodes.h:515
static constexpr int DistanceBetweenWheelsTooSmall
Distance between wheels is too small, cannot get heading.
Definition: StatusCodes.h:454
static constexpr int RxTimeout
CAN frame not received/too-stale.
Definition: StatusCodes.h:373
static constexpr int NotSupported
This is not supported.
Definition: StatusCodes.h:648
static constexpr int InvalidFile
Could not open or read the given file.
Definition: StatusCodes.h:781
static constexpr int NotFound
Could not find this value when searching for it.
Definition: StatusCodes.h:644
@ OK
The mechanism is running normally.
Represents the state of one swerve module.
Definition: StatusCodes.h:18