wpilib Package

wpilib functions

ADXL345_I2C(port[, range, deviceAddress])

ADXL345 Accelerometer on I2C.

AddressableLED(channel)

A class for driving addressable LEDs, such as WS2812B, WS2815, and NeoPixels.

Alert(*args, **kwargs)

Persistent alert to be sent to the driver station.

Alliance(value)

The robot alliance that the robot is a part of.

AnalogAccelerometer(*args, **kwargs)

Handle operation of an analog accelerometer.

AnalogEncoder(*args, **kwargs)

Class for supporting continuous analog encoders, such as the US Digital MA3.

AnalogInput(channel)

Analog input class.

AnalogPotentiometer(*args, **kwargs)

Class for reading analog potentiometers.

BooleanEvent(loop, signal)

This class provides an easy way to link actions to active high logic signals.

CAN(*args, **kwargs)

High level class for interfacing with CAN devices conforming to the standard CAN spec.

CANStatus()

CameraServer()

Provides a way to launch an out of process cscore-based camera service instance, for streaming or for image processing.

Compressor(*args, **kwargs)

Class for operating a compressor connected to a pneumatics module.

CompressorConfigType(value)

Compressor config type.

CounterBase()

Interface for counting the number of ticks on a digital input channel.

DataLogManager

Centralized data log that provides automatic data log file management.

DifferentialDrive(*args, **kwargs)

A class for driving differential drive/skid-steer drive platforms such as the Kit of Parts drive base, "tank drive", or West Coast Drive.

DigitalInput(channel)

Class to read a digital input.

DigitalOutput(channel)

Class to write to digital outputs.

DoubleSolenoid(*args, **kwargs)

DoubleSolenoid class for running 2 channels of high voltage Digital Output on a pneumatics module.

DriverStation

Provides access to Driver Station functionality.

DriverStationBackend

Provide access to the network communication data to / from the Driver Station.

DutyCycle(source)

Class to read a duty cycle PWM input.

DutyCycleEncoder(*args, **kwargs)

Class for supporting duty cycle/PWM encoders, such as the US Digital MA3 with PWM Output, the CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag Encoder.

EdgeConfiguration(value)

Edge configuration.

Encoder(aChannel, bChannel, ...)

Class to read quad encoders.

EventLoop()

A declarative way to bind a set of actions to a loop and execute them when the loop is polled.

ExpansionHub(usbId)

This class controls a REV ExpansionHub plugged in over USB to Systemcore.

ExpansionHubMotor(usbId, channel)

This class controls a specific motor and encoder hooked up to an ExpansionHub.

ExpansionHubPositionConstants

This class contains feedback and feedforward constants for an ExpansionHub motor.

ExpansionHubServo(usbId, channel)

This class controls a specific servo in positional/servo mode hooked up to an ExpansionHub.

ExpansionHubVelocityConstants

This class contains feedback and feedforward constants for an ExpansionHub motor.

Field2d()

2D representation of game field for dashboards.

FieldObject2d

Game field object on a Field2d.

Gamepad(port)

Handle input from Gamepad controllers connected to the Driver Station.

GenericHID(port)

Handle input from standard HID devices connected to the Driver Station.

I2C(port, deviceAddress)

I2C bus interface class.

IterativeRobotBase(period)

IterativeRobotBase implements a specific type of robot program framework, extending the RobotBase class.

Joystick(port)

Handle input from standard Joysticks connected to the Driver Station.

Koors40(channel)

AndyMark Koors40 Motor Controller with PWM control.

LEDPattern(impl)

MatchState

Provides access to match state information from the Driver Station.

MatchType(value)

The type of robot match that the robot is part of.

MecanumDrive(*args, **kwargs)

Overloaded function.

Mechanism2d(width, height[, backgroundColor])

Visual 2D representation of arms, elevators, and general mechanisms through a node-based API.

MechanismLigament2d

Ligament node on a Mechanism2d.

MechanismObject2d

Common base class for all Mechanism2d node types.

MechanismRoot2d

Root Mechanism2d node.

MotorController()

Interface for motor controlling devices.

MotorControllerGroup(*args)

MotorSafety()

The Motor Safety feature acts as a watchdog timer for an individual motor.

NetworkBooleanEvent(*args, **kwargs)

A Button that uses a NetworkTable boolean field.

NiDsPS4Controller(port)

