Skip to content

Latest commit

 

History

History
120 lines (84 loc) · 1.84 KB

api.rst

File metadata and controls

120 lines (84 loc) · 1.84 KB

WPILib API

.. toctree::
  :maxdepth: 1

  wpilib
  wpilib.cameraserver
  wpilib.counter
  wpilib.deployinfo
  wpilib.drive
  wpilib.event
  wpilib.interfaces
  wpilib.shuffleboard
  wpilib.simulation

NTCore API

.. toctree::
  :maxdepth: 1

  ntcore
  ntcore.util

CSCore API

.. toctree::
  :maxdepth: 1

  cscore
  cscore.imagewriter

Apriltag API

.. toctree::
  :maxdepth: 1

  robotpy_apriltag

WPIMath API

WPIMath provides a comprehensive set of mathematical functions and utilities tailored to the needs of robotics applications.

.. toctree::
  :maxdepth: 1

  wpimath
  wpimath.controller
  wpimath.estimator
  wpimath.filter
  wpimath.geometry
  wpimath.interpolation
  wpimath.kinematics
  wpimath.spline
  wpimath.system
  wpimath.system.plant
  wpimath.trajectory
  wpimath.trajectory.constraint
  wpimath.units

WPINet API

.. toctree::
  :maxdepth: 1

  wpinet

WPIUtil API

The C++ version of the WPIUtil library contains various utilities that user code and WPILib can use to accomplish common tasks that aren't necessarily provided by the C++ standard library.

Much of the content in WPIUtil is not useful for Python teams, so we don't provide access to most of WPIUtil directly. Luckily, RobotPy teams have access to the full Python standard library, which has many of the same types of things in it.

.. toctree::
  :maxdepth: 1

  wpiutil
  wpiutil.log
  wpiutil.sync


HAL API

The WPILib Hardware Abstraction Layer (HAL) is used by WPILib to interact with robot devices in a platform independent way.

Generally, RobotPy users should avoid interacting with the HAL directly.

.. toctree::
  :maxdepth: 1

  hal
  hal.simulation