`phoenix6.signals.spn_enums`¶

Module Contents¶

class phoenix6.signals.spn_enums.System_StateValue(*args, **kwds)¶

Bases: enum.Enum

System state of the device.

BOOTUP_0 = 0¶

BOOTUP_1 = 1¶

BOOTUP_2 = 2¶

BOOTUP_3 = 3¶

BOOTUP_4 = 4¶

BOOTUP_5 = 5¶

BOOTUP_6 = 6¶

BOOTUP_7 = 7¶

BOOT_BEEP = 8¶

CONTROL_DISABLED = 9¶

CONTROL_ENABLED = 10¶

CONTROL_ENABLED_11 = 11¶

FAULT = 12¶

RECOVER = 13¶

NOT_LICENSED = 14¶

PRODUCTION = 15¶

class phoenix6.signals.spn_enums.IsPROLicensedValue(*args, **kwds)¶

Bases: enum.Enum

Whether the device is Pro licensed.

NOT_LICENSED = 0¶

LICENSED = 1¶

class phoenix6.signals.spn_enums.Licensing_IsSeasonPassedValue(*args, **kwds)¶

Bases: enum.Enum

Whether the device is Season Pass licensed.

NOT_LICENSED = 0¶

LICENSED = 1¶

class phoenix6.signals.spn_enums.SensorDirectionValue(*args, **kwds)¶

Bases: enum.Enum

Direction of the sensor to determine positive rotation, as seen facing the LED side of the CANcoder.

COUNTER_CLOCKWISE_POSITIVE = 0¶: Counter-clockwise motion reports positive rotation.

CLOCKWISE_POSITIVE = 1¶: Clockwise motion reports positive rotation.

class phoenix6.signals.spn_enums.FrcLockValue(*args, **kwds)¶

Bases: enum.Enum

Whether device is locked by FRC.

FRC_LOCKED = 1¶

FRC_UNLOCKED = 0¶

class phoenix6.signals.spn_enums.RobotEnableValue(*args, **kwds)¶

Bases: enum.Enum

Whether the robot is enabled.

ENABLED = 1¶

DISABLED = 0¶

class phoenix6.signals.spn_enums.Led1OnColorValue(*args, **kwds)¶

Bases: enum.Enum

The Color of LED1 when it’s “On”.

OFF = 0¶

RED = 1¶

GREEN = 2¶

ORANGE = 3¶

BLUE = 4¶

PINK = 5¶

CYAN = 6¶

WHITE = 7¶

class phoenix6.signals.spn_enums.Led1OffColorValue(*args, **kwds)¶

Bases: enum.Enum

The Color of LED1 when it’s “Off”.

OFF = 0¶

RED = 1¶

GREEN = 2¶

ORANGE = 3¶

BLUE = 4¶

PINK = 5¶

CYAN = 6¶

WHITE = 7¶

class phoenix6.signals.spn_enums.Led2OnColorValue(*args, **kwds)¶

Bases: enum.Enum

The Color of LED2 when it’s “On”.

OFF = 0¶

RED = 1¶

GREEN = 2¶

ORANGE = 3¶

BLUE = 4¶

PINK = 5¶

CYAN = 6¶

WHITE = 7¶

class phoenix6.signals.spn_enums.Led2OffColorValue(*args, **kwds)¶

Bases: enum.Enum

The Color of LED2 when it’s “Off”.

OFF = 0¶

RED = 1¶

GREEN = 2¶

ORANGE = 3¶

BLUE = 4¶

PINK = 5¶

CYAN = 6¶

WHITE = 7¶

class phoenix6.signals.spn_enums.DeviceEnableValue(*args, **kwds)¶

Bases: enum.Enum

Whether the device is enabled.

ENABLED = 1¶

DISABLED = 0¶

class phoenix6.signals.spn_enums.ForwardLimitValue(*args, **kwds)¶

Bases: enum.Enum

Forward Limit Pin.

CLOSED_TO_GROUND = 0¶

OPEN = 1¶

class phoenix6.signals.spn_enums.ReverseLimitValue(*args, **kwds)¶

Bases: enum.Enum

Reverse Limit Pin.

CLOSED_TO_GROUND = 0¶

OPEN = 1¶

class phoenix6.signals.spn_enums.AppliedRotorPolarityValue(*args, **kwds)¶

Bases: enum.Enum

The applied rotor polarity as seen from the front of the motor. This typically is determined by the Inverted config, but can be overridden if using Follower features.

POSITIVE_IS_COUNTER_CLOCKWISE = 0¶: Positive motor output results in counter-clockwise motion.

POSITIVE_IS_CLOCKWISE = 1¶: Positive motor output results in clockwise motion.

class phoenix6.signals.spn_enums.ControlModeValue(*args, **kwds)¶

Bases: enum.Enum

The active control mode of the motor controller.

DISABLED_OUTPUT = 0¶

NEUTRAL_OUT = 1¶

STATIC_BRAKE = 2¶

DUTY_CYCLE_OUT = 3¶

POSITION_DUTY_CYCLE = 4¶

VELOCITY_DUTY_CYCLE = 5¶

MOTION_MAGIC_DUTY_CYCLE = 6¶

DUTY_CYCLE_FOC = 7¶

POSITION_DUTY_CYCLE_FOC = 8¶

VELOCITY_DUTY_CYCLE_FOC = 9¶

MOTION_MAGIC_DUTY_CYCLE_FOC = 10¶

VOLTAGE_OUT = 11¶

POSITION_VOLTAGE = 12¶

VELOCITY_VOLTAGE = 13¶

MOTION_MAGIC_VOLTAGE = 14¶

VOLTAGE_FOC = 15¶

POSITION_VOLTAGE_FOC = 16¶

VELOCITY_VOLTAGE_FOC = 17¶

MOTION_MAGIC_VOLTAGE_FOC = 18¶

TORQUE_CURRENT_FOC = 19¶

POSITION_TORQUE_CURRENT_FOC = 20¶

VELOCITY_TORQUE_CURRENT_FOC = 21¶

MOTION_MAGIC_TORQUE_CURRENT_FOC = 22¶

FOLLOWER = 23¶

RESERVED = 24¶

COAST_OUT = 25¶

UNAUTHORIZED_DEVICE = 26¶

MUSIC_TONE = 27¶

MOTION_MAGIC_VELOCITY_DUTY_CYCLE = 28¶

MOTION_MAGIC_VELOCITY_DUTY_CYCLE_FOC = 29¶

MOTION_MAGIC_VELOCITY_VOLTAGE = 30¶

MOTION_MAGIC_VELOCITY_VOLTAGE_FOC = 31¶

MOTION_MAGIC_VELOCITY_TORQUE_CURRENT_FOC = 32¶

MOTION_MAGIC_EXPO_DUTY_CYCLE = 33¶

MOTION_MAGIC_EXPO_DUTY_CYCLE_FOC = 34¶

