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