Rename 'ctre' package to 'phoenix5'

- Will be more consistent for users in the future
robotpy · Nov 12, 2023 · 126e0a4 · 126e0a4
1 parent 082fe2a
commit 126e0a4
Show file tree

Hide file tree

Showing 34 changed files with 98 additions and 98 deletions.
diff --git a/.gitignore b/.gitignore
@@ -43,15 +43,15 @@ __pycache__/
 *$py.class
 
 # C extensions
-/ctre/_init_ctre.py
-/ctre/pkgcfg.py
-/ctre/rpy-include
-/ctre/version.py
-/ctre/py.typed
-
-/ctre/_*/_init_*.py
-/ctre/_*/pkgcfg.py
-/ctre/_*/include
+/phoenix5/_init_ctre.py
+/phoenix5/pkgcfg.py
+/phoenix5/rpy-include
+/phoenix5/version.py
+/phoenix5/py.typed
+
+/phoenix5/_*/_init_*.py
+/phoenix5/_*/pkgcfg.py
+/phoenix5/_*/include
 
 
 # Distribution / packaging

diff --git a/README.rst b/README.rst
@@ -1,7 +1,7 @@
 robotpy-ctre
 ============
 
-This is a python wrapper around the CTRE Phoenix library. The RobotPy project
+This is a python wrapper around the CTRE Phoenix v5 API. The RobotPy project
 is not associated with or endorsed by Cross The Road Electronics.
 
 **NOTE**: CTRE only supports simulation for the following platforms:

diff --git a/docs/api.rst b/docs/api.rst
@@ -17,6 +17,6 @@ and we'll try to address the problem.
 
 .. toctree::
 
-    ctre
-    ctre.led
-    ctre.sensors
+    phoenix5
+    phoenix5.led
+    phoenix5.sensors
diff --git a/docs/conf.py b/docs/conf.py
@@ -6,7 +6,7 @@
 
 from os.path import abspath, join, dirname
 
-import ctre
+import phoenix5
 
 # -- RTD configuration ------------------------------------------------
 
@@ -136,6 +136,6 @@
 
 root = abspath(dirname(__file__))
 
-gen_package(root, "ctre")
-gen_package(root, "ctre.led")
-gen_package(root, "ctre.sensors")
+gen_package(root, "phoenix5")
+gen_package(root, "phoenix5.led")
+gen_package(root, "phoenix5.sensors")
diff --git a/examples/basic/robot.py b/examples/basic/robot.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 import wpilib
-import ctre
+import phoenix5
 
 
 class MyRobot(wpilib.TimedRobot):
@@ -11,7 +11,7 @@ class MyRobot(wpilib.TimedRobot):
     """
 
     def robotInit(self):
-        self.motor = ctre.WPI_TalonSRX(1)  # Initialize the TalonSRX on device 1.
+        self.motor = phoenix5.WPI_TalonSRX(1)  # Initialize the TalonSRX on device 1.
 
     def disabledPeriodic(self):
         self.motor.disable()

diff --git a/examples/getting-started/robot.py b/examples/getting-started/robot.py
@@ -7,7 +7,7 @@
 
 import wpilib
 import wpilib.drive
-import ctre
+import phoenix5
 
 
 class MyRobot(wpilib.TimedRobot):
@@ -16,8 +16,8 @@ def robotInit(self):
         This function is called upon program startup and
         should be used for any initialization code.
         """
-        self.leftDrive = ctre.WPI_TalonFX(1)
-        self.rightDrive = ctre.WPI_TalonFX(2)
+        self.leftDrive = phoenix5.WPI_TalonFX(1)
+        self.rightDrive = phoenix5.WPI_TalonFX(2)
         self.robotDrive = wpilib.drive.DifferentialDrive(
             self.leftDrive, self.rightDrive
         )

diff --git a/examples/motion_magic/robot.py b/examples/motion_magic/robot.py
@@ -19,7 +19,7 @@
  * use button1 to motion-magic servo to target position specified by the gamepad stick.
 """
 
-from ctre import WPI_TalonSRX
+from phoenix5 import WPI_TalonSRX
 import wpilib
 
 

diff --git a/examples/position_closed_loop/robot.py b/examples/position_closed_loop/robot.py
@@ -18,7 +18,7 @@
  * Tweak the PID gains accordingly.
 """
 
-import ctre
+import phoenix5
 import wpilib
 
 
@@ -37,7 +37,7 @@ class Robot(wpilib.TimedRobot):
     kTimeoutMs = 10
 
     def robotInit(self):
-        self.talon = ctre.WPI_TalonSRX(3)
+        self.talon = phoenix5.WPI_TalonSRX(3)
         self.joy = wpilib.Joystick(0)
 
         self.loops = 0
@@ -46,7 +46,7 @@ def robotInit(self):
 
         # choose the sensor and sensor direction
         self.talon.configSelectedFeedbackSensor(
-            ctre.FeedbackDevice.CTRE_MagEncoder_Relative,
+            phoenix5.FeedbackDevice.CTRE_MagEncoder_Relative,
             self.kPIDLoopIdx,
             self.kTimeoutMs,
         )
@@ -106,14 +106,14 @@ def teleopPeriodic(self):
 
             # 10 Rotations * 4096 u/rev in either direction
             self.targetPos = leftYstick * 4096 * 10.0