MOTION_MAGIC_EXPO_VOLTAGE = 35¶

MOTION_MAGIC_EXPO_VOLTAGE_FOC = 36¶

MOTION_MAGIC_EXPO_TORQUE_CURRENT_FOC = 37¶

class phoenix6.signals.spn_enums.ExternalMotorTempStatusValue(*args, **kwds)¶

Bases: enum.Enum

Status of the temperature sensor of the external motor.

COLLECTING = 0¶: Talon is collecting information on the sensor.

DISCONNECTED = 1¶: Temperature sensor appears to be disconnected.

TOO_HOT = 2¶: Temperature sensor is too hot to allow motor operation.

NORMAL = 3¶: Temperature sensor is normal.

NOT_USED = 4¶: Temperature sensor is present but is not used. Most likely the motor arrangement is brushed or disabled.

WRONG_MOTOR_OR_SHORTED = 5¶: Temperature sensor appears to be for the wrong motor arrangement, or signals are shorted.

class phoenix6.signals.spn_enums.MotionMagicIsRunningValue(*args, **kwds)¶

Bases: enum.Enum

Check if Motion Magic® is running. This is equivalent to checking that the reported control mode is a Motion Magic® based mode.

ENABLED = 1¶

DISABLED = 0¶

class phoenix6.signals.spn_enums.PIDRefPIDErr_ClosedLoopModeValue(*args, **kwds)¶

Bases: enum.Enum

Whether the closed-loop is running on position or velocity.

POSITION = 0¶

VELOCITY = 1¶

class phoenix6.signals.spn_enums.PIDOutput_PIDOutputModeValue(*args, **kwds)¶

Bases: enum.Enum

The output mode of the PID controller.

DUTY_CYCLE = 0¶

VOLTAGE = 1¶

TORQUE_CURRENT_FOC = 2¶

class phoenix6.signals.spn_enums.PIDRefSlopeECUTime_ClosedLoopModeValue(*args, **kwds)¶

Bases: enum.Enum

Whether the closed-loop is running on position or velocity.

POSITION = 0¶

VELOCITY = 1¶

class phoenix6.signals.spn_enums.MotorOutputStatusValue(*args, **kwds)¶

Bases: enum.Enum

Assess the status of the motor output with respect to load and supply.

This routine can be used to determine the general status of motor commutation.

UNKNOWN = 0¶: The status of motor output could not be determined.

OFF = 1¶: Motor output is disabled.

STATIC_BRAKING = 2¶: The motor is in neutral-brake.

MOTORING = 3¶: The motor is loaded in a typical fashion, drawing current from the supply, and successfully turning the rotor in the direction of applied voltage.

DISCORDANT_MOTORING = 4¶: The same as Motoring, except the rotor is being backdriven as the motor output is not enough to defeat load forces.

REGEN_BRAKING = 5¶: The motor is braking in such a way where motor current is traveling back to the supply (typically a battery).

class phoenix6.signals.spn_enums.DifferentialControlModeValue(*args, **kwds)¶

Bases: enum.Enum

The active control mode of the differential controller.

DISABLED_OUTPUT = 0¶

NEUTRAL_OUT = 1¶

STATIC_BRAKE = 2¶

DUTY_CYCLE_OUT = 3¶

POSITION_DUTY_CYCLE = 4¶

VELOCITY_DUTY_CYCLE = 5¶

MOTION_MAGIC_DUTY_CYCLE = 6¶

DUTY_CYCLE_FOC = 7¶

POSITION_DUTY_CYCLE_FOC = 8¶

VELOCITY_DUTY_CYCLE_FOC = 9¶

MOTION_MAGIC_DUTY_CYCLE_FOC = 10¶

VOLTAGE_OUT = 11¶

POSITION_VOLTAGE = 12¶

VELOCITY_VOLTAGE = 13¶

MOTION_MAGIC_VOLTAGE = 14¶

VOLTAGE_FOC = 15¶

POSITION_VOLTAGE_FOC = 16¶

VELOCITY_VOLTAGE_FOC = 17¶

MOTION_MAGIC_VOLTAGE_FOC = 18¶

TORQUE_CURRENT_FOC = 19¶

POSITION_TORQUE_CURRENT_FOC = 20¶

VELOCITY_TORQUE_CURRENT_FOC = 21¶

MOTION_MAGIC_TORQUE_CURRENT_FOC = 22¶

FOLLOWER = 23¶

RESERVED = 24¶

COAST_OUT = 25¶

class phoenix6.signals.spn_enums.DiffPIDRefPIDErr_ClosedLoopModeValue(*args, **kwds)¶

Bases: enum.Enum

Whether the closed-loop is running on position or velocity.

POSITION = 0¶

VELOCITY = 1¶

class phoenix6.signals.spn_enums.DiffPIDOutput_PIDOutputModeValue(*args, **kwds)¶

Bases: enum.Enum

The output mode of the differential PID controller.

DUTY_CYCLE = 0¶

VOLTAGE = 1¶

TORQUE_CURRENT_FOC = 2¶

class phoenix6.signals.spn_enums.DiffPIDRefSlopeECUTime_ClosedLoopModeValue(*args, **kwds)¶

Bases: enum.Enum

Whether the closed-loop is running on position or velocity.

POSITION = 0¶

VELOCITY = 1¶

class phoenix6.signals.spn_enums.GravityTypeValue(*args, **kwds)¶

Bases: enum.Enum

Gravity Feedforward/Feedback Type.

This determines the type of the gravity feedforward/feedback.

Choose Elevator_Static for systems where the gravity feedforward is constant, such as an elevator. The gravity feedforward output will always have the same sign.

Choose Arm_Cosine for systems where the gravity feedback is dependent on the angular position of the mechanism, such as an arm. The gravity feedback output will vary depending on the mechanism angular position. Note that the sensor offset and ratios must be configured so that the sensor reports a position of 0 when the mechanism is horizonal (parallel to the ground), and the reported sensor position is 1:1 with the mechanism.

ELEVATOR_STATIC = 0¶: The system’s gravity feedforward is constant, such as an elevator. The gravity feedforward output will always have the same sign.

ARM_COSINE = 1¶: The system’s gravity feedback is dependent on the angular position of the mechanism, such as an arm. The gravity feedback output will vary depending on the mechanism angular position. Note that the sensor offset and ratios must be configured so that the sensor reports a position of 0 when the mechanism is horizonal (parallel to the ground), and the reported sensor position is 1:1 with the mechanism.

class phoenix6.signals.spn_enums.InvertedValue(*args, **kwds)¶

Bases: enum.Enum

Invert state of the device as seen from the front of the motor.

COUNTER_CLOCKWISE_POSITIVE = 0¶: Positive motor output results in counter-clockwise motion.

CLOCKWISE_POSITIVE = 1¶: Positive motor output results in clockwise motion.

