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