Handle input from NiDsPS4 controllers connected to the Driver Station.

NiDsPS5Controller(port)

Handle input from NiDsPS5 controllers connected to the Driver Station.

NiDsStadiaController(port)

Handle input from NiDsStadia controllers connected to the Driver Station.

NiDsXboxController(port)

Handle input from NiDsXbox controllers connected to the Driver Station.

Notifier(handler)

Create a Notifier for timer event notification.

OnboardIMU(mountOrientation)

Systemcore onboard IMU

OpMode()

Top-level interface for opmode classes.

OpModeRobot(*args, **kwargs)

OpModeRobot implements the opmode-based robot program framework.

OpModeRobotBase(*args, **kwargs)

OpModeRobotBase is the non-templated base class for OpModeRobot.

POVDirection(value)

A controller POV direction.

PWM(channel[, registerSendable])

Class for sending pulse-width modulation (PWM) signals.

PWMMotorController(name, channel)

Common base class for all PWM Motor Controllers.

PWMSparkFlex(channel)

REV Robotics SPARK Flex Motor Controller with PWM control.

PWMSparkMax(channel)

REV Robotics SPARK MAX Motor Controller with PWM control.

PWMTalonFX(channel)

Cross the Road Electronics (CTRE) Talon FX Motor Controller with PWM control.

PWMTalonSRX(channel)

Cross the Road Electronics (CTRE) Talon SRX Motor Controller with PWM control.

PWMVenom(channel)

Playing with Fusion Venom Motor Controller with PWM control.

PWMVictorSPX(channel)

Cross the Road Electronics (CTRE) Victor SPX Motor Controller with PWM control.

PeriodicOpMode()

An opmode structure for periodic operation.

PeriodicPriorityQueue()

A priority queue for scheduling periodic callbacks based on their next execution time.

PneumaticHub(*args, **kwargs)

Module class for controlling a REV Robotics Pneumatic Hub.

PneumaticsBase()

Base class for pneumatics devices.

PneumaticsControlModule(*args, **kwargs)

Module class for controlling a Cross The Road Electronics Pneumatics Control Module.

PneumaticsModuleType(value)

Pneumatics module type.

PowerDistribution(*args, **kwargs)

Class for getting voltage, current, temperature, power and energy from the CTRE Power Distribution Panel (PDP) or REV Power Distribution Hub (PDH).

Preferences

The preferences class provides a relatively simple way to save important values to the roboRIO to access the next time the roboRIO is booted.

RobotBase()

Implement a Robot Program framework.

RobotController

RobotDriveBase()

Common base class for drive platforms.

RobotState

Provides access to robot state information from the Driver Station.

RuntimeType(value)

Runtime type.

SendableBuilderImpl()

Implementation detail for SendableBuilder.

SendableChooser()

The SendableChooser class is a useful tool for presenting a selection of options to the SmartDashboard.

SendableChooserBase

This class is a non-template base class for SendableChooser.

SensorUtil

Stores most recent status information as well as containing utility functions for checking channels and error processing.

SerialPort(*args, **kwargs)

Driver for the RS-232 serial port on the roboRIO.

SharpIR(channel, a, b, min, max)

Manually construct a SharpIR object.

SmartDashboard

Solenoid(*args, **kwargs)

Solenoid class for running high voltage Digital Output on a pneumatics module.

Spark(channel)

REV Robotics SPARK Motor Controller with PWM control.

SparkMini(channel)

REV Robotics SPARKMini Motor Controller with PWM control.

SystemServer

Tachometer(channel, configuration)

Tachometer for getting rotational velocity from a device.

Talon(channel)

Cross the Road Electronics (CTRE) Talon Motor Controller with PWM control.

TimedRobot(*args, **kwargs)

TimedRobot implements the IterativeRobotBase robot program framework.

Timer()

A timer class.

TimesliceRobot(robotPeriodicAllocation, ...)

TimesliceRobot extends the TimedRobot robot program framework to provide timeslice scheduling of periodic functions.

TouchpadFinger()

Touchpad finger data from a joystick.

Tracer()

A class for keeping track of how much time it takes for different parts of code to execute.

UpDownCounter(channel, configuration)

Up Down Counter.

VictorSP(channel)

Vex Robotics Victor SP Motor Controller with PWM control.

Watchdog(timeout, callback)

A class that's a wrapper around a watchdog timer.