class phoenix6.signals.spn_enums.NeutralModeValue(*args, **kwds)¶

Bases: enum.Enum

The state of the motor controller bridge when output is neutral or disabled.

COAST = 0¶

BRAKE = 1¶

class phoenix6.signals.spn_enums.FeedbackSensorSourceValue(*args, **kwds)¶

Bases: enum.Enum

Choose what sensor source is reported via API and used by closed-loop and limit features. The default is RotorSensor, which uses the internal rotor sensor in the Talon.

Choose Remote* to use another sensor on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon will update its position and velocity whenever the remote sensor publishes its information on CAN bus, and the Talon internal rotor will not be used.

Choose Fused* (requires Phoenix Pro) and Talon will fuse another sensor’s information with the internal rotor, which provides the best possible position and velocity for accuracy and bandwidth (this also requires setting FeedbackRemoteSensorID). This was developed for applications such as swerve-azimuth.

Choose Sync* (requires Phoenix Pro) and Talon will synchronize its internal rotor position against another sensor, then continue to use the rotor sensor for closed loop control (this also requires setting FeedbackRemoteSensorID). The Talon will report if its internal position differs significantly from the reported remote sensor position. This was developed for mechanisms where there is a risk of the sensor failing in such a way that it reports a position that does not match the mechanism, such as the sensor mounting assembly breaking off.

Choose RemotePigeon2_Yaw, RemotePigeon2_Pitch, and RemotePigeon2_Roll to use another Pigeon2 on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon will update its position to match the selected value whenever Pigeon2 publishes its information on CAN bus. Note that the Talon position will be in rotations and not degrees.

Note: When the feedback source is changed to Fused* or Sync*, the Talon needs a period of time to fuse before sensor-based (soft-limit, closed loop, etc.) features are used. This period of time is determined by the update frequency of the remote sensor’s Position signal.

ROTOR_SENSOR = 0¶: Use the internal rotor sensor in the Talon.

REMOTE_CANCODER = 1¶: Use another CANcoder on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon will update its position and velocity whenever CANcoder publishes its information on CAN bus, and the Talon internal rotor will not be used.

REMOTE_PIGEON2_YAW = 2¶: Use another Pigeon2 on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon will update its position to match the Pigeon2 yaw whenever Pigeon2 publishes its information on CAN bus. Note that the Talon position will be in rotations and not degrees.

REMOTE_PIGEON2_PITCH = 3¶: Use another Pigeon2 on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon will update its position to match the Pigeon2 pitch whenever Pigeon2 publishes its information on CAN bus. Note that the Talon position will be in rotations and not degrees.

REMOTE_PIGEON2_ROLL = 4¶: Use another Pigeon2 on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon will update its position to match the Pigeon2 roll whenever Pigeon2 publishes its information on CAN bus. Note that the Talon position will be in rotations and not degrees.

FUSED_CANCODER = 5¶: Requires Phoenix Pro; Talon will fuse another CANcoder’s information with the internal rotor, which provides the best possible position and velocity for accuracy and bandwidth (this also requires setting FeedbackRemoteSensorID). FusedCANcoder was developed for applications such as swerve-azimuth.

SYNC_CANCODER = 6¶

Requires Phoenix Pro; Talon will synchronize its internal rotor position against another CANcoder, then continue to use the rotor sensor for closed loop control (this also requires setting FeedbackRemoteSensorID). The Talon will report if its internal position differs significantly from the reported CANcoder position.

SyncCANcoder was developed for mechanisms where there is a risk of the CANcoder

failing in such a way that it reports a position that does not match the mechanism, such as the sensor mounting assembly breaking off.

REMOTE_CANDI_PWM1 = 9¶: Use a pulse-width encoder remotely attached to the Sensor Input 1 (S1IN) on the CTR Electronics’ CANdi™. Talon will update its position and velocity whenever the CTR Electronics’ CANdi™ publishes its information on CAN bus, and the Talon internal rotor will not be used.

REMOTE_CANDI_PWM2 = 10¶: Use a pulse-width encoder remotely attached to the Sensor Input 2 (S2IN) on the CTR Electronics’ CANdi™. Talon will update its position and velocity whenever the CTR Electronics’ CANdi™ publishes its information on CAN bus, and the Talon internal rotor will not be used.

REMOTE_CANDI_QUADRATURE = 11¶: Use a quadrature encoder remotely attached to the two Sensor Inputs on the CTR Electronics’ CANdi™. Talon will update its position and velocity whenever the CTR Electronics’ CANdi™ publishes its information on CAN bus, and the Talon internal rotor will not be used.

FUSED_CANDI_PWM1 = 12¶: Requires Phoenix Pro; Talon will fuse a pulse-width encoder remotely attached to the Sensor Input 1 (S1IN) on the CTR Electronics’ CANdi™, which provides the best possible position and velocity for accuracy and bandwidth (this also requires setting FeedbackRemoteSensorID). FusedCANdi was developed for applications such as swerve-azimuth.

FUSED_CANDI_PWM2 = 13¶: Requires Phoenix Pro; Talon will fuse a pulse-width encoder remotely attached to the Sensor Input 2 (S2IN) on the CTR Electronics’ CANdi™, which provides the best possible position and velocity for accuracy and bandwidth (this also requires setting FeedbackRemoteSensorID). FusedCANdi was developed for applications such as swerve-azimuth.

FUSED_CANDI_QUADRATURE = 14¶: Requires Phoenix Pro; Talon will fuse a qaudrature encoder remotely attached to the two Sensor Inputs on the CTR Electronics’ CANdi™. This provides velocity and relative position measurements. This also requires setting FeedbackRemoteSensorID.

SYNC_CANDI_PWM1 = 15¶: Requires Phoenix Pro; Talon will synchronize its internal rotor position against the pulse-width encoder attached to Sensor Input 1 (S1IN), then continue to use the rotor sensor for closed loop control (this also requires setting FeedbackRemoteSensorID). The Talon will report if its internal position differs significantly from the reported PWM position. SyncCANdi was developed for mechanisms where there is a risk of the CTR Electronics’ CANdi™ failing in such a way that it reports a position that does not match the mechanism, such as the sensor mounting assembly breaking off.

SYNC_CANDI_PWM2 = 16¶: Requires Phoenix Pro; Talon will synchronize its internal rotor position against the pulse-width encoder attached to Sensor Input 1 (S1IN), then continue to use the rotor sensor for closed loop control (this also requires setting FeedbackRemoteSensorID). The Talon will report if its internal position differs significantly from the reported PWM position. SyncCANdi was developed for mechanisms where there is a risk of the CTR Electronics’ CANdi™ failing in such a way that it reports a position that does not match the mechanism, such as the sensor mounting assembly breaking off.

class phoenix6.signals.spn_enums.ForwardLimitTypeValue(*args, **kwds)¶

Bases: enum.Enum

Determines if the forward limit switch is normally-open (default) or normally-closed.

