Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add additional 3rd party CAN devices #2823

Merged
merged 9 commits into from
Nov 6, 2024
55 changes: 33 additions & 22 deletions source/docs/software/can-devices/third-party-devices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,56 +19,56 @@ CTR Electronics (CTRE) offers several CAN peripherals with external libraries. G

### CTRE Motor Controllers

- **Talon FX (with Falcon 500 Motor)**
- **Talon FX (with Falcon 500 Motor, Kraken x60 motor, and Kraken x44)**

- API Documentation (v5: [Java](https://api.ctr-electronics.com/phoenix/release/java/com/ctre/phoenix/motorcontrol/can/WPI_TalonFX.html), [C++](https://api.ctr-electronics.com/phoenix/release/cpp/classctre_1_1phoenix_1_1motorcontrol_1_1can_1_1_w_p_i___talon_f_x.html) | Pro: [Java](https://api.ctr-electronics.com/phoenixpro/release/java/com/ctre/phoenixpro/hardware/TalonFX.html), [C++](https://api.ctr-electronics.com/phoenixpro/release/cpp/classctre_1_1phoenixpro_1_1hardware_1_1_talon_f_x.html))
- [Hardware User's Manual](https://store.ctr-electronics.com/content/user-manual/Falcon%20500%20User%20Guide.pdf)
- Software Documentation ([v5](https://v5.docs.ctr-electronics.com/en/stable/ch13_MC.html), [Pro](https://pro.docs.ctr-electronics.com/en/stable/docs/api-reference/examples/quickstart.html))
- API Documentation (v6: [Java](https://api.ctr-electronics.com/phoenix6/release/java/com/ctre/phoenix6/hardware/TalonFX.html), [C++](https://api.ctr-electronics.com/phoenix/release/cpp/classctre_1_1phoenix_1_1motorcontrol_1_1can_1_1_talon_f_x.html))
- Hardware User's Manual ([Falcon 500](https://ctre.download/files/user-manual/Falcon%20500%20v3%20User's%20Guide.pdf), [Kraken x60](https://docs.wcproducts.com/kraken-x60), [Kraken x44](https://docs.wcproducts.com/kraken-x44))
- [Software Documentation](https://v6.docs.ctr-electronics.com/en/stable/docs/hardware-reference/talonfx/index.html)

- **Talon SRX**

- API Documentation ([Java](https://api.ctr-electronics.com/phoenix/release/java/com/ctre/phoenix/motorcontrol/can/WPI_TalonSRX.html), [C++](https://api.ctr-electronics.com/phoenix/release/cpp/classctre_1_1phoenix_1_1motorcontrol_1_1can_1_1_w_p_i___talon_s_r_x.html))
- [Hardware User's Manual](https://store.ctr-electronics.com/content/user-manual/Talon%20SRX%20User's%20Guide.pdf)
- [Hardware User's Manual](https://ctre.download/files/user-manual/Talon%20SRX%20User's%20Guide.pdf)
- [Software Documentation](https://v5.docs.ctr-electronics.com/en/stable/ch13_MC.html)

- **Victor SPX**

- API Documentation ([Java](https://api.ctr-electronics.com/phoenix/release/java/com/ctre/phoenix/motorcontrol/can/WPI_VictorSPX.html), [C++](https://api.ctr-electronics.com/phoenix/release/cpp/classctre_1_1phoenix_1_1motorcontrol_1_1can_1_1_w_p_i___victor_s_p_x.html))
- [Hardware User's Manual](https://store.ctr-electronics.com/content/user-manual/Victor%20SPX%20User's%20Guide.pdf)
- [Hardware User's Manual](https://ctre.download/files/user-manual/Victor%20SPX%20User's%20Guide.pdf)
- [Software Documentation](https://v5.docs.ctr-electronics.com/en/stable/ch13_MC.html)

### CTRE Sensors

- **CANcoder**

- API Documentation (v5: [Java](https://api.ctr-electronics.com/phoenix/release/java/com/ctre/phoenix/sensors/WPI_CANCoder.html), [C++](https://api.ctr-electronics.com/phoenix/release/cpp/classctre_1_1phoenix_1_1sensors_1_1_w_p_i___c_a_n_coder.html) | Pro: [Java](https://api.ctr-electronics.com/phoenixpro/release/java/com/ctre/phoenixpro/hardware/CANcoder.html), [C++](https://api.ctr-electronics.com/phoenixpro/release/cpp/classctre_1_1phoenixpro_1_1hardware_1_1_c_a_ncoder.html))
- API Documentation (v6: [Java](https://api.ctr-electronics.com/phoenix6/release/java/com/ctre/phoenix6/hardware/CANcoder.html), [C++](https://api.ctr-electronics.com/phoenix6/release/cpp/namespacectre_1_1phoenix_1_1platform.html#ad0cac06e0817cbcfe20851a8619a19a8a13b25ca6c3f7037c0f6e13b59cc1e571))
- [Hardware User's Manual](https://store.ctr-electronics.com/content/user-manual/CANCoder%20User's%20Guide.pdf)
- Software Documentation ([v5](https://v5.docs.ctr-electronics.com/en/stable/ch12a_BringUpCANCoder.html), [Pro](https://pro.docs.ctr-electronics.com/en/stable/docs/api-reference/api-usage/index.html))
- [Software Documentation](https://v6.docs.ctr-electronics.com/en/stable/docs/hardware-reference/cancoder/index.html)

- **Pigeon 2.0**

- API Documentation (v5: [Java](https://api.ctr-electronics.com/phoenix/release/java/com/ctre/phoenix/sensors/WPI_Pigeon2.html), [C++](https://api.ctr-electronics.com/phoenix/release/cpp/classctre_1_1phoenix_1_1sensors_1_1_w_p_i___pigeon2.html) | Pro: [Java](https://api.ctr-electronics.com/phoenixpro/release/java/com/ctre/phoenixpro/hardware/Pigeon2.html), [C++](https://api.ctr-electronics.com/phoenixpro/release/cpp/classctre_1_1phoenixpro_1_1hardware_1_1_pigeon2.html))
- API Documentation (v6: [Java](https://api.ctr-electronics.com/phoenix6/release/java/com/ctre/phoenix6/hardware/Pigeon2.html), [C++](https://api.ctr-electronics.com/phoenix6/release/cpp/namespacectre_1_1phoenix_1_1platform.html#ad0cac06e0817cbcfe20851a8619a19a8a7bd5c8d59e1daa07d31aa1d7116c5c64))
- [Hardware User's Manual](https://store.ctr-electronics.com/content/user-manual/Pigeon2%20User's%20Guide.pdf)
- Software Documentation ([v5](https://v5.docs.ctr-electronics.com/en/stable/ch11a_BringUpPigeon2.html), [Pro](https://pro.docs.ctr-electronics.com/en/stable/docs/api-reference/api-usage/index.html))
- [Software Documentation6](https://v6.docs.ctr-electronics.com/en/stable/docs/hardware-reference/pigeon2/index.html)

- **Pigeon IMU**

- API Documentation ([Java](https://api.ctr-electronics.com/phoenix/release/java/com/ctre/phoenix/sensors/WPI_PigeonIMU.html), [C++](https://api.ctr-electronics.com/phoenix/release/cpp/classctre_1_1phoenix_1_1sensors_1_1_w_p_i___pigeon_i_m_u.html))
- [Hardware User's Manual](https://store.ctr-electronics.com/content/user-manual/Pigeon%20IMU%20User's%20Guide.pdf)
- [Hardware User's Manual](https://ctre.download/files/user-manual/Pigeon%20IMU%20User's%20Guide.pdf)
- [Software Documentation](https://v5.docs.ctr-electronics.com/en/stable/ch11_BringUpPigeon.html)

- **CANifier**

- API Documentation ([Java](https://api.ctr-electronics.com/phoenix/release/java/com/ctre/phoenix/CANifier.html), [C++](https://api.ctr-electronics.com/phoenix/release/cpp/classctre_1_1phoenix_1_1_c_a_nifier.html))
- [Hardware User's Manual](https://store.ctr-electronics.com/content/user-manual/CANifier%20User%27s%20Guide.pdf)
- [Hardware User's Manual](https://ctre.download/files/user-manual/CANifier%20User's%20Guide.pdf)
- [Software Documentation](https://v5.docs.ctr-electronics.com/en/stable/ch12_BringUpCANifier.html)

### CTRE Other CAN Devices

- **CANdle LED Controller**

- API Documentation ([Java](https://api.ctr-electronics.com/phoenix/release/java/com/ctre/phoenix/led/CANdle.html), [C++](https://api.ctr-electronics.com/phoenix/release/cpp/classctre_1_1phoenix_1_1led_1_1_c_a_ndle.html))
- [Hardware User's Manual](https://store.ctr-electronics.com/content/user-manual/CANdle%20User's%20Guide.pdf)
- [Hardware User's Manual](https://ctre.download/files/user-manual/CANdle%20User's%20Guide.pdf)
- [Software Documentation](https://v5.docs.ctr-electronics.com/en/stable/ch12b_BringUpCANdle.html)

## REV Robotics
Expand All @@ -79,12 +79,12 @@ REV Robotics currently offers the SPARK MAX and SPARK Flex motor controllers whi

- **SPARK MAX**

- API Documentation ([Java](https://codedocs.revrobotics.com/java/com/revrobotics/cansparkmax), [C++](https://codedocs.revrobotics.com/cpp/classrev_1_1_c_a_n_spark_max))
- API Documentation ([Java](https://codedocs.revrobotics.com/java/com/revrobotics/spark/sparkmax), [C++](https://codedocs.revrobotics.com/cpp/classrev_1_1spark_1_1_spark_max.html))
- [Technical Manual](https://docs.revrobotics.com/brushless/spark-max/overview)

- **SPARK Flex**

- API Documentation ([Java](https://codedocs.revrobotics.com/java/com/revrobotics/cansparkflex), [C++](https://codedocs.revrobotics.com/cpp/classrev_1_1_c_a_n_spark_flex))
- API Documentation ([Java](https://codedocs.revrobotics.com/java/com/revrobotics/spark/sparkflex), [C++](https://codedocs.revrobotics.com/cpp/classrev_1_1spark_1_1_spark_flex.html))
- [Technical Manual](https://docs.revrobotics.com/brushless/spark-flex/overview)

## Playing With Fusion
Expand All @@ -107,16 +107,27 @@ Playing With Fusion (PWF) offers the Venom integrated motor/controller as well a

## Redux Robotics

Redux Robotics currently offers the Canandcoder :term:`CAN` + :term:`PWM` magnetic encoder and the Canandcolor :term:`CAN`-enabled color sensor.
Redux Robotics currently offers the HELIUM Canandmag :term:`CAN` + :term:`PWM` magnetic encoder and the BORON Canandgyro :term:`CAN`-enabled gyro.

### Redux Sensors

- **Canandcoder**
- **HELIUM Canandmag**

- API Documentation ([Java](https://apidocs.reduxrobotics.com/current/java/com/reduxrobotics/sensors/canandcoder/Canandcoder.html), [C++](https://apidocs.reduxrobotics.com/current/cpp/classredux_1_1sensors_1_1canandcoder_1_1Canandcoder.html))
- [Technical Manual](https://docs.reduxrobotics.com/canandcoder/index.html)
- API Documentation ([Java](https://apidocs.reduxrobotics.com/current/java/com/reduxrobotics/sensors/canandmag/package-summary), [C++](https://apidocs.reduxrobotics.com/current/cpp/namespaceredux_1_1sensors_1_1canandmag))
- [Technical Manual](https://docs.reduxrobotics.com/canandmag)

- **Canandcolor**
- **BORON Canandgyro**

- API Documentation ([Java](https://apidocs.reduxrobotics.com/current/java/com/reduxrobotics/sensors/canandcolor/Canandcolor.html), [C++](https://apidocs.reduxrobotics.com/current/cpp/classredux_1_1sensors_1_1canandcolor_1_1Canandcolor.html))
- [Technical Manual](https://docs.reduxrobotics.com/canandcolor/index.html)
- API Documentation ([Java](https://apidocs.reduxrobotics.com/current/java/com/reduxrobotics/sensors/canandgyro/package-summary), [C++](https://apidocs.reduxrobotics.com/current/cpp/namespaceredux_1_1sensors_1_1canandgyro))
- [Technical Manual](https://docs.reduxrobotics.com/canandgyro/)

## Grapple Robotics

Grapple Robotics currently offers the LaserCAN :term:`CAN`-enabled range finding sensor

### Grapple Sensors

- **LaserCAN**

- API Documentation ([Java](https://github.com/GrappleRobotics/LaserCAN/blob/master/docs/example-java.md), [C++](https://github.com/GrappleRobotics/LaserCAN/blob/master/docs/example-cpp.md))
- [Technical Manual](https://github.com/GrappleRobotics/LaserCAN/blob/master/docs/getting-started.md)