-            self.talon.set(ctre.ControlMode.Position, self.targetPos)
+            self.talon.set(phoenix5.ControlMode.Position, self.targetPos)
 
         # on button2 just straight drive
         if button2:
             # Percent voltage mode
-            self.talon.set(ctre.ControlMode.PercentOutput, leftYstick)
+            self.talon.set(phoenix5.ControlMode.PercentOutput, leftYstick)
 
-        if self.talon.getControlMode() == ctre.ControlMode.Position:
+        if self.talon.getControlMode() == phoenix5.ControlMode.Position:
             # append more signals to print when in speed mode.
             sb.append("\terr: %s" % self.talon.getClosedLoopError(self.kPIDLoopIdx))
             sb.append("\ttrg: %.3f" % self.targetPos)

diff --git a/ctre/__init__.py → phoenix5/__init__.py b/ctre/__init__.py → phoenix5/__init__.py
diff --git a/ctre/_api_cpp/__init__.py → phoenix5/_api_cpp/__init__.py b/ctre/_api_cpp/__init__.py → phoenix5/_api_cpp/__init__.py
diff --git a/ctre/_api_cpp_sim/__init__.py → phoenix5/_api_cpp_sim/__init__.py b/ctre/_api_cpp_sim/__init__.py → phoenix5/_api_cpp_sim/__init__.py
diff --git a/ctre/_cci/__init__.py → phoenix5/_cci/__init__.py b/ctre/_cci/__init__.py → phoenix5/_cci/__init__.py
diff --git a/ctre/_cci_sim/__init__.py → phoenix5/_cci_sim/__init__.py b/ctre/_cci_sim/__init__.py → phoenix5/_cci_sim/__init__.py
diff --git a/ctre/_init_phoenix6.py → phoenix5/_init_phoenix6.py b/ctre/_init_phoenix6.py → phoenix5/_init_phoenix6.py
diff --git a/ctre/_osx_phoenix6_pkgcfg.py → phoenix5/_osx_phoenix6_pkgcfg.py b/ctre/_osx_phoenix6_pkgcfg.py → phoenix5/_osx_phoenix6_pkgcfg.py
@@ -7,7 +7,7 @@
 
 _root = abspath(dirname(phoenix6.__file__))
 
-libinit_import = "ctre._init_phoenix6"
+libinit_import = "phoenix5._init_phoenix6"
 depends = []
 pypi_package = "phoenix6"
 

diff --git a/ctre/_simcancoder/__init__.py → phoenix5/_simcancoder/__init__.py b/ctre/_simcancoder/__init__.py → phoenix5/_simcancoder/__init__.py
diff --git a/ctre/_simpigeonimu/__init__.py → phoenix5/_simpigeonimu/__init__.py b/ctre/_simpigeonimu/__init__.py → phoenix5/_simpigeonimu/__init__.py
diff --git a/ctre/_simprocancoder/__init__.py → phoenix5/_simprocancoder/__init__.py b/ctre/_simprocancoder/__init__.py → phoenix5/_simprocancoder/__init__.py
diff --git a/ctre/_simpropigeon2/__init__.py → phoenix5/_simpropigeon2/__init__.py b/ctre/_simpropigeon2/__init__.py → phoenix5/_simpropigeon2/__init__.py
diff --git a/ctre/_simprotalonfx/__init__.py → phoenix5/_simprotalonfx/__init__.py b/ctre/_simprotalonfx/__init__.py → phoenix5/_simprotalonfx/__init__.py
diff --git a/ctre/_simtalonfx/__init__.py → phoenix5/_simtalonfx/__init__.py b/ctre/_simtalonfx/__init__.py → phoenix5/_simtalonfx/__init__.py
diff --git a/ctre/_simtalonsrx/__init__.py → phoenix5/_simtalonsrx/__init__.py b/ctre/_simtalonsrx/__init__.py → phoenix5/_simtalonsrx/__init__.py
diff --git a/ctre/_simvictorspx/__init__.py → phoenix5/_simvictorspx/__init__.py b/ctre/_simvictorspx/__init__.py → phoenix5/_simvictorspx/__init__.py
diff --git a/ctre/_tools/__init__.py → phoenix5/_tools/__init__.py b/ctre/_tools/__init__.py → phoenix5/_tools/__init__.py
diff --git a/ctre/_tools_sim/__init__.py → phoenix5/_tools_sim/__init__.py b/ctre/_tools_sim/__init__.py → phoenix5/_tools_sim/__init__.py
diff --git a/ctre/_wpiapi_cpp/__init__.py → phoenix5/_wpiapi_cpp/__init__.py b/ctre/_wpiapi_cpp/__init__.py → phoenix5/_wpiapi_cpp/__init__.py
diff --git a/ctre/_wpiapi_cpp_sim/__init__.py → phoenix5/_wpiapi_cpp_sim/__init__.py b/ctre/_wpiapi_cpp_sim/__init__.py → phoenix5/_wpiapi_cpp_sim/__init__.py
diff --git a/ctre/ctre.cpp → phoenix5/ctre.cpp b/ctre/ctre.cpp → phoenix5/ctre.cpp
diff --git a/ctre/led.py → phoenix5/led.py b/ctre/led.py → phoenix5/led.py
diff --git a/ctre/sensors.py → phoenix5/sensors.py b/ctre/sensors.py → phoenix5/sensors.py