NORMALLY_OPEN = 0¶

NORMALLY_CLOSED = 1¶

class phoenix6.signals.spn_enums.ForwardLimitSourceValue(*args, **kwds)¶

Bases: enum.Enum

Determines where to poll the forward limit switch. This defaults to the forward limit switch pin on the limit switch connector.

Choose RemoteTalonFX to use the forward limit switch attached to another Talon FX on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID).

Choose RemoteCANifier to use the forward limit switch attached to another CANifier on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID).

Choose RemoteCANcoder to use another CANcoder on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID). The forward limit will assert when the CANcoder magnet strength changes from BAD (red) to ADEQUATE (orange) or GOOD (green).

LIMIT_SWITCH_PIN = 0¶: Use the forward limit switch pin on the limit switch connector.

REMOTE_TALON_FX = 1¶: Use the forward limit switch attached to another Talon FX on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID).

REMOTE_CANIFIER = 2¶: Use the forward limit switch attached to another CANifier on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID).

REMOTE_CANCODER = 4¶: Use another CANcoder on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID). The forward limit will assert when the CANcoder magnet strength changes from BAD (red) to ADEQUATE (orange) or GOOD (green).

REMOTE_CANRANGE = 6¶: Use another CANrange on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID). The forward limit will assert when the CANrange proximity detect is tripped.

REMOTE_CANDI_S1 = 7¶: Use another CTR Electronics’ CANdi™ on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID). The forward limit will assert when the CTR Electronics’ CANdi™ Signal 1 Input (S1IN) pin matches the configured closed state.

REMOTE_CANDI_S2 = 8¶: Use another CTR Electronics’ CANdi™ on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID). The forward limit will assert when the CTR Electronics’ CANdi™ Signal 2 Input (S2IN) pin matches the configured closed state.

DISABLED = 3¶: Disable the forward limit switch.

class phoenix6.signals.spn_enums.ReverseLimitTypeValue(*args, **kwds)¶

Bases: enum.Enum

Determines if the reverse limit switch is normally-open (default) or normally-closed.

NORMALLY_OPEN = 0¶

NORMALLY_CLOSED = 1¶

class phoenix6.signals.spn_enums.ReverseLimitSourceValue(*args, **kwds)¶

Bases: enum.Enum

Determines where to poll the reverse limit switch. This defaults to the reverse limit switch pin on the limit switch connector.

Choose RemoteTalonFX to use the reverse limit switch attached to another Talon FX on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

Choose RemoteCANifier to use the reverse limit switch attached to another CANifier on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

Choose RemoteCANcoder to use another CANcoder on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID). The reverse limit will assert when the CANcoder magnet strength changes from BAD (red) to ADEQUATE (orange) or GOOD (green).

LIMIT_SWITCH_PIN = 0¶: Use the reverse limit switch pin on the limit switch connector.

REMOTE_TALON_FX = 1¶: Use the reverse limit switch attached to another Talon FX on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

REMOTE_CANIFIER = 2¶: Use the reverse limit switch attached to another CANifier on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

REMOTE_CANCODER = 4¶: Use another CANcoder on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID). The reverse limit will assert when the CANcoder magnet strength changes from BAD (red) to ADEQUATE (orange) or GOOD (green).

REMOTE_CANRANGE = 6¶: Use another CANrange on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID). The reverse limit will assert when the CANrange proximity detect is tripped.

REMOTE_CANDI_S1 = 7¶: Use another CTR Electronics’ CANdi™ on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID). The forward limit will assert when the CTR Electronics’ CANdi™ Signal 1 Input (S1IN) pin matches the configured closed state.

REMOTE_CANDI_S2 = 8¶: Use another CTR Electronics’ CANdi™ on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID). The forward limit will assert when CANdi™ Signal 2 Input (S2IN) pin matches the configured closed state.

DISABLED = 3¶: Disable the reverse limit switch.

class phoenix6.signals.spn_enums.MagnetHealthValue(*args, **kwds)¶

Bases: enum.Enum

Magnet health as measured by CANcoder.

Red indicates too close or too far, Orange is adequate but with reduced accuracy, green is ideal. Invalid means the accuracy cannot be determined.

MAGNET_RED = 1¶: The magnet is too close or too far from the CANcoder.

MAGNET_ORANGE = 2¶: Magnet health is adequate but with reduced accuracy.

MAGNET_GREEN = 3¶: Magnet health is ideal.

MAGNET_INVALID = 0¶: The accuracy cannot be determined.

class phoenix6.signals.spn_enums.BridgeOutputValue(*args, **kwds)¶

Bases: enum.Enum

The applied output of the bridge.

BRIDGE_REQ_COAST = 0¶

BRIDGE_REQ_BRAKE = 1¶

BRIDGE_REQ_TRAPEZ = 6¶

BRIDGE_REQ_FOC_TORQUE = 7¶

BRIDGE_REQ_MUSIC_TONE = 8¶

BRIDGE_REQ_FOC_EASY = 9¶

BRIDGE_REQ_FAULT_BRAKE = 12¶

BRIDGE_REQ_FAULT_COAST = 13¶

BRIDGE_REQ_ACTIVE_BRAKE = 14¶

BRIDGE_REQ_VARIABLE_BRAKE = 15¶

class phoenix6.signals.spn_enums.DifferentialSensorSourceValue(*args, **kwds)¶

Bases: enum.Enum

Choose what sensor source is used for differential control of a mechanism. The default is Disabled. All other options require setting the DifferentialTalonFXSensorID, as the average of this Talon FX’s sensor and the remote TalonFX’s sensor is used for the differential controller’s primary targets.

Choose RemoteTalonFX_Diff to use another TalonFX on the same CAN bus. Talon FX will update its differential position and velocity whenever the remote TalonFX publishes its information on CAN bus. The differential controller will use the difference between this TalonFX’s sensor and the remote Talon FX’s sensor for the differential component of the output.

Choose RemotePigeon2_Yaw, RemotePigeon2_Pitch, and RemotePigeon2_Roll to use another Pigeon2 on the same CAN bus (this also requires setting DifferentialRemoteSensorID). Talon FX will update its differential position to match the selected value whenever Pigeon2 publishes its information on CAN bus. Note that the Talon FX differential position will be in rotations and not degrees.

Choose RemoteCANcoder to use another CANcoder on the same CAN bus (this also requires setting DifferentialRemoteSensorID). Talon FX will update its differential position and velocity to match the CANcoder whenever CANcoder publishes its information on CAN bus.

DISABLED = 0¶: Disable differential control.

REMOTE_TALON_FX_DIFF = 1¶: Use another TalonFX on the same CAN bus. Talon FX will update its differential position and velocity whenever the remote TalonFX publishes its information on CAN bus. The differential controller will use the difference between this TalonFX’s sensor and the remote Talon FX’s sensor for the differential component of the output.

