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