Skip to content

Commit

Permalink
Fix python link syntax (#2859)
Browse files Browse the repository at this point in the history
* Fix python link syntax

* Fix some more links

* Another link
  • Loading branch information
sciencewhiz authored Dec 9, 2024
1 parent 133e930 commit 87253e9
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Transformations for ``Rotation2d`` are just arithmetic operations on the angle m

## Transform2d and Twist2d

WPILib provides 2 classes, ``Transform2d`` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/math/geometry/Transform2d.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_transform2d.html), :external:py:class:[Python](wpimath.geometry.Transform2d>`), which represents a transformation to a pose, and ``Twist2d`` ([Java] (https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/math/geometry/Twist2d.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/structfrc_1_1_twist2d.html), :external:py:class:`Python <wpimath.geometry.Twist2d>`) which represents a movement along an arc. ``Transform2d`` and ``Twist2d`` all have x, y and :math:`\theta` components.
WPILib provides 2 classes, ``Transform2d`` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/math/geometry/Transform2d.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_transform2d.html), :external:py:class:`Python <wpimath.geometry.Transform2d>`), which represents a transformation to a pose, and ``Twist2d`` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/math/geometry/Twist2d.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/structfrc_1_1_twist2d.html), :external:py:class:`Python <wpimath.geometry.Twist2d>`) which represents a movement along an arc. ``Transform2d`` and ``Twist2d`` all have x, y and :math:`\theta` components.

``Transform2d`` represents a **relative** transformation. It has an translation and a rotation component. Transforming a ``Pose2d`` by a ``Transform2d`` rotates the translation component of the transform by the rotation of the pose, and then adds the rotated translation component and the rotation component to the pose. In other words, ``Pose2d.plus(Transform2d)`` returns :math:`\begin{bmatrix} x_p \\ y_p \\ \theta_p \end{bmatrix}+\begin{bmatrix} cos\theta_p & -sin\theta_p & 0 \\ sin\theta_p & cos\theta_p & 0 \\ 0 & 0 & 1 \end{bmatrix}\begin{bmatrix}x_t \\ y_t \\ \theta_t \end{bmatrix}`

Expand Down
2 changes: 1 addition & 1 deletion source/docs/software/can-devices/pneumatic-hub.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The Pneumatic Hub (:term:`PH`) is a :term:`CAN`-based device that provides complete control over the compressor and up to 16 solenoids per module. The PH is integrated into WPILib through a series of classes that make it simple to use.

The closed loop control of the Compressor and Pressure switch is handled by the :code:`Compressor` class ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/Compressor.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_compressor.html), :external:py:class:[Python](wpilib.Compressor>`), and the Solenoids are handled by the :code:`Solenoid` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/Solenoid.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_solenoid.html), :external:py:class:[Python](wpilib.Solenoid>`) and :code:`DoubleSolenoid` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/DoubleSolenoid.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_double_solenoid.html), :external:py:class:`Python <wpilib.DoubleSolenoid>`) classes.
The closed loop control of the Compressor and Pressure switch is handled by the :code:`Compressor` class ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/Compressor.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_compressor.html), :external:py:class:`Python <wpilib.Compressor>`), and the Solenoids are handled by the :code:`Solenoid` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/Solenoid.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_solenoid.html), :external:py:class:`Python <wpilib.Solenoid>`) and :code:`DoubleSolenoid` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/DoubleSolenoid.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_double_solenoid.html), :external:py:class:`Python <wpilib.DoubleSolenoid>`) classes.

An additional PH module can be used where the module's corresponding solenoids are differentiated by the module number in the constructors of the Solenoid and Compressor classes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The Pneumatics Control Module (:term:`PCM`) is a :term:`CAN`-based device that provides complete control over the compressor and up to 8 solenoids per module. The PCM is integrated into WPILib through a series of classes that make it simple to use.

The closed loop control of the Compressor and Pressure switch is handled by the :code:`Compressor` class ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/Compressor.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_compressor.html), :external:py:class:[Python](wpilib.Compressor>`), and the Solenoids are handled by the :code:`Solenoid` ([Java])https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/Solenoid.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_solenoid.html), :external:py:class:[Python](wpilib.Solenoid>`) and :code:`DoubleSolenoid` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/DoubleSolenoid.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_double_solenoid.html), :external:py:class:`Python <wpilib.DoubleSolenoid>`) classes.
The closed loop control of the Compressor and Pressure switch is handled by the :code:`Compressor` class ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/Compressor.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_compressor.html), :external:py:class:`Python <wpilib.Compressor>`), and the Solenoids are handled by the :code:`Solenoid` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/Solenoid.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_solenoid.html), :external:py:class:`Python <wpilib.Solenoid>`) and :code:`DoubleSolenoid` ([Java](https://github.wpilib.org/allwpilib/docs/development/java/edu/wpi/first/wpilibj/DoubleSolenoid.html), [C++](https://github.wpilib.org/allwpilib/docs/development/cpp/classfrc_1_1_double_solenoid.html), :external:py:class:`Python <wpilib.DoubleSolenoid>`) classes.

An additional PCM module can be used where the module's corresponding solenoids are differentiated by the module number in the constructors of the Solenoid and Compressor classes.

Expand Down
Loading

0 comments on commit 87253e9

Please sign in to comment.