REMOTE_PIGEON2_YAW = 2¶: Use another Pigeon2 on the same CAN bus (this also requires setting DifferentialRemoteSensorID). Talon FX will update its differential position to match the Pigeon2 yaw whenever Pigeon2 publishes its information on CAN bus. Note that the Talon FX differential position will be in rotations and not degrees.

REMOTE_PIGEON2_PITCH = 3¶: Use another Pigeon2 on the same CAN bus (this also requires setting DifferentialRemoteSensorID). Talon FX will update its differential position to match the Pigeon2 pitch whenever Pigeon2 publishes its information on CAN bus. Note that the Talon FX differential position will be in rotations and not degrees.

REMOTE_PIGEON2_ROLL = 4¶: Use another Pigeon2 on the same CAN bus (this also requires setting DifferentialRemoteSensorID). Talon FX will update its differential position to match the Pigeon2 roll whenever Pigeon2 publishes its information on CAN bus. Note that the Talon FX differential position will be in rotations and not degrees.

REMOTE_CANCODER = 5¶: Use another CANcoder on the same CAN bus (this also requires setting DifferentialRemoteSensorID). Talon FX will update its differential position and velocity to match the CANcoder whenever CANcoder publishes its information on CAN bus.

class phoenix6.signals.spn_enums.StaticFeedforwardSignValue(*args, **kwds)¶

Bases: enum.Enum

Static Feedforward Sign during position closed loop.

This determines the sign of the applied kS during position closed-loop modes. The default behavior uses the velocity reference sign. This works well with velocity closed loop, Motion Magic® controls, and position closed loop when velocity reference is specified (motion profiling).

However, when using position closed loop with zero velocity reference (no motion profiling), the application may want to apply static feedforward based on the sign of closed loop error instead. When doing so, we recommend using the minimal amount of kS, otherwise the motor output may dither when closed loop error is near zero.

USE_VELOCITY_SIGN = 0¶: Use the velocity reference sign. This works well with velocity closed loop, Motion Magic® controls, and position closed loop when velocity reference is specified (motion profiling).

USE_CLOSED_LOOP_SIGN = 1¶: Use the sign of closed loop error. This is useful when using position closed loop with zero velocity reference (no motion profiling). We recommend the minimal amount of kS, otherwise the motor output may dither when closed loop error is near zero.

class phoenix6.signals.spn_enums.ConnectedMotorValue(*args, **kwds)¶

Bases: enum.Enum

The type of motor attached to the Talon.

This can be used to determine what motor is attached to the Talon FX. Return will be “Unknown” if firmware is too old or device is not present.

UNKNOWN = 0¶: Talon could not determine the type of motor attached.

FALCON500_INTEGRATED = 1¶: Talon is attached to an integrated Falcon motor.

KRAKEN_X60_INTEGRATED = 2¶: Talon is attached to an integrated Kraken X60 motor.

KRAKEN_X44_INTEGRATED = 3¶: Talon is attached to an integrated Kraken X44 motor.

MINION_JST = 4¶: Talon is connected to a CTR Electronics Minion® brushless three phase motor.

BRUSHED_AB = 5¶: Talon is connected to a third party brushed DC motor with leads A and B.

BRUSHED_AC = 6¶: Talon is connected to a third party brushed DC motor with leads A and C.

BRUSHED_BC = 7¶: Talon is connected to a third party brushed DC motor with leads B and C.

NEO_JST = 8¶: Talon is connected to a third party NEO brushless three phase motor.

NEO550_JST = 9¶: Talon is connected to a third party NEO550 brushless three phase motor.

VORTEX_JST = 10¶: Talon is connected to a third party VORTEX brushless three phase motor.

class phoenix6.signals.spn_enums.MeasurementHealthValue(*args, **kwds)¶

Bases: enum.Enum

Health of the distance measurement.

GOOD = 0¶: Measurement is good.

LIMITED = 1¶: Measurement is likely okay, but the target is either very far away or moving very quickly.

BAD = 2¶: Measurement is compromised.

class phoenix6.signals.spn_enums.UpdateModeValue(*args, **kwds)¶

Bases: enum.Enum

Update mode of the CANrange. The CANrange supports short-range and long-range detection at various update frequencies.

SHORT_RANGE100_HZ = 0¶: Updates distance/proximity at 100hz using short-range detection mode.

SHORT_RANGE_USER_FREQ = 1¶: Uses short-range detection mode for improved detection under high ambient infrared light conditions. Uses user-specified update frequency.

LONG_RANGE_USER_FREQ = 2¶: Uses long-range detection mode and user-specified update frequency.

class phoenix6.signals.spn_enums.AdvancedHallSupportValue(*args, **kwds)¶

Bases: enum.Enum

Requires Phoenix Pro; Improves commutation and velocity measurement for motors with hall sensors. Talon can use advanced features to improve commutation and velocity measurement when using a motor with hall sensors. This can improve peak efficiency by as high as 2% and reduce noise in the measured velocity.

DISABLED = 0¶: Talon will utilize hall sensors without advanced features.

ENABLED = 1¶: Requires Phoenix Pro; Talon uses advanced features to improve commutation and velocity measurement when using hall sensors. This can improve peak efficiency by as high as 2% and reduce noise in the measured velocity.

class phoenix6.signals.spn_enums.MotorArrangementValue(*args, **kwds)¶

Bases: enum.Enum

Selects the motor and motor connections used with Talon.

This setting determines what kind of motor and sensors are used with the Talon. This also determines what signals are used on the JST and Gadgeteer port.

Motor drive will not function correctly if this setting does not match the physical setup.

DISABLED = 0¶: Motor is not selected. This is the default setting to ensure the user has an opportunity to select the correct motor arrangement before attempting to drive motor.

MINION_JST = 1¶: CTR Electronics Minion® brushless three phase motor. Motor leads: red(terminal A), black (terminal B), and white (terminal C). JST Connector: hall [A, B, C] is on pins [4, 3, 2] and temperature is on pin [5]. Motor JST cable can be plugged directly into the JST connector. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

BRUSHED_DC = 2¶: Third party brushed DC motor with two leads. Use the Brushed Motor Wiring config to determine which leads to use on the Talon (motor leads may be flipped to correct for clockwise vs counterclockwise). Note that the invert configuration can still be used to invert rotor orientation. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

NEO_JST = 5¶: Third party NEO brushless three phase motor (~6000 RPM at 12V). Motor leads: red(terminal A), black (terminal B), and white (terminal C). JST Connector: hall [A, B, C] is on pins [4, 3, 2] and temperature is on pin [5]. Motor JST cable can be plugged directly into the JST connector. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

NEO550_JST = 6¶: Third party NEO550 brushless three phase motor (~11000 RPM at 12V). Motor leads: red(terminal A), black (terminal B), and white (terminal C). JST Connector: hall [A, B, C] is on pins [4, 3, 2] and temperature is on pin [5]. Motor JST cable can be plugged directly into the JST connector. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

