Python API Documentation

Welcome to the documentation for the Phoenix 6 Python API.

Important

User’s looking for the main usage documentation can find it at https://pro.docs.ctr-electronics.com/en/latest

API Reference

• phoenix6
  • phoenix6.configs
    • phoenix6.configs.cancoder_configs
    • phoenix6.configs.config_groups
    • phoenix6.configs.parent_configurator
    • phoenix6.configs.pigeon2_configs
    • phoenix6.configs.talon_fx_configs
  • phoenix6.controls
    • phoenix6.controls.coast_out
    • phoenix6.controls.differential_duty_cycle
    • phoenix6.controls.differential_follower
    • phoenix6.controls.differential_motion_magic_duty_cycle
    • phoenix6.controls.differential_motion_magic_voltage
    • phoenix6.controls.differential_position_duty_cycle
    • phoenix6.controls.differential_position_voltage
    • phoenix6.controls.differential_strict_follower
    • phoenix6.controls.differential_velocity_duty_cycle
    • phoenix6.controls.differential_velocity_voltage
    • phoenix6.controls.differential_voltage
    • phoenix6.controls.duty_cycle_out
    • phoenix6.controls.dynamic_motion_magic_duty_cycle
    • phoenix6.controls.dynamic_motion_magic_torque_current_foc
    • phoenix6.controls.dynamic_motion_magic_voltage
    • phoenix6.controls.empty_control
    • phoenix6.controls.follower
    • phoenix6.controls.motion_magic_duty_cycle
    • phoenix6.controls.motion_magic_expo_duty_cycle
    • phoenix6.controls.motion_magic_expo_torque_current_foc
    • phoenix6.controls.motion_magic_expo_voltage
    • phoenix6.controls.motion_magic_torque_current_foc
    • phoenix6.controls.motion_magic_velocity_duty_cycle
    • phoenix6.controls.motion_magic_velocity_torque_current_foc
    • phoenix6.controls.motion_magic_velocity_voltage
    • phoenix6.controls.motion_magic_voltage
    • phoenix6.controls.music_tone
    • phoenix6.controls.neutral_out
    • phoenix6.controls.position_duty_cycle
    • phoenix6.controls.position_torque_current_foc
    • phoenix6.controls.position_voltage
    • phoenix6.controls.static_brake
    • phoenix6.controls.strict_follower
    • phoenix6.controls.torque_current_foc
    • phoenix6.controls.velocity_duty_cycle
    • phoenix6.controls.velocity_torque_current_foc
    • phoenix6.controls.velocity_voltage
    • phoenix6.controls.voltage_out
  • phoenix6.hardware
    • phoenix6.hardware.core
    • phoenix6.hardware.cancoder
    • phoenix6.hardware.device_identifier
    • phoenix6.hardware.parent_device
    • phoenix6.hardware.pigeon2
    • phoenix6.hardware.talon_fx
  • phoenix6.signals
    • phoenix6.signals.spn_enums
  • phoenix6.sim
    • phoenix6.sim.cancoder_sim_state
    • phoenix6.sim.chassis_reference
    • phoenix6.sim.device_type
    • phoenix6.sim.pigeon2_sim_state
    • phoenix6.sim.talon_fx_sim_state
  • phoenix6.spns
    • phoenix6.spns.spn_value
  • phoenix6.all_timestamps
  • phoenix6.base_status_signal
  • phoenix6.canbus
  • phoenix6.error_reporting
  • phoenix6.orchestra
  • phoenix6.phoenix_native
  • phoenix6.signal_logger
  • phoenix6.status_code
  • phoenix6.status_signal
  • phoenix6.timestamp
  • phoenix6.units
  • phoenix6.unmanaged
  • phoenix6.utils