VORTEX_JST = 7¶: Third party VORTEX brushless three phase motor. Motor leads: red(terminal A), black (terminal B), and white (terminal C). JST Connector: hall [A, B, C] is on pins [4, 3, 2] and temperature is on pin [5]. Motor JST cable can be plugged directly into the JST connector. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

class phoenix6.signals.spn_enums.S1StateValue(*args, **kwds)¶

Bases: enum.Enum

State of the Signal 1 input (S1IN).

FLOATING = 0¶: Input is not driven high or low, it is disconnected from load.

LOW = 1¶: Input is driven low (below 0.5V).

HIGH = 2¶: Input is driven high (above 3V).

class phoenix6.signals.spn_enums.S2StateValue(*args, **kwds)¶

Bases: enum.Enum

State of the Signal 2 input (S2IN).

FLOATING = 0¶: Input is not driven high or low, it is disconnected from load.

LOW = 1¶: Input is driven low (below 0.5V).

HIGH = 2¶: Input is driven high (above 3V).

class phoenix6.signals.spn_enums.S1FloatStateValue(*args, **kwds)¶

Bases: enum.Enum

The floating state of the Signal 1 input (S1IN).

FLOAT_DETECT = 0¶: The input will attempt to detect when it is floating. This is enabled by default.

PULL_HIGH = 1¶: The input will be pulled high when not loaded by an outside device. This is useful for NPN-style devices.

PULL_LOW = 2¶: The input will be pulled low when not loaded by an outside device. This is useful for PNP-style devices.

BUS_KEEPER = 3¶: The input will pull in the direction of the last measured state. This may be useful for devices that can enter into a high-Z tri-state.

class phoenix6.signals.spn_enums.S2FloatStateValue(*args, **kwds)¶

Bases: enum.Enum

The floating state of the Signal 2 input (S2IN).

FLOAT_DETECT = 0¶: The input will attempt to detect when it is floating. This is enabled by default.

PULL_HIGH = 1¶: The input will be pulled high when not loaded by an outside device. This is useful for NPN-style devices.

PULL_LOW = 2¶: The input will be pulled low when not loaded by an outside device. This is useful for PNP-style devices.

BUS_KEEPER = 3¶: The input will pull in the direction of the last measured state. This may be useful for devices that can enter into a high-Z tri-state.

class phoenix6.signals.spn_enums.ExternalFeedbackSensorSourceValue(*args, **kwds)¶

Bases: enum.Enum

Choose what sensor source is reported via API and used by closed-loop and limit features. The default is Commutation, which uses the external sensor used for motor commutation.

Choose Fused* (requires Phoenix Pro) and Talon will fuse another sensor’s information with the commutation sensor, which provides the best possible position and velocity for accuracy and bandwidth (this also requires setting FeedbackRemoteSensorID). This was developed for applications such as swerve-azimuth.

Choose Sync* (requires Phoenix Pro) and Talon will synchronize its commutation sensor position against another sensor, then continue to use the rotor sensor for closed loop control (this also requires setting FeedbackRemoteSensorID). The Talon will report if its internal position differs significantly from the reported remote sensor position. This was developed for mechanisms where there is a risk of the sensor failing in such a way that it reports a position that does not match the mechanism, such as the sensor mounting assembly breaking off.

Choose Quadrature to use a quadrature encoder directly attached to the Talon data port. This provides velocity and relative position measurements.

Choose PulseWidth to use a pulse-width encoder directly attached to the Talon data port. This provides velocity and absolute position measurements.

COMMUTATION = 0¶: Use the external sensor used for motor commutation.

REMOTE_CANCODER = 1¶: Use another CANcoder on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon will update its position and velocity whenever CANcoder publishes its information on CAN bus, and the Talon commutation sensor will not be used.

REMOTE_PIGEON2_YAW = 2¶: Use another Pigeon2 on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon will update its position to match the Pigeon2 yaw whenever Pigeon2 publishes its information on CAN bus. Note that the Talon position will be in rotations and not degrees.

REMOTE_PIGEON2_PITCH = 3¶: Use another Pigeon2 on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon will update its position to match the Pigeon2 pitch whenever Pigeon2 publishes its information on CAN bus. Note that the Talon position will be in rotations and not degrees.

REMOTE_PIGEON2_ROLL = 4¶: Use another Pigeon2 on the same CAN bus (this also requires setting FeedbackRemoteSensorID). Talon will update its position to match the Pigeon2 roll whenever Pigeon2 publishes its information on CAN bus. Note that the Talon position will be in rotations and not degrees.

FUSED_CANCODER = 5¶: Requires Phoenix Pro; Talon will fuse another CANcoder’s information with the commutation sensor, which provides the best possible position and velocity for accuracy and bandwidth (this also requires setting FeedbackRemoteSensorID). FusedCANcoder was developed for applications such as swerve-azimuth.

SYNC_CANCODER = 6¶: Requires Phoenix Pro; Talon will synchronize its commutation sensor position against another CANcoder, then continue to use the rotor sensor for closed loop control (this also requires setting FeedbackRemoteSensorID). The Talon will report if its internal position differs significantly from the reported CANcoder position. SyncCANcoder was developed for mechanisms where there is a risk of the CANcoder failing in such a way that it reports a position that does not match the mechanism, such as the sensor mounting assembly breaking off.

QUADRATURE = 7¶: Use a quadrature encoder directly attached to the Talon data port. This provides velocity and relative position measurements.

PULSE_WIDTH = 8¶: Use a pulse-width encoder directly attached to the Talon data port. This provides velocity and absolute position measurements.

REMOTE_CANDI_PWM1 = 9¶: Use a pulse-width encoder remotely attached to the Sensor Input 1 (S1IN) on CANdi™. Talon will update its position and velocity whenever CANdi™ publishes its information on CAN bus, and the Talon internal rotor will not be used.

REMOTE_CANDI_PWM2 = 10¶: Use a pulse-width encoder remotely attached to the Sensor Input 2 (S2IN) on CANdi™. Talon will update its position and velocity whenever CANdi™ publishes its information on CAN bus, and the Talon internal rotor will not be used.

REMOTE_CANDI_QUADRATURE = 11¶: Use a quadrature encoder remotely attached to the two Sensor Inputs on CANdi™. Talon will update its position and velocity whenever CANdi™ publishes its information on CAN bus, and the Talon internal rotor will not be used.

FUSED_CANDI_PWM1 = 12¶: Requires Phoenix Pro; Talon will fuse a pulse-width encoder remotely attached to the Sensor Input 1 (S1IN) on CANdi™, which provides the best possible position and velocity for accuracy and bandwidth (this also requires setting FeedbackRemoteSensorID). FusedCANdi was developed for applications such as swerve-azimuth.

FUSED_CANDI_PWM2 = 13¶: Requires Phoenix Pro; Talon will fuse a pulse-width encoder remotely attached to the Sensor Input 2 (S2IN) on CANdi™, which provides the best possible position and velocity for accuracy and bandwidth (this also requires setting FeedbackRemoteSensorID). FusedCANdi was developed for applications such as swerve-azimuth.

FUSED_CANDI_QUADRATURE = 14¶: Requires Phoenix Pro; Talon will fuse a qaudrature encoder remotely attached to the two Sensor Inputs on CANdi™. This provides velocity and relative position measurements. This also requires setting FeedbackRemoteSensorID.

SYNC_CANDI_PWM1 = 15¶: Requires Phoenix Pro; Talon will synchronize its internal rotor position against the pulse-width encoder attached to Sensor Input 1 (S1IN), then continue to use the rotor sensor for closed loop control (this also requires setting FeedbackRemoteSensorID). The Talon will report if its internal position differs significantly from the reported PWM position. SyncCANdi was developed for mechanisms where there is a risk of the CTR Electronics’ CANdi™ failing in such a way that it reports a position that does not match the mechanism, such as the sensor mounting assembly breaking off.

SYNC_CANDI_PWM2 = 16¶: Requires Phoenix Pro; Talon will synchronize its internal rotor position against the pulse-width encoder attached to Sensor Input 1 (S1IN), then continue to use the rotor sensor for closed loop control (this also requires setting FeedbackRemoteSensorID). The Talon will report if its internal position differs significantly from the reported PWM position. SyncCANdi was developed for mechanisms where there is a risk of the CTR Electronics’ CANdi™ failing in such a way that it reports a position that does not match the mechanism, such as the sensor mounting assembly breaking off.

class phoenix6.signals.spn_enums.SensorPhaseValue(*args, **kwds)¶

Bases: enum.Enum

The relationship between the motor controlled by a Talon and the external sensor connected to the data port. This does not affect the commutation sensor or remote sensors.

To determine the sensor phase, set this config to Aligned and drive the motor with positive output. If the reported sensor velocity is positive, then the phase is Aligned. If the reported sensor velocity is negative, then the phase is Opposed.

The sensor direction is automatically inverted along with motor invert, so the sensor phase does not need to be changed when motor invert changes.

ALIGNED = 0¶: The sensor direction is normally aligned with the motor.

OPPOSED = 1¶: The sensor direction is normally opposed to the motor.

class phoenix6.signals.spn_enums.S1CloseStateValue(*args, **kwds)¶

Bases: enum.Enum

What value the Signal 1 input (S1IN) needs to be for the CTR Electronics’ CANdi™ to detect as Closed.

Devices using the S1 input as a remote limit switch will treat the switch as closed when the S1 input is this state.

CLOSE_WHEN_NOT_FLOATING = 0¶: The S1 input will be treated as closed when it is not floating.

CLOSE_WHEN_FLOATING = 1¶: The S1 input will be treated as closed when it is floating.

CLOSE_WHEN_NOT_HIGH = 2¶: The S1 input will be treated as closed when it is not High.

CLOSE_WHEN_HIGH = 3¶: The S1 input will be treated as closed when it is High.

CLOSE_WHEN_NOT_LOW = 4¶: The S1 input will be treated as closed when it is not Low.

CLOSE_WHEN_LOW = 5¶: The S1 input will be treated as closed when it is Low.

class phoenix6.signals.spn_enums.S2CloseStateValue(*args, **kwds)¶

Bases: enum.Enum

What value the Signal 2 input (S2IN) needs to be for the CTR Electronics’ CANdi™ to detect as Closed.

Devices using the S2 input as a remote limit switch will treat the switch as closed when the S2 input is this state.

CLOSE_WHEN_NOT_FLOATING = 0¶: The S2 input will be treated as closed when it is not floating.

CLOSE_WHEN_FLOATING = 1¶: The S2 input will be treated as closed when it is floating.

CLOSE_WHEN_NOT_HIGH = 2¶: The S2 input will be treated as closed when it is not High.

CLOSE_WHEN_HIGH = 3¶: The S2 input will be treated as closed when it is High.

CLOSE_WHEN_NOT_LOW = 4¶: The S2 input will be treated as closed when it is not Low.

CLOSE_WHEN_LOW = 5¶: The S2 input will be treated as closed when it is Low.

class phoenix6.signals.spn_enums.BrushedMotorWiringValue(*args, **kwds)¶

Bases: enum.Enum

If a brushed motor is selected with Motor Arrangement, this config determines which of three leads to use.

LEADS_A_AND_B = 0¶: Third party brushed DC motor with two leads. Motor leads: Use terminal A for the motor red lead and terminal B for the motor black lead (motor leads may be flipped to correct for clockwise vs counterclockwise). Note that the invert configuration can still be used to invert rotor orientation. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

LEADS_A_AND_C = 1¶: Third party brushed DC motor with two leads. Motor leads: Use terminal A for the motor red lead and terminal C for the motor black lead (motor leads may be flipped to correct for clockwise vs counterclockwise). Note that the invert configuration can still be used to reverse rotor orientation. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

LEADS_B_AND_C = 2¶: Third party brushed DC motor with two leads. Motor leads: Use terminal B for the motor red lead and terminal C for the motor black lead (motor leads may be flipped to correct for clockwise vs counterclockwise). Note that the invert configuration can still be used to reverse rotor orientation. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

class phoenix6.signals.spn_enums.StripTypeValue(*args, **kwds)¶

Bases: enum.Enum

The type of LEDs that are being controlled.

GRB = 0¶: LEDs that are controlled by Green-Red-Blue values.

RGB = 1¶: LEDs that are controlled by Red-Green-Blue values.

BRG = 2¶: LEDs that are controlled by Blue-Red-Green values.

GRBW = 6¶: LEDs that are controlled by Green-Red-Blue-White values.

RGBW = 7¶: LEDs that are controlled by Red-Green-Blue-White values.

BRGW = 8¶: LEDs that are controlled by Blue-Red-Green-White values.

class phoenix6.signals.spn_enums.LossOfSignalBehaviorValue(*args, **kwds)¶

Bases: enum.Enum

The behavior of the LEDs when the control signal is lost.

KEEP_RUNNING = 0¶: LEDs remain enabled, and animations continue to run.

DISABLE_LEDS = 1¶: LEDs and animations are disabled after the control signal is lost.

class phoenix6.signals.spn_enums.Enable5VRailValue(*args, **kwds)¶

Bases: enum.Enum

Whether the 5V rail is enabled. Disabling the 5V rail will also turn off the onboard LEDs.

ENABLED = 0¶: The 5V rail is enabled, allowing for LED control.

DISABLED = 1¶: The 5V rail is disabled. This will also turn off the onboard LEDs.

class phoenix6.signals.spn_enums.VBatOutputModeValue(*args, **kwds)¶

Bases: enum.Enum

The behavior of the VBat output. CANdle supports modulating VBat output for single-color LED strips.

ON = 0¶: VBat output is on at full power.

OFF = 1¶: VBat output is off.

MODULATED = 2¶: VBat output is on at the specified modulation.

class phoenix6.signals.spn_enums.StatusLedWhenActiveValue(*args, **kwds)¶

Bases: enum.Enum

Whether the Status LED is enabled when the CANdle is actively being controlled.

ENABLED = 0¶: The status LED is enabled during control.

DISABLED = 1¶: The status LED is disabled during control.

class phoenix6.signals.spn_enums.Animation0TypeValue(*args, **kwds)¶

Bases: enum.Enum

The type of animation running in slot 0 of the CANdle.

EMPTY = 0¶: No animation.

COLOR_FLOW = 1¶: Color flow animation.

FIRE = 2¶: Fire animation.

LARSON = 3¶: Larson animation.

RAINBOW = 4¶: Rainbow animation.

RGB_FADE = 5¶: RGB Fade animation.

SINGLE_FADE = 6¶: Single fade animation.

STROBE = 7¶: Strobe animation.

TWINKLE = 8¶: Twinkle animation.

TWINKLE_OFF = 9¶: Twinkle off animation.

class phoenix6.signals.spn_enums.Animation1TypeValue(*args, **kwds)¶

Bases: enum.Enum

The type of animation running in slot 1 of the CANdle.

EMPTY = 0¶: No animation.

COLOR_FLOW = 1¶: Color flow animation.

FIRE = 2¶: Fire animation.

LARSON = 3¶: Larson animation.

RAINBOW = 4¶: Rainbow animation.

RGB_FADE = 5¶: RGB Fade animation.

SINGLE_FADE = 6¶: Single fade animation.

STROBE = 7¶: Strobe animation.

TWINKLE = 8¶: Twinkle animation.

TWINKLE_OFF = 9¶: Twinkle off animation.

class phoenix6.signals.spn_enums.Animation2TypeValue(*args, **kwds)¶

Bases: enum.Enum

The type of animation running in slot 2 of the CANdle.

EMPTY = 0¶: No animation.

COLOR_FLOW = 1¶: Color flow animation.

FIRE = 2¶: Fire animation.

LARSON = 3¶: Larson animation.

RAINBOW = 4¶: Rainbow animation.

RGB_FADE = 5¶: RGB Fade animation.

SINGLE_FADE = 6¶: Single fade animation.

STROBE = 7¶: Strobe animation.

TWINKLE = 8¶: Twinkle animation.

TWINKLE_OFF = 9¶: Twinkle off animation.

class phoenix6.signals.spn_enums.Animation3TypeValue(*args, **kwds)¶

Bases: enum.Enum

The type of animation running in slot 3 of the CANdle.

EMPTY = 0¶: No animation.

COLOR_FLOW = 1¶: Color flow animation.

FIRE = 2¶: Fire animation.

LARSON = 3¶: Larson animation.

RAINBOW = 4¶: Rainbow animation.

RGB_FADE = 5¶: RGB Fade animation.

SINGLE_FADE = 6¶: Single fade animation.

STROBE = 7¶: Strobe animation.

TWINKLE = 8¶: Twinkle animation.

TWINKLE_OFF = 9¶: Twinkle off animation.

class phoenix6.signals.spn_enums.Animation4TypeValue(*args, **kwds)¶

Bases: enum.Enum

The type of animation running in slot 4 of the CANdle.

EMPTY = 0¶: No animation.

COLOR_FLOW = 1¶: Color flow animation.

FIRE = 2¶: Fire animation.

LARSON = 3¶: Larson animation.

RAINBOW = 4¶: Rainbow animation.

RGB_FADE = 5¶: RGB Fade animation.

SINGLE_FADE = 6¶: Single fade animation.

STROBE = 7¶: Strobe animation.

TWINKLE = 8¶: Twinkle animation.

TWINKLE_OFF = 9¶: Twinkle off animation.

class phoenix6.signals.spn_enums.Animation5TypeValue(*args, **kwds)¶

Bases: enum.Enum

The type of animation running in slot 5 of the CANdle.

EMPTY = 0¶: No animation.

COLOR_FLOW = 1¶: Color flow animation.

FIRE = 2¶: Fire animation.

LARSON = 3¶: Larson animation.

RAINBOW = 4¶: Rainbow animation.

RGB_FADE = 5¶: RGB Fade animation.

SINGLE_FADE = 6¶: Single fade animation.

STROBE = 7¶: Strobe animation.

TWINKLE = 8¶: Twinkle animation.

TWINKLE_OFF = 9¶: Twinkle off animation.

class phoenix6.signals.spn_enums.Animation6TypeValue(*args, **kwds)¶

Bases: enum.Enum

The type of animation running in slot 6 of the CANdle.

EMPTY = 0¶: No animation.

COLOR_FLOW = 1¶: Color flow animation.

FIRE = 2¶: Fire animation.

LARSON = 3¶: Larson animation.

RAINBOW = 4¶: Rainbow animation.

RGB_FADE = 5¶: RGB Fade animation.

SINGLE_FADE = 6¶: Single fade animation.

STROBE = 7¶: Strobe animation.

TWINKLE = 8¶: Twinkle animation.

TWINKLE_OFF = 9¶: Twinkle off animation.

class phoenix6.signals.spn_enums.Animation7TypeValue(*args, **kwds)¶

Bases: enum.Enum

The type of animation running in slot 7 of the CANdle.

EMPTY = 0¶: No animation.

COLOR_FLOW = 1¶: Color flow animation.

FIRE = 2¶: Fire animation.

LARSON = 3¶: Larson animation.

RAINBOW = 4¶: Rainbow animation.

RGB_FADE = 5¶: RGB Fade animation.

SINGLE_FADE = 6¶: Single fade animation.

STROBE = 7¶: Strobe animation.

TWINKLE = 8¶: Twinkle animation.

TWINKLE_OFF = 9¶: Twinkle off animation.

class phoenix6.signals.spn_enums.AnimationDirectionValue(*args, **kwds)¶

Bases: enum.Enum

Direction of the animation.

FORWARD = 0¶: The animation starts at the specified LED start index and moves towards the LED end index.

BACKWARD = 1¶: The animation starts at the specified LED end index and moves towards the LED start index.

class phoenix6.signals.spn_enums.LarsonBounceValue(*args, **kwds)¶

Bases: enum.Enum

The behavior of the larson animation pocket of light when it reaches the end of the strip.

FRONT = 0¶: The animation bounces as soon as the first LED reaches the end of the strip.

CENTER = 1¶: The animation bounces once it is midway through the end of the strip.

BACK = 2¶: The animation bounces once all LEDs are off the strip.

phoenix6.signals.spn_enums¶

Module Contents¶

`phoenix6.signals.spn_enums`¶