diff --git a/python_tools/generate_json.py b/python_tools/generate_json.py index a0fb6809..07f09a5e 100644 --- a/python_tools/generate_json.py +++ b/python_tools/generate_json.py @@ -31,7 +31,6 @@ import wpilib.drive import wpilib.event import wpilib.interfaces -import wpilib.shuffleboard import wpilib.simulation import wpimath import wpimath.controller @@ -91,7 +90,6 @@ def main(argv): wpilib.drive, wpilib.event, wpilib.interfaces, - wpilib.shuffleboard, wpilib.simulation, python_util.getModule('wpilib.sysid'), wpimath, diff --git a/python_tools/requirements.txt b/python_tools/requirements.txt index 9c07de7c..c522fcf5 100644 --- a/python_tools/requirements.txt +++ b/python_tools/requirements.txt @@ -11,22 +11,30 @@ Pint==0.24.4 platformdirs==4.3.6 pluggy==1.5.0 pycparser==2.22 -pyfrc==2025.0.0 +pyfrc==2027.0.0a2 PyNaCl==1.5.0 pynetconsole==2.0.4 -pyntcore==2025.1.1.0 +pyntcore==2027.0.0a2 pytest==8.3.4 pytest-reraise==2.1.2 -robotpy==2025.1.1.1 +robotpy==2027.0.0a2 robotpy-cli==2024.0.0 -robotpy-hal==2025.1.1.0 -robotpy-halsim-gui==2025.1.1.0 -robotpy-installer==2025.0.0 -robotpy-wpilib-utilities==2025.0.0 -robotpy-wpimath==2025.1.1.0 -robotpy-wpinet==2025.1.1.0 -robotpy-wpiutil==2025.1.1.0 +robotpy-hal==2027.0.0a2 +robotpy-halsim-gui==2027.0.0a2 +robotpy-installer==2027.0.0a2 +robotpy-native-datalog==2027.0.0a2 +robotpy-native-ntcore==2027.0.0a2 +robotpy-native-wpihal==2027.0.0a2 +robotpy-native-wpilib==2027.0.0a2 +robotpy-native-wpimath==2027.0.0a2 +robotpy-native-wpinet==2027.0.0a2 +robotpy-native-wpiutil==2027.0.0a2 +robotpy-wpilib-utilities==2027.0.0a2 +robotpy-wpilog==2027.0.0a2 +robotpy-wpimath==2027.0.0a2 +robotpy-wpinet==2027.0.0a2 +robotpy-wpiutil==2027.0.0a2 tomli==2.2.1 tomlkit==0.13.2 typing_extensions==4.12.2 -wpilib==2025.1.1.0 +wpilib==2027.0.0a2 diff --git a/src/blocks/utils/generated/robotpy_data.json b/src/blocks/utils/generated/robotpy_data.json index 5e6cd8b2..2c314713 100644 --- a/src/blocks/utils/generated/robotpy_data.json +++ b/src/blocks/utils/generated/robotpy_data.json @@ -304,925 +304,1004 @@ }, "classes": [ { - "className": "wpilib.ADIS16448_IMU", - "classVariables": [], - "constructors": [ + "className": "wpilib.ADXL345_I2C", + "classVariables": [ { - "args": [], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "__init__", - "returnType": "wpilib.ADIS16448_IMU", - "tooltip": "IMU constructor on onboard MXP CS0, Z-up orientation, and complementary\nAHRS computation." - }, + "name": "kAddress", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "yaw_axis", - "type": "wpilib.ADIS16448_IMU.IMUAxis" + "name": "port", + "type": "wpilib.I2C.Port" }, { - "defaultValue": "", - "name": "port", - "type": "wpilib.SPI.Port" + "defaultValue": "", + "name": "range", + "type": "wpilib.ADXL345_I2C.Range" }, { - "defaultValue": "", - "name": "cal_time", - "type": "wpilib.ADIS16448_IMU.CalibrationTime" + "defaultValue": "29", + "name": "deviceAddress", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", + "declaringClassName": "wpilib.ADXL345_I2C", "functionName": "__init__", - "returnType": "wpilib.ADIS16448_IMU", - "tooltip": "IMU constructor on the specified MXP port and orientation.\n\n:param yaw_axis: The axis where gravity is present. Valid options are kX,\n kY, and kZ\n:param port: The SPI port where the IMU is connected.\n:param cal_time: The calibration time that should be used on start-up." - } - ], - "enums": [ - { - "enumClassName": "wpilib.ADIS16448_IMU.CalibrationTime", - "enumValues": [ - "_128ms", - "_16s", - "_1s", - "_256ms", - "_2s", - "_32ms", - "_32s", - "_4s", - "_512ms", - "_64ms", - "_64s", - "_8s" - ], - "moduleName": "wpilib", - "tooltip": "ADIS16448 calibration times.\n\nMembers:\n\n _32ms : 32 ms calibration time.\n\n _64ms : 64 ms calibration time.\n\n _128ms : 128 ms calibration time.\n\n _256ms : 256 ms calibration time.\n\n _512ms : 512 ms calibration time.\n\n _1s : 1 s calibration time.\n\n _2s : 2 s calibration time.\n\n _4s : 4 s calibration time.\n\n _8s : 8 s calibration time.\n\n _16s : 16 s calibration time.\n\n _32s : 32 s calibration time.\n\n _64s : 64 s calibration time." - }, - { - "enumClassName": "wpilib.ADIS16448_IMU.IMUAxis", - "enumValues": [ - "kX", - "kY", - "kZ" - ], - "moduleName": "wpilib", - "tooltip": "IMU axes.\n\nMembers:\n\n kX : The IMU's X axis.\n\n kY : The IMU's Y axis.\n\n kZ : The IMU's Z axis." + "returnType": "wpilib.ADXL345_I2C", + "tooltip": "Constructs the ADXL345 Accelerometer over I2C.\n\n:param port: The I2C port the accelerometer is attached to\n:param range: The range (+ or -) that the accelerometer will measure\n:param deviceAddress: The I2C address of the accelerometer (0x1D or 0x53)" } ], + "enums": [], "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "calibrate", - "returnType": "None", - "tooltip": "Initialize the IMU.\n\nPerform gyro offset calibration by collecting data for a number of seconds\nand computing the center value. The center value is subtracted from\nsubsequent measurements.\n\nIt's important to make sure that the robot is not moving while the\ncentering calculations are in progress, this is typically done when the\nrobot is first turned on while it's sitting at rest before the match\nstarts.\n\nThe calibration routine can be triggered by the user during runtime." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" + "type": "wpilib.ADXL345_I2C" }, { "defaultValue": "", - "name": "new_cal_time", - "type": "wpilib.ADIS16448_IMU.CalibrationTime" + "name": "axis", + "type": "wpilib.ADXL345_I2C.Axes" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "configCalTime", - "returnType": "int", - "tooltip": "Configures the calibration time used for the next calibrate.\n\n:param new_cal_time: The calibration time that should be used" + "declaringClassName": "wpilib.ADXL345_I2C", + "functionName": "getAcceleration", + "returnType": "float", + "tooltip": "Get the acceleration of one axis in Gs.\n\n:param axis: The axis to read from.\n\n:returns: Acceleration of the ADXL345 in Gs." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" - }, - { - "defaultValue": "", - "name": "decimationRate", - "type": "int" + "type": "wpilib.ADXL345_I2C" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "configDecRate", - "returnType": "int", - "tooltip": "Configures the decimation rate of the IMU.\n\n:param decimationRate: The new decimation value.\n\n:returns: 0 if success, 1 if no change, 2 if error." + "declaringClassName": "wpilib.ADXL345_I2C", + "functionName": "getAccelerations", + "returnType": "wpilib.ADXL345_I2C.AllAxes", + "tooltip": "Get the acceleration of all axes in Gs.\n\n:returns: An object containing the acceleration measured on each axis of the\n ADXL345 in Gs." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" + "type": "wpilib.ADXL345_I2C" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getAccelX", - "returnType": "wpimath.units.meters_per_second_squared", - "tooltip": "Returns the acceleration in the X axis." + "declaringClassName": "wpilib.ADXL345_I2C", + "functionName": "getI2CDeviceAddress", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" + "type": "wpilib.ADXL345_I2C" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getAccelY", - "returnType": "wpimath.units.meters_per_second_squared", - "tooltip": "Returns the acceleration in the Y axis." + "declaringClassName": "wpilib.ADXL345_I2C", + "functionName": "getI2CPort", + "returnType": "wpilib.I2C.Port", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" + "type": "wpilib.ADXL345_I2C" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getAccelZ", - "returnType": "wpimath.units.meters_per_second_squared", - "tooltip": "Returns the acceleration in the Z axis." + "declaringClassName": "wpilib.ADXL345_I2C", + "functionName": "getX", + "returnType": "float", + "tooltip": "Returns the acceleration along the X axis in g-forces.\n\n:returns: The acceleration along the X axis in g-forces." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" + "type": "wpilib.ADXL345_I2C" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getAngle", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the yaw axis angle in degrees (CCW positive)." + "declaringClassName": "wpilib.ADXL345_I2C", + "functionName": "getY", + "returnType": "float", + "tooltip": "Returns the acceleration along the Y axis in g-forces.\n\n:returns: The acceleration along the Y axis in g-forces." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" + "type": "wpilib.ADXL345_I2C" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getBarometricPressure", - "returnType": "wpimath.units.pounds_per_square_inch", - "tooltip": "Returns the barometric pressure." + "declaringClassName": "wpilib.ADXL345_I2C", + "functionName": "getZ", + "returnType": "float", + "tooltip": "Returns the acceleration along the Z axis in g-forces.\n\n:returns: The acceleration along the Z axis in g-forces." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getGyroAngleX", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the accumulated gyro angle in the X axis." - }, - { - "args": [ + "type": "wpilib.ADXL345_I2C" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" + "name": "builder", + "type": "ntcore.NTSendableBuilder" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getGyroAngleY", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the accumulated gyro angle in the Y axis." + "declaringClassName": "wpilib.ADXL345_I2C", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getGyroAngleZ", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the accumulated gyro angle in the Z axis." - }, - { - "args": [ + "type": "wpilib.ADXL345_I2C" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" + "name": "range", + "type": "wpilib.ADXL345_I2C.Range" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getGyroRateX", - "returnType": "wpimath.units.degrees_per_second", - "tooltip": "Returns the angular rate in the X axis." + "declaringClassName": "wpilib.ADXL345_I2C", + "functionName": "setRange", + "returnType": "None", + "tooltip": "Set the measuring range of the accelerometer.\n\n:param range: The maximum acceleration, positive or negative, that the\n accelerometer will measure." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.ADXL345_I2C.AllAxes", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.ADXL345_I2C.AllAxes", + "functionName": "__init__", + "returnType": "wpilib.ADXL345_I2C.AllAxes", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "XAxis", + "tooltip": "Acceleration along the X axis in g-forces.", + "type": "float", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getGyroRateY", - "returnType": "wpimath.units.degrees_per_second", - "tooltip": "Returns the angular rate in the Y axis." + "name": "YAxis", + "tooltip": "Acceleration along the Y axis in g-forces.", + "type": "float", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getGyroRateZ", - "returnType": "wpimath.units.degrees_per_second", - "tooltip": "Returns the angular rate in the Z axis." + "name": "ZAxis", + "tooltip": "Acceleration along the Z axis in g-forces.", + "type": "float", + "writable": true + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.ADXL345_I2C.Axes", + "classVariables": [ + { + "name": "kAxis_X", + "tooltip": "", + "type": "wpilib.ADXL345_I2C.Axes", + "writable": false + }, + { + "name": "kAxis_Y", + "tooltip": "", + "type": "wpilib.ADXL345_I2C.Axes", + "writable": false }, + { + "name": "kAxis_Z", + "tooltip": "", + "type": "wpilib.ADXL345_I2C.Axes", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getMagneticFieldX", - "returnType": "wpimath.units.teslas", - "tooltip": "Returns the magnetic field strength in the X axis." + "declaringClassName": "wpilib.ADXL345_I2C.Axes", + "functionName": "__init__", + "returnType": "wpilib.ADXL345_I2C.Axes", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.ADXL345_I2C.Range", + "classVariables": [ + { + "name": "kRange_16G", + "tooltip": "", + "type": "wpilib.ADXL345_I2C.Range", + "writable": false + }, + { + "name": "kRange_2G", + "tooltip": "", + "type": "wpilib.ADXL345_I2C.Range", + "writable": false + }, + { + "name": "kRange_4G", + "tooltip": "", + "type": "wpilib.ADXL345_I2C.Range", + "writable": false }, + { + "name": "kRange_8G", + "tooltip": "", + "type": "wpilib.ADXL345_I2C.Range", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getMagneticFieldY", - "returnType": "wpimath.units.teslas", - "tooltip": "Returns the magnetic field strength in the Y axis." + "declaringClassName": "wpilib.ADXL345_I2C.Range", + "functionName": "__init__", + "returnType": "wpilib.ADXL345_I2C.Range", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.AddressableLED", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getMagneticFieldZ", - "returnType": "wpimath.units.teslas", - "tooltip": "Returns the magnetic field strength in the Z axis." - }, + "declaringClassName": "wpilib.AddressableLED", + "functionName": "__init__", + "returnType": "wpilib.AddressableLED", + "tooltip": "Constructs a new driver for a specific channel.\n\n:param channel: the output channel to use" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" + "type": "wpilib.AddressableLED" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getPort", + "declaringClassName": "wpilib.AddressableLED", + "functionName": "getChannel", "returnType": "int", - "tooltip": "Get the SPI port number.\n\n:returns: The SPI port number." + "tooltip": "Gets the channel for this addressable LED.\n\n:returns: channel" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" + "type": "wpilib.AddressableLED" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getRate", - "returnType": "wpimath.units.degrees_per_second", - "tooltip": "Returns the yaw axis angular rate in degrees per second (CCW positive)." + "declaringClassName": "wpilib.AddressableLED", + "functionName": "getStart", + "returnType": "int", + "tooltip": "Gets the display start of the LED strip in the global buffer.\n\n:returns: the strip start, in LEDs" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getTemperature", - "returnType": "wpimath.units.celsius", - "tooltip": "Returns the temperature." - }, - { - "args": [ + "type": "wpilib.AddressableLED" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" + "name": "order", + "type": "wpilib.AddressableLED.ColorOrder" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getXComplementaryAngle", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the complementary angle around the X axis computed from\naccelerometer and gyro rate measurements." + "declaringClassName": "wpilib.AddressableLED", + "functionName": "setColorOrder", + "returnType": "None", + "tooltip": "Sets the color order for this AddressableLED. The default order is GRB.\n\nThis will take effect on the next call to SetData().\n\n:param order: the color order" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getXFilteredAccelAngle", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the X-axis filtered acceleration angle." - }, - { - "args": [ + "type": "wpilib.AddressableLED" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" + "name": "ledData", + "type": "List[wpilib.AddressableLED.LEDData]" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getYComplementaryAngle", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the complementary angle around the Y axis computed from\naccelerometer and gyro rate measurements." + "declaringClassName": "wpilib.AddressableLED", + "functionName": "setData", + "returnType": "None", + "tooltip": "Sets the LED output data. This will write to the global buffer starting at\nthe location set by SetStart() and up to the length set by SetLength().\n\n:param ledData: the buffer to write" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getYFilteredAccelAngle", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the Y-axis filtered acceleration angle." - }, - { - "args": [ + "type": "wpilib.AddressableLED" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" + "name": "length", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "getYawAxis", - "returnType": "wpilib.ADIS16448_IMU.IMUAxis", - "tooltip": "" + "declaringClassName": "wpilib.AddressableLED", + "functionName": "setLength", + "returnType": "None", + "tooltip": "Sets the length of the LED strip.\n\n:param length: the strip length, in LEDs" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16448_IMU" + "type": "wpilib.AddressableLED" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "start", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "initSendable", + "declaringClassName": "wpilib.AddressableLED", + "functionName": "setStart", "returnType": "None", - "tooltip": "" - }, + "tooltip": "Sets the display start of the LED strip in the global buffer.\n\n:param start: the strip start, in LEDs" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "isConnected", - "returnType": "bool", - "tooltip": "Checks the connection status of the IMU.\n\n:returns: True if the IMU is connected, false otherwise." - }, - { - "args": [ + "name": "start", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" + "name": "colorOrder", + "type": "wpilib.AddressableLED.ColorOrder" + }, + { + "defaultValue": "", + "name": "ledData", + "type": "List[wpilib.AddressableLED.LEDData]" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "reset", + "declaringClassName": "wpilib.AddressableLED", + "functionName": "setGlobalData", "returnType": "None", - "tooltip": "Reset the gyro.\n\nResets the gyro accumulations to a heading of zero. This can be used if\nthere is significant drift in the gyro and it needs to be recalibrated\nafter running." + "tooltip": "Sets the LED output data at an arbitrary location in the global buffer.\n\n:param start: the start location, in LEDs\n:param colorOrder: the color order\n:param ledData: the buffer to write" + } + ] + }, + { + "className": "wpilib.AddressableLED.ColorOrder", + "classVariables": [ + { + "name": "kBGR", + "tooltip": "", + "type": "wpilib.AddressableLED.ColorOrder", + "writable": false + }, + { + "name": "kBRG", + "tooltip": "", + "type": "wpilib.AddressableLED.ColorOrder", + "writable": false + }, + { + "name": "kGBR", + "tooltip": "", + "type": "wpilib.AddressableLED.ColorOrder", + "writable": false + }, + { + "name": "kGRB", + "tooltip": "", + "type": "wpilib.AddressableLED.ColorOrder", + "writable": false + }, + { + "name": "kRBG", + "tooltip": "", + "type": "wpilib.AddressableLED.ColorOrder", + "writable": false }, + { + "name": "kRGB", + "tooltip": "", + "type": "wpilib.AddressableLED.ColorOrder", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16448_IMU" - }, - { - "defaultValue": "", - "name": "yaw_axis", - "type": "wpilib.ADIS16448_IMU.IMUAxis" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16448_IMU", - "functionName": "setYawAxis", - "returnType": "int", + "declaringClassName": "wpilib.AddressableLED.ColorOrder", + "functionName": "__init__", + "returnType": "wpilib.AddressableLED.ColorOrder", "tooltip": "" } ], - "instanceVariables": [], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.ADIS16470_IMU", + "className": "wpilib.AddressableLED.LEDData", "classVariables": [], "constructors": [ { "args": [], - "declaringClassName": "wpilib.ADIS16470_IMU", + "declaringClassName": "wpilib.AddressableLED.LEDData", "functionName": "__init__", - "returnType": "wpilib.ADIS16470_IMU", - "tooltip": "Creates a new ADIS16740 IMU object.\n\nThe default setup is the onboard SPI port with a calibration time of 1\nsecond. Yaw, pitch, and roll are kZ, kX, and kY respectively." + "returnType": "wpilib.AddressableLED.LEDData", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "yaw_axis", - "type": "wpilib.ADIS16470_IMU.IMUAxis" + "name": "r", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "pitch_axis", - "type": "wpilib.ADIS16470_IMU.IMUAxis" + "name": "g", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "roll_axis", - "type": "wpilib.ADIS16470_IMU.IMUAxis" + "name": "b", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", + "declaringClassName": "wpilib.AddressableLED.LEDData", "functionName": "__init__", - "returnType": "wpilib.ADIS16470_IMU", - "tooltip": "Creates a new ADIS16740 IMU object.\n\nThe default setup is the onboard SPI port with a calibration time of 1\nsecond.\n\n:strong:`:emphasis:`Input axes limited to kX, kY and kZ. Specifying kYaw, kPitch,or kRoll\nwill result in an error.``\n\n:param yaw_axis: The axis that measures the yaw\n:param pitch_axis: The axis that measures the pitch\n:param roll_axis: The axis that measures the roll" - }, + "returnType": "wpilib.AddressableLED.LEDData", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "yaw_axis", - "type": "wpilib.ADIS16470_IMU.IMUAxis" - }, - { - "defaultValue": "", - "name": "pitch_axis", - "type": "wpilib.ADIS16470_IMU.IMUAxis" + "name": "self", + "type": "wpilib.AddressableLED.LEDData" }, { "defaultValue": "", - "name": "roll_axis", - "type": "wpilib.ADIS16470_IMU.IMUAxis" + "name": "h", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "port", - "type": "wpilib.SPI.Port" + "name": "s", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "cal_time", - "type": "wpilib.ADIS16470_IMU.CalibrationTime" + "name": "v", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "__init__", - "returnType": "wpilib.ADIS16470_IMU", - "tooltip": "Creates a new ADIS16740 IMU object.\n\n:strong:`:emphasis:`Input axes limited to kX, kY and kZ. Specifying kYaw, kPitch, or\nkRoll will result in an error.``\n\n:param yaw_axis: The axis that measures the yaw\n:param pitch_axis: The axis that measures the pitch\n:param roll_axis: The axis that measures the roll\n:param port: The SPI Port the gyro is plugged into\n:param cal_time: Calibration time" - } - ], - "enums": [ - { - "enumClassName": "wpilib.ADIS16470_IMU.CalibrationTime", - "enumValues": [ - "_128ms", - "_16s", - "_1s", - "_256ms", - "_2s", - "_32ms", - "_32s", - "_4s", - "_512ms", - "_64ms", - "_64s", - "_8s" - ], - "moduleName": "wpilib", - "tooltip": "ADIS16470 calibration times.\n\nMembers:\n\n _32ms : 32 ms calibration time.\n\n _64ms : 64 ms calibration time.\n\n _128ms : 128 ms calibration time.\n\n _256ms : 256 ms calibration time.\n\n _512ms : 512 ms calibration time.\n\n _1s : 1 s calibration time.\n\n _2s : 2 s calibration time.\n\n _4s : 4 s calibration time.\n\n _8s : 8 s calibration time.\n\n _16s : 16 s calibration time.\n\n _32s : 32 s calibration time.\n\n _64s : 64 s calibration time." + "declaringClassName": "wpilib.AddressableLED.LEDData", + "functionName": "setHSV", + "returnType": "None", + "tooltip": "A helper method to set all values of the LED.\n\n:param h: the h value [0-180]\n:param s: the s value [0-255]\n:param v: the v value [0-255]" }, - { - "enumClassName": "wpilib.ADIS16470_IMU.IMUAxis", - "enumValues": [ - "kPitch", - "kRoll", - "kX", - "kY", - "kYaw", - "kZ" - ], - "moduleName": "wpilib", - "tooltip": "IMU axes.\n\nkX, kY, and kZ refer to the IMU's X, Y, and Z axes respectively. kYaw,\nkPitch, and kRoll are configured by the user to refer to an X, Y, or Z\naxis.\n\nMembers:\n\n kX : The IMU's X axis.\n\n kY : The IMU's Y axis.\n\n kZ : The IMU's Z axis.\n\n kYaw : The user-configured yaw axis.\n\n kPitch : The user-configured pitch axis.\n\n kRoll : The user-configured roll axis." - } - ], - "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.AddressableLED.LEDData" + }, + { + "defaultValue": "", + "name": "color", + "type": "wpilib.Color" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "calibrate", + "declaringClassName": "wpilib.AddressableLED.LEDData", + "functionName": "setLED", "returnType": "None", - "tooltip": "Switches the active SPI port to standard SPI mode, writes the\ncommand to activate the new null configuration, and re-enables auto SPI." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.AddressableLED.LEDData" }, { "defaultValue": "", - "name": "new_cal_time", - "type": "wpilib.ADIS16470_IMU.CalibrationTime" + "name": "color", + "type": "wpilib.Color8Bit" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "configCalTime", - "returnType": "int", - "tooltip": "Configures calibration time.\n\n:param new_cal_time: New calibration time\n\n:returns: 0 if success, 1 if no change, 2 if error." + "declaringClassName": "wpilib.AddressableLED.LEDData", + "functionName": "setLED", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.AddressableLED.LEDData" }, { "defaultValue": "", - "name": "decimationRate", - "type": "int" - } - ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "configDecRate", - "returnType": "int", - "tooltip": "Configures the decimation rate of the IMU.\n\n:param decimationRate: The new decimation value.\n\n:returns: 0 if success, 1 if no change, 2 if error." - }, - { - "args": [ + "name": "r", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getAccelX", - "returnType": "wpimath.units.meters_per_second_squared", - "tooltip": "Returns the acceleration in the X axis." - }, - { - "args": [ + "name": "g", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" + "name": "b", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getAccelY", - "returnType": "wpimath.units.meters_per_second_squared", - "tooltip": "Returns the acceleration in the Y axis." + "declaringClassName": "wpilib.AddressableLED.LEDData", + "functionName": "setRGB", + "returnType": "None", + "tooltip": "A helper method to set all values of the LED.\n\n:param r: the r value [0-255]\n:param g: the g value [0-255]\n:param b: the b value [0-255]" + } + ], + "instanceVariables": [ + { + "name": "b", + "tooltip": "///< blue value", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getAccelZ", - "returnType": "wpimath.units.meters_per_second_squared", - "tooltip": "Returns the acceleration in the Z axis." + "name": "g", + "tooltip": "///< green value", + "type": "int", + "writable": true }, { - "args": [ + "name": "r", + "tooltip": "///< red value", + "type": "int", + "writable": true + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.Alert", + "classVariables": [], + "constructors": [ + { + "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" + "name": "text", + "type": "str" }, - { - "defaultValue": "", - "name": "axis", - "type": "wpilib.ADIS16470_IMU.IMUAxis" - } - ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getAngle", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the axis angle (CCW positive).\n\n:param axis: The IMUAxis whose angle to return. Defaults to user configured\n Yaw.\n\n:returns: The axis angle (CCW positive)." - }, - { - "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" + "name": "type", + "type": "wpilib.Alert.AlertType" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getPitchAxis", - "returnType": "wpilib.ADIS16470_IMU.IMUAxis", - "tooltip": "Returns which axis, kX, kY, or kZ, is set to the pitch axis.\n\n:returns: IMUAxis Pitch Axis" + "declaringClassName": "wpilib.Alert", + "functionName": "__init__", + "returnType": "wpilib.Alert", + "tooltip": "Creates a new alert in the default group - \"Alerts\". If this is the first\nto be instantiated, the appropriate entries will be added to NetworkTables.\n\n:param text: Text to be displayed when the alert is active.\n:param type: Alert urgency level." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getPort", - "returnType": "int", - "tooltip": "Gets the SPI port number.\n\n:returns: The SPI port number." - }, - { - "args": [ + "name": "group", + "type": "str" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" + "name": "text", + "type": "str" }, { - "defaultValue": "", - "name": "axis", - "type": "wpilib.ADIS16470_IMU.IMUAxis" + "defaultValue": "", + "name": "type", + "type": "wpilib.Alert.AlertType" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getRate", - "returnType": "wpimath.units.degrees_per_second", - "tooltip": "Returns the axis angular rate (CCW positive).\n\n:param axis: The IMUAxis whose rate to return. Defaults to user configured\n Yaw.\n\n:returns: Axis angular rate (CCW positive)." - }, + "declaringClassName": "wpilib.Alert", + "functionName": "__init__", + "returnType": "wpilib.Alert", + "tooltip": "Creates a new alert. If this is the first to be instantiated in its group,\nthe appropriate entries will be added to NetworkTables.\n\n:param group: Group identifier, used as the entry name in NetworkTables.\n:param text: Text to be displayed when the alert is active.\n:param type: Alert urgency level." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.Alert" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getRollAxis", - "returnType": "wpilib.ADIS16470_IMU.IMUAxis", - "tooltip": "Returns which axis, kX, kY, or kZ, is set to the roll axis.\n\n:returns: IMUAxis Roll Axis" + "declaringClassName": "wpilib.Alert", + "functionName": "close", + "returnType": "None", + "tooltip": "Disables the alert" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.Alert" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getXComplementaryAngle", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the X-axis complementary angle." + "declaringClassName": "wpilib.Alert", + "functionName": "get", + "returnType": "bool", + "tooltip": "Gets whether the alert is active.\n\n:returns: whether the alert is active." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.Alert" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getXFilteredAccelAngle", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the X-axis filtered acceleration angle." + "declaringClassName": "wpilib.Alert", + "functionName": "getText", + "returnType": "str", + "tooltip": "Gets the current alert text.\n\n:returns: the current text." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.Alert" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getYComplementaryAngle", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the Y-axis complementary angle." + "declaringClassName": "wpilib.Alert", + "functionName": "getType", + "returnType": "wpilib.Alert.AlertType", + "tooltip": "Get the type of this alert.\n\n:returns: the type" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" - } - ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getYFilteredAccelAngle", - "returnType": "wpimath.units.degrees", - "tooltip": "Returns the Y-axis filtered acceleration angle." - }, - { - "args": [ + "type": "wpilib.Alert" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" + "name": "active", + "type": "bool" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "getYawAxis", - "returnType": "wpilib.ADIS16470_IMU.IMUAxis", - "tooltip": "Returns which axis, kX, kY, or kZ, is set to the yaw axis.\n\n:returns: IMUAxis Yaw Axis" + "declaringClassName": "wpilib.Alert", + "functionName": "set", + "returnType": "None", + "tooltip": "Sets whether the alert should currently be displayed. This method can be\nsafely called periodically.\n\n:param active: Whether to display the alert." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.Alert" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "text", + "type": "str" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "initSendable", + "declaringClassName": "wpilib.Alert", + "functionName": "setText", "returnType": "None", - "tooltip": "" + "tooltip": "Updates current alert text. Use this method to dynamically change the\ndisplayed alert, such as including more details about the detected problem.\n\n:param text: Text to be displayed when the alert is active." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.Alert.AlertType", + "classVariables": [ + { + "name": "kError", + "tooltip": "", + "type": "wpilib.Alert.AlertType", + "writable": false }, + { + "name": "kInfo", + "tooltip": "", + "type": "wpilib.Alert.AlertType", + "writable": false + }, + { + "name": "kWarning", + "tooltip": "", + "type": "wpilib.Alert.AlertType", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "isConnected", - "returnType": "bool", - "tooltip": "Checks the connection status of the IMU.\n\n:returns: True if the IMU is connected, false otherwise." + "declaringClassName": "wpilib.Alert.AlertType", + "functionName": "__init__", + "returnType": "wpilib.Alert.AlertType", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.AnalogAccelerometer", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "reset", - "returnType": "None", - "tooltip": "Reset the gyro.\n\nResets the gyro accumulations to a heading of zero. This can be used if\nthere is significant drift in the gyro and it needs to be recalibrated\nafter running." + "declaringClassName": "wpilib.AnalogAccelerometer", + "functionName": "__init__", + "returnType": "wpilib.AnalogAccelerometer", + "tooltip": "Create a new instance of an accelerometer.\n\nThe constructor allocates desired analog input.\n\n:param channel: The channel number for the analog input the accelerometer is\n connected to" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADIS16470_IMU" - }, - { - "defaultValue": "", - "name": "axis", - "type": "wpilib.ADIS16470_IMU.IMUAxis" - }, + "name": "channel", + "type": "wpilib.AnalogInput" + } + ], + "declaringClassName": "wpilib.AnalogAccelerometer", + "functionName": "__init__", + "returnType": "wpilib.AnalogAccelerometer", + "tooltip": "Create a new instance of Accelerometer from an existing AnalogInput.\n\nMake a new instance of accelerometer given an AnalogInput. This is\nparticularly useful if the port is going to be read as an analog channel as\nwell as through the Accelerometer class.\n\n:param channel: The existing AnalogInput object for the analog input the\n accelerometer is connected to" + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ { "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" + "name": "self", + "type": "wpilib.AnalogAccelerometer" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "setGyroAngle", - "returnType": "None", - "tooltip": "Allow the designated gyro angle to be set to a given value. This may happen\nwith unread values in the buffer, it is suggested that the IMU is not\nmoving when this method is run.\n\n:param axis: IMUAxis that will be changed\n:param angle: The new angle (CCW positive)" + "declaringClassName": "wpilib.AnalogAccelerometer", + "functionName": "getAcceleration", + "returnType": "float", + "tooltip": "Return the acceleration in Gs.\n\nThe acceleration is returned units of Gs.\n\n:returns: The current acceleration of the sensor in Gs." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.AnalogAccelerometer" }, { "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "setGyroAngleX", + "declaringClassName": "wpilib.AnalogAccelerometer", + "functionName": "initSendable", "returnType": "None", - "tooltip": "Allow the gyro angle X to be set to a given value. This may happen with\nunread values in the buffer, it is suggested that the IMU is not moving\nwhen this method is run.\n\n:param angle: The new angle (CCW positive)" + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.AnalogAccelerometer" }, { "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" + "name": "sensitivity", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "setGyroAngleY", + "declaringClassName": "wpilib.AnalogAccelerometer", + "functionName": "setSensitivity", "returnType": "None", - "tooltip": "Allow the gyro angle Y to be set to a given value. This may happen with\nunread values in the buffer, it is suggested that the IMU is not moving\nwhen this method is run.\n\n:param angle: The new angle (CCW positive)" + "tooltip": "Set the accelerometer sensitivity.\n\nThis sets the sensitivity of the accelerometer used for calculating the\nacceleration. The sensitivity varies by accelerometer model.\n\n:param sensitivity: The sensitivity of accelerometer in Volts per G." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADIS16470_IMU" + "type": "wpilib.AnalogAccelerometer" }, { "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" + "name": "zero", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.ADIS16470_IMU", - "functionName": "setGyroAngleZ", + "declaringClassName": "wpilib.AnalogAccelerometer", + "functionName": "setZero", "returnType": "None", - "tooltip": "Allow the gyro angle Z to be set to a given value. This may happen with\nunread values in the buffer, it is suggested that the IMU is not moving\nwhen this method is run.\n\n:param angle: The new angle (CCW positive)" + "tooltip": "Set the voltage that corresponds to 0 G.\n\nThe zero G voltage varies by accelerometer model.\n\n:param zero: The zero G voltage." } ], "instanceVariables": [], @@ -1230,195 +1309,168 @@ "staticMethods": [] }, { - "className": "wpilib.ADXL345_I2C", - "classVariables": [ - { - "name": "kAddress", - "tooltip": "", - "type": "int", - "writable": false - } - ], + "className": "wpilib.AnalogEncoder", + "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "port", - "type": "wpilib.I2C.Port" - }, - { - "defaultValue": "", - "name": "range", - "type": "wpilib.ADXL345_I2C.Range" - }, - { - "defaultValue": "29", - "name": "deviceAddress", - "type": "int" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADXL345_I2C", + "declaringClassName": "wpilib.AnalogEncoder", "functionName": "__init__", - "returnType": "wpilib.ADXL345_I2C", - "tooltip": "Constructs the ADXL345 Accelerometer over I2C.\n\n:param port: The I2C port the accelerometer is attached to\n:param range: The range (+ or -) that the accelerometer will measure\n:param deviceAddress: The I2C address of the accelerometer (0x1D or 0x53)" - } - ], - "enums": [ - { - "enumClassName": "wpilib.ADXL345_I2C.Axes", - "enumValues": [ - "kAxis_X", - "kAxis_Y", - "kAxis_Z" - ], - "moduleName": "wpilib", - "tooltip": "Accelerometer axes.\n\nMembers:\n\n kAxis_X : X axis.\n\n kAxis_Y : Y axis.\n\n kAxis_Z : Z axis." + "returnType": "wpilib.AnalogEncoder", + "tooltip": "Construct a new AnalogEncoder attached to a specific AnalogIn channel.\n\nThis has a fullRange of 1 and an expectedZero of 0.\n\n:param channel: the analog input channel to attach to" }, - { - "enumClassName": "wpilib.ADXL345_I2C.Range", - "enumValues": [ - "kRange_16G", - "kRange_2G", - "kRange_4G", - "kRange_8G" - ], - "moduleName": "wpilib", - "tooltip": "Accelerometer range.\n\nMembers:\n\n kRange_2G : 2 Gs max.\n\n kRange_4G : 4 Gs max.\n\n kRange_8G : 8 Gs max.\n\n kRange_16G : 16 Gs max." - } - ], - "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADXL345_I2C" - }, - { - "defaultValue": "", - "name": "axis", - "type": "wpilib.ADXL345_I2C.Axes" + "name": "analogInput", + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.ADXL345_I2C", - "functionName": "getAcceleration", - "returnType": "float", - "tooltip": "Get the acceleration of one axis in Gs.\n\n:param axis: The axis to read from.\n\n:returns: Acceleration of the ADXL345 in Gs." + "declaringClassName": "wpilib.AnalogEncoder", + "functionName": "__init__", + "returnType": "wpilib.AnalogEncoder", + "tooltip": "Construct a new AnalogEncoder attached to a specific AnalogInput.\n\nThis has a fullRange of 1 and an expectedZero of 0.\n\n:param analogInput: the analog input to attach to" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADXL345_I2C" - } - ], - "declaringClassName": "wpilib.ADXL345_I2C", - "functionName": "getAccelerations", - "returnType": "wpilib.ADXL345_I2C.AllAxes", - "tooltip": "Get the acceleration of all axes in Gs.\n\n:returns: An object containing the acceleration measured on each axis of the\n ADXL345 in Gs." - }, - { - "args": [ + "name": "channel", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADXL345_I2C" + "name": "fullRange", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "expectedZero", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.ADXL345_I2C", - "functionName": "getI2CDeviceAddress", - "returnType": "int", - "tooltip": "" + "declaringClassName": "wpilib.AnalogEncoder", + "functionName": "__init__", + "returnType": "wpilib.AnalogEncoder", + "tooltip": "Construct a new AnalogEncoder attached to a specific AnalogIn channel.\n\n:param channel: the analog input channel to attach to\n:param fullRange: the value to report at maximum travel\n:param expectedZero: the reading where you would expect a 0 from get()" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADXL345_I2C" + "name": "analogInput", + "type": "wpilib.AnalogInput" + }, + { + "defaultValue": "", + "name": "fullRange", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "expectedZero", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.ADXL345_I2C", - "functionName": "getI2CPort", - "returnType": "wpilib.I2C.Port", - "tooltip": "" - }, + "declaringClassName": "wpilib.AnalogEncoder", + "functionName": "__init__", + "returnType": "wpilib.AnalogEncoder", + "tooltip": "Construct a new AnalogEncoder attached to a specific AnalogInput.\n\n:param analogInput: the analog input to attach to\n:param fullRange: the value to report at maximum travel\n:param expectedZero: the reading where you would expect a 0 from get()" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_I2C" + "type": "wpilib.AnalogEncoder" } ], - "declaringClassName": "wpilib.ADXL345_I2C", - "functionName": "getX", + "declaringClassName": "wpilib.AnalogEncoder", + "functionName": "get", "returnType": "float", - "tooltip": "Returns the acceleration along the X axis in g-forces.\n\n:returns: The acceleration along the X axis in g-forces." + "tooltip": "Get the encoder value.\n\n:returns: the encoder value scaled by the full range input" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_I2C" + "type": "wpilib.AnalogEncoder" } ], - "declaringClassName": "wpilib.ADXL345_I2C", - "functionName": "getY", - "returnType": "float", - "tooltip": "Returns the acceleration along the Y axis in g-forces.\n\n:returns: The acceleration along the Y axis in g-forces." + "declaringClassName": "wpilib.AnalogEncoder", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "Get the channel number.\n\n:returns: The channel number." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_I2C" + "type": "wpilib.AnalogEncoder" + }, + { + "defaultValue": "", + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.ADXL345_I2C", - "functionName": "getZ", - "returnType": "float", - "tooltip": "Returns the acceleration along the Z axis in g-forces.\n\n:returns: The acceleration along the Z axis in g-forces." + "declaringClassName": "wpilib.AnalogEncoder", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_I2C" + "type": "wpilib.AnalogEncoder" }, { "defaultValue": "", - "name": "builder", - "type": "ntcore.NTSendableBuilder" + "name": "inverted", + "type": "bool" } ], - "declaringClassName": "wpilib.ADXL345_I2C", - "functionName": "initSendable", + "declaringClassName": "wpilib.AnalogEncoder", + "functionName": "setInverted", "returnType": "None", - "tooltip": "" + "tooltip": "Set if this encoder is inverted.\n\n:param inverted: true to invert the encoder, false otherwise" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_I2C" + "type": "wpilib.AnalogEncoder" }, { "defaultValue": "", - "name": "range", - "type": "wpilib.ADXL345_I2C.Range" + "name": "min", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "max", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.ADXL345_I2C", - "functionName": "setRange", + "declaringClassName": "wpilib.AnalogEncoder", + "functionName": "setVoltagePercentageRange", "returnType": "None", - "tooltip": "Set the measuring range of the accelerometer.\n\n:param range: The maximum acceleration, positive or negative, that the\n accelerometer will measure." + "tooltip": "Set the encoder voltage percentage range. Analog sensors are not always\nfully stable at the end of their travel ranges. Shrinking this range down\ncan help mitigate issues with that.\n\n:param min: minimum voltage percentage (0-1 range)\n:param max: maximum voltage percentage (0-1 range)" } ], "instanceVariables": [], @@ -1426,427 +1478,254 @@ "staticMethods": [] }, { - "className": "wpilib.ADXL345_I2C.AllAxes", + "className": "wpilib.AnalogGyro", "classVariables": [], "constructors": [ { - "args": [], - "declaringClassName": "wpilib.ADXL345_I2C.AllAxes", + "args": [ + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.AnalogGyro", "functionName": "__init__", - "returnType": "wpilib.ADXL345_I2C.AllAxes", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [ - { - "name": "XAxis", - "tooltip": "Acceleration along the X axis in g-forces.", - "type": "float", - "writable": true + "returnType": "wpilib.AnalogGyro", + "tooltip": "%Gyro constructor using the Analog Input channel number.\n\n:param channel: The analog channel the gyro is connected to. Gyros can only\n be used on on-board Analog Inputs 0-1." }, { - "name": "YAxis", - "tooltip": "Acceleration along the Y axis in g-forces.", - "type": "float", - "writable": true + "args": [ + { + "defaultValue": "", + "name": "channel", + "type": "wpilib.AnalogInput" + } + ], + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "__init__", + "returnType": "wpilib.AnalogGyro", + "tooltip": "%Gyro constructor with a precreated AnalogInput object.\n\nUse this constructor when the analog channel needs to be shared.\nThis object will not clean up the AnalogInput object when using this\nconstructor.\n\n:param channel: A pointer to the AnalogInput object that the gyro is\n connected to." }, - { - "name": "ZAxis", - "tooltip": "Acceleration along the Z axis in g-forces.", - "type": "float", - "writable": true - } - ], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.ADXL345_SPI", - "classVariables": [], - "constructors": [ { "args": [ { "defaultValue": "", - "name": "port", - "type": "wpilib.SPI.Port" + "name": "channel", + "type": "typing.SupportsInt" }, { - "defaultValue": "", - "name": "range", - "type": "wpilib.ADXL345_SPI.Range" + "defaultValue": "", + "name": "center", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "offset", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.ADXL345_SPI", + "declaringClassName": "wpilib.AnalogGyro", "functionName": "__init__", - "returnType": "wpilib.ADXL345_SPI", - "tooltip": "Constructor.\n\n:param port: The SPI port the accelerometer is attached to\n:param range: The range (+ or -) that the accelerometer will measure" - } - ], - "enums": [ - { - "enumClassName": "wpilib.ADXL345_SPI.Axes", - "enumValues": [ - "kAxis_X", - "kAxis_Y", - "kAxis_Z" - ], - "moduleName": "wpilib", - "tooltip": "Accelerometer axes.\n\nMembers:\n\n kAxis_X : X axis.\n\n kAxis_Y : Y axis.\n\n kAxis_Z : Z axis." + "returnType": "wpilib.AnalogGyro", + "tooltip": "%Gyro constructor using the Analog Input channel number with parameters for\npresetting the center and offset values. Bypasses calibration.\n\n:param channel: The analog channel the gyro is connected to. Gyros can only\n be used on on-board Analog Inputs 0-1.\n:param center: Preset uncalibrated value to use as the accumulator center\n value.\n:param offset: Preset uncalibrated value to use as the gyro offset." }, - { - "enumClassName": "wpilib.ADXL345_SPI.Range", - "enumValues": [ - "kRange_16G", - "kRange_2G", - "kRange_4G", - "kRange_8G" - ], - "moduleName": "wpilib", - "tooltip": "Accelerometer range.\n\nMembers:\n\n kRange_2G : 2 Gs max.\n\n kRange_4G : 4 Gs max.\n\n kRange_8G : 8 Gs max.\n\n kRange_16G : 16 Gs max." - } - ], - "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.ADXL345_SPI" + "name": "channel", + "type": "wpilib.AnalogInput" }, { "defaultValue": "", - "name": "axis", - "type": "wpilib.ADXL345_SPI.Axes" + "name": "center", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "offset", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.ADXL345_SPI", - "functionName": "getAcceleration", - "returnType": "float", - "tooltip": "Get the acceleration of one axis in Gs.\n\n:param axis: The axis to read from.\n\n:returns: Acceleration of the ADXL345 in Gs." - }, + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "__init__", + "returnType": "wpilib.AnalogGyro", + "tooltip": "%Gyro constructor with a precreated AnalogInput object and calibrated\nparameters.\n\nUse this constructor when the analog channel needs to be shared.\nThis object will not clean up the AnalogInput object when using this\nconstructor.\n\n:param channel: A pointer to the AnalogInput object that the gyro is\n connected to.\n:param center: Preset uncalibrated value to use as the accumulator center\n value.\n:param offset: Preset uncalibrated value to use as the gyro offset." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_SPI" + "type": "wpilib.AnalogGyro" } ], - "declaringClassName": "wpilib.ADXL345_SPI", - "functionName": "getAccelerations", - "returnType": "wpilib.ADXL345_SPI.AllAxes", - "tooltip": "Get the acceleration of all axes in Gs.\n\n:returns: An object containing the acceleration measured on each axis of the\n ADXL345 in Gs." + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "calibrate", + "returnType": "None", + "tooltip": "Calibrate the gyro by running for a number of samples and computing the\ncenter value. Then use the center value as the Accumulator center value for\nsubsequent measurements.\n\nIt's important to make sure that the robot is not moving while the\ncentering calculations are in progress, this is typically done when the\nrobot is first turned on while it's sitting at rest before the competition\nstarts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_SPI" + "type": "wpilib.AnalogGyro" } ], - "declaringClassName": "wpilib.ADXL345_SPI", - "functionName": "getSpiPort", - "returnType": "wpilib.SPI.Port", - "tooltip": "" + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "getAnalogInput", + "returnType": "wpilib.AnalogInput", + "tooltip": "Gets the analog input for the gyro.\n\n:returns: AnalogInput" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_SPI" + "type": "wpilib.AnalogGyro" } ], - "declaringClassName": "wpilib.ADXL345_SPI", - "functionName": "getX", + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "getAngle", "returnType": "float", - "tooltip": "Returns the acceleration along the X axis in g-forces.\n\n:returns: The acceleration along the X axis in g-forces." + "tooltip": "Return the actual angle in degrees that the robot is currently facing.\n\nThe angle is based on the current accumulator value corrected by the\noversampling rate, the gyro type and the A/D calibration values. The angle\nis continuous, that is it will continue from 360->361 degrees. This allows\nalgorithms that wouldn't want to see a discontinuity in the gyro output as\nit sweeps from 360 to 0 on the second time around.\n\n:returns: The current heading of the robot in degrees. This heading is based\n on integration of the returned rate from the gyro." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_SPI" + "type": "wpilib.AnalogGyro" } ], - "declaringClassName": "wpilib.ADXL345_SPI", - "functionName": "getY", - "returnType": "float", - "tooltip": "Returns the acceleration along the Y axis in g-forces.\n\n:returns: The acceleration along the Y axis in g-forces." + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "getCenter", + "returnType": "int", + "tooltip": "Return the gyro center value. If run after calibration,\nthe center value can be used as a preset later.\n\n:returns: the current center value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_SPI" + "type": "wpilib.AnalogGyro" } ], - "declaringClassName": "wpilib.ADXL345_SPI", - "functionName": "getZ", + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "getOffset", "returnType": "float", - "tooltip": "Returns the acceleration along the Z axis in g-forces.\n\n:returns: The acceleration along the Z axis in g-forces." + "tooltip": "Return the gyro offset value. If run after calibration,\nthe offset value can be used as a preset later.\n\n:returns: the current offset value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL345_SPI" - }, - { - "defaultValue": "", - "name": "builder", - "type": "ntcore.NTSendableBuilder" - } - ], - "declaringClassName": "wpilib.ADXL345_SPI", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.ADXL345_SPI" - }, - { - "defaultValue": "", - "name": "range", - "type": "wpilib.ADXL345_SPI.Range" - } - ], - "declaringClassName": "wpilib.ADXL345_SPI", - "functionName": "setRange", - "returnType": "None", - "tooltip": "Set the measuring range of the accelerometer.\n\n:param range: The maximum acceleration, positive or negative, that the\n accelerometer will measure." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.ADXL345_SPI.AllAxes", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.ADXL345_SPI.AllAxes", - "functionName": "__init__", - "returnType": "wpilib.ADXL345_SPI.AllAxes", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [ - { - "name": "XAxis", - "tooltip": "Acceleration along the X axis in g-forces.", - "type": "float", - "writable": true - }, - { - "name": "YAxis", - "tooltip": "Acceleration along the Y axis in g-forces.", - "type": "float", - "writable": true - }, - { - "name": "ZAxis", - "tooltip": "Acceleration along the Z axis in g-forces.", - "type": "float", - "writable": true - } - ], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.ADXL362", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "range", - "type": "wpilib.ADXL362.Range" - } - ], - "declaringClassName": "wpilib.ADXL362", - "functionName": "__init__", - "returnType": "wpilib.ADXL362", - "tooltip": "Constructor. Uses the onboard CS1.\n\n:param range: The range (+ or -) that the accelerometer will measure." - }, - { - "args": [ - { - "defaultValue": "", - "name": "port", - "type": "wpilib.SPI.Port" - }, - { - "defaultValue": "", - "name": "range", - "type": "wpilib.ADXL362.Range" - } - ], - "declaringClassName": "wpilib.ADXL362", - "functionName": "__init__", - "returnType": "wpilib.ADXL362", - "tooltip": "Constructor.\n\n:param port: The SPI port the accelerometer is attached to\n:param range: The range (+ or -) that the accelerometer will measure." - } - ], - "enums": [ - { - "enumClassName": "wpilib.ADXL362.Axes", - "enumValues": [ - "kAxis_X", - "kAxis_Y", - "kAxis_Z" - ], - "moduleName": "wpilib", - "tooltip": "Accelerometer axes.\n\nMembers:\n\n kAxis_X : X axis.\n\n kAxis_Y : Y axis.\n\n kAxis_Z : Z axis." - }, - { - "enumClassName": "wpilib.ADXL362.Range", - "enumValues": [ - "kRange_2G", - "kRange_4G", - "kRange_8G" - ], - "moduleName": "wpilib", - "tooltip": "Accelerometer range.\n\nMembers:\n\n kRange_2G : 2 Gs max.\n\n kRange_4G : 4 Gs max.\n\n kRange_8G : 8 Gs max." - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.ADXL362" - }, - { - "defaultValue": "", - "name": "axis", - "type": "wpilib.ADXL362.Axes" + "type": "wpilib.AnalogGyro" } ], - "declaringClassName": "wpilib.ADXL362", - "functionName": "getAcceleration", + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "getRate", "returnType": "float", - "tooltip": "Get the acceleration of one axis in Gs.\n\n:param axis: The axis to read from.\n\n:returns: Acceleration of the ADXL362 in Gs." + "tooltip": "Return the rate of rotation of the gyro\n\nThe rate is based on the most recent reading of the gyro analog value\n\n:returns: the current rate in degrees per second" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL362" + "type": "wpilib.AnalogGyro" } ], - "declaringClassName": "wpilib.ADXL362", - "functionName": "getAccelerations", - "returnType": "wpilib.ADXL362.AllAxes", - "tooltip": "Get the acceleration of all axes in Gs.\n\n:returns: An object containing the acceleration measured on each axis of the\n ADXL362 in Gs." + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "getRotation2d", + "returnType": "wpimath.geometry.Rotation2d", + "tooltip": "Return the heading of the robot as a Rotation2d.\n\nThe angle is continuous, that is it will continue from 360 to 361 degrees.\nThis allows algorithms that wouldn't want to see a discontinuity in the\ngyro output as it sweeps past from 360 to 0 on the second time around.\n\nThe angle is expected to increase as the gyro turns counterclockwise when\nlooked at from the top. It needs to follow the NWU axis convention.\n\n:returns: the current heading of the robot as a Rotation2d. This heading is\n based on integration of the returned rate from the gyro." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL362" + "type": "wpilib.AnalogGyro" } ], - "declaringClassName": "wpilib.ADXL362", - "functionName": "getSpiPort", - "returnType": "wpilib.SPI.Port", - "tooltip": "" + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "initGyro", + "returnType": "None", + "tooltip": "Initialize the gyro.\n\nCalibration is handled by Calibrate()." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL362" - } - ], - "declaringClassName": "wpilib.ADXL362", - "functionName": "getX", - "returnType": "float", - "tooltip": "Returns the acceleration along the X axis in g-forces.\n\n:returns: The acceleration along the X axis in g-forces." - }, - { - "args": [ + "type": "wpilib.AnalogGyro" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.ADXL362" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.ADXL362", - "functionName": "getY", - "returnType": "float", - "tooltip": "Returns the acceleration along the Y axis in g-forces.\n\n:returns: The acceleration along the Y axis in g-forces." + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL362" + "type": "wpilib.AnalogGyro" } ], - "declaringClassName": "wpilib.ADXL362", - "functionName": "getZ", - "returnType": "float", - "tooltip": "Returns the acceleration along the Z axis in g-forces.\n\n:returns: The acceleration along the Z axis in g-forces." + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "reset", + "returnType": "None", + "tooltip": "Reset the gyro.\n\nResets the gyro to a heading of zero. This can be used if there is\nsignificant drift in the gyro and it needs to be recalibrated after it has\nbeen running." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL362" + "type": "wpilib.AnalogGyro" }, { "defaultValue": "", - "name": "builder", - "type": "ntcore.NTSendableBuilder" + "name": "volts", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.ADXL362", - "functionName": "initSendable", + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "setDeadband", "returnType": "None", - "tooltip": "" + "tooltip": "Set the size of the neutral zone.\n\nAny voltage from the gyro less than this amount from the center is\nconsidered stationary. Setting a deadband will decrease the amount of\ndrift when the gyro isn't rotating, but will make it less accurate.\n\n:param volts: The size of the deadband in volts" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXL362" + "type": "wpilib.AnalogGyro" }, { "defaultValue": "", - "name": "range", - "type": "wpilib.ADXL362.Range" + "name": "voltsPerDegreePerSecond", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.ADXL362", - "functionName": "setRange", + "declaringClassName": "wpilib.AnalogGyro", + "functionName": "setSensitivity", "returnType": "None", - "tooltip": "Set the measuring range of the accelerometer.\n\n:param range: The maximum acceleration, positive or negative, that the\n accelerometer will measure." + "tooltip": "Set the gyro sensitivity.\n\nThis takes the number of volts/degree/second sensitivity of the gyro and\nuses it in subsequent calculations to allow the code to work with multiple\ngyros. This value is typically found in the gyro datasheet.\n\n:param voltsPerDegreePerSecond: The sensitivity in Volts/degree/second" } ], "instanceVariables": [], @@ -1854,65 +1733,21 @@ "staticMethods": [] }, { - "className": "wpilib.ADXL362.AllAxes", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.ADXL362.AllAxes", - "functionName": "__init__", - "returnType": "wpilib.ADXL362.AllAxes", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [ - { - "name": "XAxis", - "tooltip": "Acceleration along the X axis in g-forces.", - "type": "float", - "writable": true - }, - { - "name": "YAxis", - "tooltip": "Acceleration along the Y axis in g-forces.", - "type": "float", - "writable": true - }, - { - "name": "ZAxis", - "tooltip": "Acceleration along the Z axis in g-forces.", - "type": "float", - "writable": true - } - ], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.ADXRS450_Gyro", + "className": "wpilib.AnalogInput", "classVariables": [], "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.ADXRS450_Gyro", - "functionName": "__init__", - "returnType": "wpilib.ADXRS450_Gyro", - "tooltip": "%Gyro constructor on onboard CS0." - }, { "args": [ { "defaultValue": "", - "name": "port", - "type": "wpilib.SPI.Port" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.ADXRS450_Gyro", + "declaringClassName": "wpilib.AnalogInput", "functionName": "__init__", - "returnType": "wpilib.ADXRS450_Gyro", - "tooltip": "%Gyro constructor on the specified SPI port.\n\n:param port: The SPI port the gyro is attached to." + "returnType": "wpilib.AnalogInput", + "tooltip": "Construct an analog input.\n\n:param channel: The channel number on the roboRIO to represent. 0-3 are\n on-board 4-7 are on the MXP port." } ], "enums": [], @@ -1922,286 +1757,265 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXRS450_Gyro" + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.ADXRS450_Gyro", - "functionName": "calibrate", - "returnType": "None", - "tooltip": "Calibrate the gyro by running for a number of samples and computing the\ncenter value. Then use the center value as the Accumulator center value for\nsubsequent measurements.\n\nIt's important to make sure that the robot is not moving while the\ncentering calculations are in progress, this is typically done when the\nrobot is first turned on while it's sitting at rest before the competition\nstarts." + "declaringClassName": "wpilib.AnalogInput", + "functionName": "getAverageBits", + "returnType": "int", + "tooltip": "Get the number of averaging bits previously configured.\n\nThis gets the number of averaging bits from the FPGA. The actual number of\naveraged samples is 2^bits. The averaging is done automatically in the\nFPGA.\n\n:returns: Number of bits of averaging previously configured." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXRS450_Gyro" + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.ADXRS450_Gyro", - "functionName": "getAngle", - "returnType": "float", - "tooltip": "Return the actual angle in degrees that the robot is currently facing.\n\nThe angle is based on integration of the returned rate from the gyro.\nThe angle is continuous, that is it will continue from 360->361 degrees.\nThis allows algorithms that wouldn't want to see a discontinuity in the\ngyro output as it sweeps from 360 to 0 on the second time around.\n\n:returns: the current heading of the robot in degrees." + "declaringClassName": "wpilib.AnalogInput", + "functionName": "getAverageValue", + "returnType": "int", + "tooltip": "Get a sample from the output of the oversample and average engine for this\nchannel.\n\nThe sample is 12-bit + the bits configured in SetOversampleBits().\nThe value configured in SetAverageBits() will cause this value to be\naveraged 2**bits number of samples.\n\nThis is not a sliding window. The sample will not change until\n2**(OversampleBits + AverageBits) samples have been acquired from the\nmodule on this channel.\n\nUse GetAverageVoltage() to get the analog value in calibrated units.\n\n:returns: A sample from the oversample and average engine for this channel." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXRS450_Gyro" + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.ADXRS450_Gyro", - "functionName": "getPort", - "returnType": "int", - "tooltip": "Get the SPI port number.\n\n:returns: The SPI port number." + "declaringClassName": "wpilib.AnalogInput", + "functionName": "getAverageVoltage", + "returnType": "float", + "tooltip": "Get a scaled sample from the output of the oversample and average engine\nfor this channel.\n\nThe value is scaled to units of Volts using the calibrated scaling data\nfrom GetLSBWeight() and GetOffset().\n\nUsing oversampling will cause this value to be higher resolution, but it\nwill update more slowly.\n\nUsing averaging will cause this value to be more stable, but it will update\nmore slowly.\n\n:returns: A scaled sample from the output of the oversample and average\n engine for this channel." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXRS450_Gyro" + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.ADXRS450_Gyro", - "functionName": "getRate", - "returnType": "float", - "tooltip": "Return the rate of rotation of the gyro\n\nThe rate is based on the most recent reading of the gyro.\n\n:returns: the current rate in degrees per second" + "declaringClassName": "wpilib.AnalogInput", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "Get the channel number.\n\n:returns: The channel number." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXRS450_Gyro" + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.ADXRS450_Gyro", - "functionName": "getRotation2d", - "returnType": "wpimath.geometry.Rotation2d", - "tooltip": "Return the heading of the robot as a Rotation2d.\n\nThe angle is continuous, that is it will continue from 360 to 361 degrees.\nThis allows algorithms that wouldn't want to see a discontinuity in the\ngyro output as it sweeps past from 360 to 0 on the second time around.\n\nThe angle is expected to increase as the gyro turns counterclockwise when\nlooked at from the top. It needs to follow the NWU axis convention.\n\n:returns: the current heading of the robot as a Rotation2d. This heading is\n based on integration of the returned rate from the gyro." + "declaringClassName": "wpilib.AnalogInput", + "functionName": "getLSBWeight", + "returnType": "int", + "tooltip": "Get the factory scaling least significant bit weight constant.\n\nVolts = ((LSB_Weight * 1e-9) * raw) - (Offset * 1e-9)\n\n:returns: Least significant bit weight." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXRS450_Gyro" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.ADXRS450_Gyro", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.AnalogInput", + "functionName": "getOffset", + "returnType": "int", + "tooltip": "Get the factory scaling offset constant.\n\nVolts = ((LSB_Weight * 1e-9) * raw) - (Offset * 1e-9)\n\n:returns: Offset constant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXRS450_Gyro" + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.ADXRS450_Gyro", - "functionName": "isConnected", - "returnType": "bool", - "tooltip": "" + "declaringClassName": "wpilib.AnalogInput", + "functionName": "getOversampleBits", + "returnType": "int", + "tooltip": "Get the number of oversample bits previously configured.\n\nThis gets the number of oversample bits from the FPGA. The actual number of\noversampled values is 2^bits. The oversampling is done automatically in the\nFPGA.\n\n:returns: Number of bits of oversampling previously configured." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.ADXRS450_Gyro" + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.ADXRS450_Gyro", - "functionName": "reset", - "returnType": "None", - "tooltip": "Reset the gyro.\n\nResets the gyro to a heading of zero. This can be used if there is\nsignificant drift in the gyro and it needs to be recalibrated after it has\nbeen running." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.AddressableLED", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.AnalogInput", + "functionName": "getValue", + "returnType": "int", + "tooltip": "Get a sample straight from this channel.\n\nThe sample is a 12-bit value representing the 0V to 3.3V range of the A/D\nconverter in the module. The units are in A/D converter codes. Use\nGetVoltage() to get the analog value in calibrated units.\n\n:returns: A sample straight from this channel." + }, { "args": [ { "defaultValue": "", - "name": "port", - "type": "int" + "name": "self", + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.AddressableLED", - "functionName": "__init__", - "returnType": "wpilib.AddressableLED", - "tooltip": "Constructs a new driver for a specific port.\n\n:param port: the output port to use (Must be a PWM header)" - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.AnalogInput", + "functionName": "getVoltage", + "returnType": "float", + "tooltip": "Get a scaled sample straight from this channel.\n\nThe value is scaled to units of Volts using the calibrated scaling data\nfrom GetLSBWeight() and GetOffset().\n\n:returns: A scaled sample straight from this channel." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.AddressableLED" - }, - { - "defaultValue": "", - "name": "highTime0", - "type": "wpimath.units.nanoseconds" - }, - { - "defaultValue": "", - "name": "lowTime0", - "type": "wpimath.units.nanoseconds" - }, - { - "defaultValue": "", - "name": "highTime1", - "type": "wpimath.units.nanoseconds" + "type": "wpilib.AnalogInput" }, { "defaultValue": "", - "name": "lowTime1", - "type": "wpimath.units.nanoseconds" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.AddressableLED", - "functionName": "setBitTiming", + "declaringClassName": "wpilib.AnalogInput", + "functionName": "initSendable", "returnType": "None", - "tooltip": "Sets the bit timing.\n\nBy default, the driver is set up to drive WS2812Bs, so nothing needs to\nbe set for those.\n\n:param highTime0: high time for 0 bit (default 400ns)\n:param lowTime0: low time for 0 bit (default 900ns)\n:param highTime1: high time for 1 bit (default 900ns)\n:param lowTime1: low time for 1 bit (default 600ns)" + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.AddressableLED" + "type": "wpilib.AnalogInput" }, { "defaultValue": "", - "name": "ledData", - "type": "List[wpilib.AddressableLED.LEDData]" + "name": "bits", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.AddressableLED", - "functionName": "setData", + "declaringClassName": "wpilib.AnalogInput", + "functionName": "setAverageBits", "returnType": "None", - "tooltip": "Sets the led output data.\n\nIf the output is enabled, this will start writing the next data cycle.\nIt is safe to call, even while output is enabled.\n\n:param ledData: the buffer to write" + "tooltip": "Set the number of averaging bits.\n\nThis sets the number of averaging bits. The actual number of averaged\nsamples is 2^bits.\n\nUse averaging to improve the stability of your measurement at the expense\nof sampling rate. The averaging is done automatically in the FPGA.\n\n:param bits: Number of bits of averaging." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.AddressableLED" + "type": "wpilib.AnalogInput" }, { "defaultValue": "", - "name": "length", - "type": "int" + "name": "bits", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.AddressableLED", - "functionName": "setLength", + "declaringClassName": "wpilib.AnalogInput", + "functionName": "setOversampleBits", "returnType": "None", - "tooltip": "Sets the length of the LED strip.\n\nCalling this is an expensive call, so its best to call it once, then\njust update data.\n\nThe max length is 5460 LEDs.\n\n:param length: the strip length" + "tooltip": "Set the number of oversample bits.\n\nThis sets the number of oversample bits. The actual number of oversampled\nvalues is 2^bits. Use oversampling to improve the resolution of your\nmeasurements at the expense of sampling rate. The oversampling is done\nautomatically in the FPGA.\n\n:param bits: Number of bits of oversampling." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.AddressableLED" + "type": "wpilib.AnalogInput" }, { "defaultValue": "", - "name": "syncTime", - "type": "wpimath.units.microseconds" + "name": "device", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.AddressableLED", - "functionName": "setSyncTime", + "declaringClassName": "wpilib.AnalogInput", + "functionName": "setSimDevice", "returnType": "None", - "tooltip": "Sets the sync time.\n\nThe sync time is the time to hold output so LEDs enable. Default set for\nWS2812B.\n\n:param syncTime: the sync time (default 280us)" - }, + "tooltip": "Indicates this input is used by a simulated device.\n\n:param device: simulated device handle" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AddressableLED" - } - ], - "declaringClassName": "wpilib.AddressableLED", - "functionName": "start", - "returnType": "None", - "tooltip": "Starts the output.\n\nThe output writes continuously." + "args": [], + "declaringClassName": "wpilib.AnalogInput", + "functionName": "getSampleRate", + "returnType": "float", + "tooltip": "Get the current sample rate for all channels\n\n:returns: Sample rate." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.AddressableLED" + "name": "samplesPerSecond", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.AddressableLED", - "functionName": "stop", + "declaringClassName": "wpilib.AnalogInput", + "functionName": "setSampleRate", "returnType": "None", - "tooltip": "Stops the output." + "tooltip": "Set the sample rate per channel for all analog channels.\n\nThe maximum rate is 500kS/s divided by the number of channels in use.\nThis is 62500 samples/s per channel.\n\n:param samplesPerSecond: The number of samples per second." } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] + ] }, { - "className": "wpilib.AddressableLED.LEDData", + "className": "wpilib.AnalogPotentiometer", "classVariables": [], "constructors": [ { - "args": [], - "declaringClassName": "wpilib.AddressableLED.LEDData", + "args": [ + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "1.0", + "name": "fullRange", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "0.0", + "name": "offset", + "type": "typing.SupportsFloat" + } + ], + "declaringClassName": "wpilib.AnalogPotentiometer", "functionName": "__init__", - "returnType": "wpilib.AddressableLED.LEDData", - "tooltip": "" + "returnType": "wpilib.AnalogPotentiometer", + "tooltip": "Construct an Analog Potentiometer object from a channel number.\n\nUse the fullRange and offset values so that the output produces meaningful\nvalues. I.E: you have a 270 degree potentiometer and you want the output to\nbe degrees with the halfway point as 0 degrees. The fullRange value is\n270.0 degrees and the offset is -135.0 since the halfway point after\nscaling is 135 degrees.\n\nThis will calculate the result from the fullRange times the fraction of the\nsupply voltage, plus the offset.\n\n:param channel: The Analog Input channel number on the roboRIO the\n potentiometer is plugged into. 0-3 are on-board and 4-7\n are on the MXP port.\n:param fullRange: The value (in desired units) representing the full\n 0-3.3V range of the input.\n:param offset: The value (in desired units) representing the\n angular output at 0V." }, { "args": [ { "defaultValue": "", - "name": "r", - "type": "int" + "name": "input", + "type": "wpilib.AnalogInput" }, { - "defaultValue": "", - "name": "g", - "type": "int" + "defaultValue": "1.0", + "name": "fullRange", + "type": "typing.SupportsFloat" }, { - "defaultValue": "", - "name": "b", - "type": "int" + "defaultValue": "0.0", + "name": "offset", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.AddressableLED.LEDData", + "declaringClassName": "wpilib.AnalogPotentiometer", "functionName": "__init__", - "returnType": "wpilib.AddressableLED.LEDData", - "tooltip": "" + "returnType": "wpilib.AnalogPotentiometer", + "tooltip": "Construct an Analog Potentiometer object from an existing Analog Input\npointer.\n\nUse the fullRange and offset values so that the output produces meaningful\nvalues. I.E: you have a 270 degree potentiometer and you want the output to\nbe degrees with the halfway point as 0 degrees. The fullRange value is\n270.0 degrees and the offset is -135.0 since the halfway point after\nscaling is 135 degrees.\n\nThis will calculate the result from the fullRange times the fraction of the\nsupply voltage, plus the offset.\n\n:param input: The existing Analog Input pointer\n:param fullRange: The value (in desired units) representing the full\n 0-3.3V range of the input.\n:param offset: The value (in desired units) representing the\n angular output at 0V." } ], "enums": [], @@ -2211,524 +2025,342 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.AddressableLED.LEDData" - }, - { - "defaultValue": "", - "name": "h", - "type": "int" - }, - { - "defaultValue": "", - "name": "s", - "type": "int" - }, - { - "defaultValue": "", - "name": "v", - "type": "int" + "type": "wpilib.AnalogPotentiometer" } ], - "declaringClassName": "wpilib.AddressableLED.LEDData", - "functionName": "setHSV", - "returnType": "None", - "tooltip": "A helper method to set all values of the LED.\n\n:param h: the h value [0-180]\n:param s: the s value [0-255]\n:param v: the v value [0-255]" + "declaringClassName": "wpilib.AnalogPotentiometer", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the current reading of the potentiometer.\n\n:returns: The current position of the potentiometer (in the units used for\n fullRange and offset)." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.AddressableLED.LEDData" + "type": "wpilib.AnalogPotentiometer" }, { "defaultValue": "", - "name": "color", - "type": "wpilib.Color" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.AddressableLED.LEDData", - "functionName": "setLED", + "declaringClassName": "wpilib.AnalogPotentiometer", + "functionName": "initSendable", "returnType": "None", "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.CAN", + "classVariables": [ + { + "name": "kTeamDeviceType", + "tooltip": "", + "type": "hal.CANDeviceType", + "writable": false }, + { + "name": "kTeamManufacturer", + "tooltip": "", + "type": "hal.CANManufacturer", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.AddressableLED.LEDData" + "name": "busId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "color", - "type": "wpilib.Color8Bit" + "name": "deviceId", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.AddressableLED.LEDData", - "functionName": "setLED", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.CAN", + "functionName": "__init__", + "returnType": "wpilib.CAN", + "tooltip": "Create a new CAN communication interface with the specific device ID.\nThis uses the team manufacturer and device types.\nThe device ID is 6 bits (0-63)\n\n:param busId: The bus id\n:param deviceId: The device id" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.AddressableLED.LEDData" + "name": "busId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "r", - "type": "int" + "name": "deviceId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "g", - "type": "int" + "name": "deviceManufacturer", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "b", - "type": "int" + "name": "deviceType", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.AddressableLED.LEDData", - "functionName": "setRGB", - "returnType": "None", - "tooltip": "A helper method to set all values of the LED.\n\n:param r: the r value [0-255]\n:param g: the g value [0-255]\n:param b: the b value [0-255]" + "declaringClassName": "wpilib.CAN", + "functionName": "__init__", + "returnType": "wpilib.CAN", + "tooltip": "Create a new CAN communication interface with a specific device ID,\nmanufacturer and device type. The device ID is 6 bits, the\nmanufacturer is 8 bits, and the device type is 5 bits.\n\n:param busId: The bus id\n:param deviceId: The device ID\n:param deviceManufacturer: The device manufacturer\n:param deviceType: The device type" } ], - "instanceVariables": [ - { - "name": "b", - "tooltip": "///< blue value", - "type": "int", - "writable": true - }, - { - "name": "g", - "tooltip": "///< green value", - "type": "int", - "writable": true - }, - { - "name": "r", - "tooltip": "///< red value", - "type": "int", - "writable": true - } - ], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.Alert", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "text", - "type": "str" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.Alert.AlertType" - } - ], - "declaringClassName": "wpilib.Alert", - "functionName": "__init__", - "returnType": "wpilib.Alert", - "tooltip": "Creates a new alert in the default group - \"Alerts\". If this is the first\nto be instantiated, the appropriate entries will be added to NetworkTables.\n\n:param text: Text to be displayed when the alert is active.\n:param type: Alert urgency level." - }, + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "group", - "type": "str" + "name": "self", + "type": "wpilib.CAN" }, { "defaultValue": "", - "name": "text", - "type": "str" + "name": "apiId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "type", - "type": "wpilib.Alert.AlertType" - } - ], - "declaringClassName": "wpilib.Alert", - "functionName": "__init__", - "returnType": "wpilib.Alert", - "tooltip": "Creates a new alert. If this is the first to be instantiated in its group,\nthe appropriate entries will be added to NetworkTables.\n\n:param group: Group identifier, used as the entry name in NetworkTables.\n:param text: Text to be displayed when the alert is active.\n:param type: Alert urgency level." - } - ], - "enums": [ - { - "enumClassName": "wpilib.Alert.AlertType", - "enumValues": [ - "kError", - "kInfo", - "kWarning" - ], - "moduleName": "wpilib", - "tooltip": "Represents an alert's level of urgency.\n\nMembers:\n\n kError : High priority alert - displayed first on the dashboard with a red \"X\"\nsymbol. Use this type for problems which will seriously affect the\nrobot's functionality and thus require immediate attention.\n\n kWarning : Medium priority alert - displayed second on the dashboard with a yellow\n\"!\" symbol. Use this type for problems which could affect the robot's\nfunctionality but do not necessarily require immediate attention.\n\n kInfo : Low priority alert - displayed last on the dashboard with a green \"i\"\nsymbol. Use this type for problems which are unlikely to affect the\nrobot's functionality, or any other alerts which do not fall under the\nother categories." - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Alert" + "name": "data", + "type": "hal.CANReceiveMessage" } ], - "declaringClassName": "wpilib.Alert", - "functionName": "get", + "declaringClassName": "wpilib.CAN", + "functionName": "readPacketLatest", "returnType": "bool", - "tooltip": "Gets whether the alert is active.\n\n:returns: whether the alert is active." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Alert" - } - ], - "declaringClassName": "wpilib.Alert", - "functionName": "getText", - "returnType": "str", - "tooltip": "Gets the current alert text.\n\n:returns: the current text." + "tooltip": "Read a CAN packet. The will continuously return the last packet received,\nwithout accounting for packet age.\n\n:param apiId: The API ID to read.\n:param data: Storage for the received data.\n\n:returns: True if the data is valid, otherwise false." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Alert" - } - ], - "declaringClassName": "wpilib.Alert", - "functionName": "getType", - "returnType": "wpilib.Alert.AlertType", - "tooltip": "Get the type of this alert.\n\n:returns: the type" - }, - { - "args": [ + "type": "wpilib.CAN" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.Alert" + "name": "apiId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "active", - "type": "bool" + "name": "data", + "type": "hal.CANReceiveMessage" } ], - "declaringClassName": "wpilib.Alert", - "functionName": "set", - "returnType": "None", - "tooltip": "Sets whether the alert should currently be displayed. This method can be\nsafely called periodically.\n\n:param active: Whether to display the alert." + "declaringClassName": "wpilib.CAN", + "functionName": "readPacketNew", + "returnType": "bool", + "tooltip": "Read a new CAN packet. This will only return properly once per packet\nreceived. Multiple calls without receiving another packet will return\nfalse.\n\n:param apiId: The API ID to read.\n:param data: Storage for the received data.\n\n:returns: True if the data is valid, otherwise false." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Alert" + "type": "wpilib.CAN" }, { "defaultValue": "", - "name": "text", - "type": "str" - } - ], - "declaringClassName": "wpilib.Alert", - "functionName": "setText", - "returnType": "None", - "tooltip": "Updates current alert text. Use this method to dynamically change the\ndisplayed alert, such as including more details about the detected problem.\n\n:param text: Text to be displayed when the alert is active." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.AnalogAccelerometer", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogAccelerometer", - "functionName": "__init__", - "returnType": "wpilib.AnalogAccelerometer", - "tooltip": "Create a new instance of an accelerometer.\n\nThe constructor allocates desired analog input.\n\n:param channel: The channel number for the analog input the accelerometer is\n connected to" - }, - { - "args": [ + "name": "apiId", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "channel", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogAccelerometer", - "functionName": "__init__", - "returnType": "wpilib.AnalogAccelerometer", - "tooltip": "Create a new instance of Accelerometer from an existing AnalogInput.\n\nMake a new instance of accelerometer given an AnalogInput. This is\nparticularly useful if the port is going to be read as an analog channel as\nwell as through the Accelerometer class.\n\n:param channel: The existing AnalogInput object for the analog input the\n accelerometer is connected to" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ + "name": "timeoutMs", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogAccelerometer" + "name": "data", + "type": "hal.CANReceiveMessage" } ], - "declaringClassName": "wpilib.AnalogAccelerometer", - "functionName": "getAcceleration", - "returnType": "float", - "tooltip": "Return the acceleration in Gs.\n\nThe acceleration is returned units of Gs.\n\n:returns: The current acceleration of the sensor in Gs." + "declaringClassName": "wpilib.CAN", + "functionName": "readPacketTimeout", + "returnType": "bool", + "tooltip": "Read a CAN packet. The will return the last packet received until the\npacket is older then the requested timeout. Then it will return false.\n\n:param apiId: The API ID to read.\n:param timeoutMs: The timeout time for the packet\n:param data: Storage for the received data.\n\n:returns: True if the data is valid, otherwise false." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.AnalogAccelerometer" + "type": "wpilib.CAN" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "apiId", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.AnalogAccelerometer", - "functionName": "initSendable", + "declaringClassName": "wpilib.CAN", + "functionName": "stopPacketRepeating", "returnType": "None", - "tooltip": "" + "tooltip": "Stop a repeating packet with a specific ID. This ID is 10 bits.\n\n:param apiId: The API ID to stop repeating" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.AnalogAccelerometer" + "type": "wpilib.CAN" }, { "defaultValue": "", - "name": "sensitivity", - "type": "float" + "name": "apiId", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "message", + "type": "hal.CANMessage" } ], - "declaringClassName": "wpilib.AnalogAccelerometer", - "functionName": "setSensitivity", + "declaringClassName": "wpilib.CAN", + "functionName": "writePacket", "returnType": "None", - "tooltip": "Set the accelerometer sensitivity.\n\nThis sets the sensitivity of the accelerometer used for calculating the\nacceleration. The sensitivity varies by accelerometer model. There are\nconstants defined for various models.\n\n:param sensitivity: The sensitivity of accelerometer in Volts per G." + "tooltip": "Write a packet to the CAN device with a specific ID. This ID is 10 bits.\n\n:param apiId: The API ID to write.\n:param message: the CAN message." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.AnalogAccelerometer" + "type": "wpilib.CAN" }, { "defaultValue": "", - "name": "zero", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogAccelerometer", - "functionName": "setZero", - "returnType": "None", - "tooltip": "Set the voltage that corresponds to 0 G.\n\nThe zero G voltage varies by accelerometer model. There are constants\ndefined for various models.\n\n:param zero: The zero G voltage." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.AnalogEncoder", - "classVariables": [], - "constructors": [ - { - "args": [ + "name": "apiId", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "message", + "type": "hal.CANMessage" } ], - "declaringClassName": "wpilib.AnalogEncoder", - "functionName": "__init__", - "returnType": "wpilib.AnalogEncoder", - "tooltip": "Construct a new AnalogEncoder attached to a specific AnalogIn channel.\n\nThis has a fullRange of 1 and an expectedZero of 0.\n\n:param channel: the analog input channel to attach to" + "declaringClassName": "wpilib.CAN", + "functionName": "writePacketNoError", + "returnType": "int", + "tooltip": "Write a packet to the CAN device with a specific ID. This ID is 10 bits.\n\n:param apiId: The API ID to write.\n:param message: the CAN message." }, { "args": [ { "defaultValue": "", - "name": "analogInput", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogEncoder", - "functionName": "__init__", - "returnType": "wpilib.AnalogEncoder", - "tooltip": "Construct a new AnalogEncoder attached to a specific AnalogInput.\n\nThis has a fullRange of 1 and an expectedZero of 0.\n\n:param analogInput: the analog input to attach to" - }, - { - "args": [ + "name": "self", + "type": "wpilib.CAN" + }, { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "apiId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "fullRange", - "type": "float" + "name": "message", + "type": "hal.CANMessage" }, { "defaultValue": "", - "name": "expectedZero", - "type": "float" + "name": "repeatMs", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.AnalogEncoder", - "functionName": "__init__", - "returnType": "wpilib.AnalogEncoder", - "tooltip": "Construct a new AnalogEncoder attached to a specific AnalogIn channel.\n\n:param channel: the analog input channel to attach to\n:param fullRange: the value to report at maximum travel\n:param expectedZero: the reading where you would expect a 0 from get()" + "declaringClassName": "wpilib.CAN", + "functionName": "writePacketRepeating", + "returnType": "None", + "tooltip": "Write a repeating packet to the CAN device with a specific ID. This ID is\n10 bits. The RoboRIO will automatically repeat the packet at the specified\ninterval\n\n:param apiId: The API ID to write.\n:param message: the CAN message.\n:param repeatMs: The period to repeat the packet at." }, { "args": [ { "defaultValue": "", - "name": "analogInput", - "type": "wpilib.AnalogInput" + "name": "self", + "type": "wpilib.CAN" }, { "defaultValue": "", - "name": "fullRange", - "type": "float" + "name": "apiId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "expectedZero", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogEncoder", - "functionName": "__init__", - "returnType": "wpilib.AnalogEncoder", - "tooltip": "Construct a new AnalogEncoder attached to a specific AnalogInput.\n\n:param analogInput: the analog input to attach to\n:param fullRange: the value to report at maximum travel\n:param expectedZero: the reading where you would expect a 0 from get()" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogEncoder" - } - ], - "declaringClassName": "wpilib.AnalogEncoder", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the encoder value.\n\n:returns: the encoder value scaled by the full range input" - }, - { - "args": [ + "name": "message", + "type": "hal.CANMessage" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogEncoder" + "name": "repeatMs", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.AnalogEncoder", - "functionName": "getChannel", + "declaringClassName": "wpilib.CAN", + "functionName": "writePacketRepeatingNoError", "returnType": "int", - "tooltip": "Get the channel number.\n\n:returns: The channel number." + "tooltip": "Write a repeating packet to the CAN device with a specific ID. This ID is\n10 bits. The RoboRIO will automatically repeat the packet at the specified\ninterval\n\n:param apiId: The API ID to write.\n:param message: the CAN message.\n:param repeatMs: The period to repeat the packet at." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.AnalogEncoder" + "type": "wpilib.CAN" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.AnalogEncoder", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogEncoder" + "name": "apiId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "inverted", - "type": "bool" + "name": "message", + "type": "hal.CANMessage" } ], - "declaringClassName": "wpilib.AnalogEncoder", - "functionName": "setInverted", + "declaringClassName": "wpilib.CAN", + "functionName": "writeRTRFrame", "returnType": "None", - "tooltip": "Set if this encoder is inverted.\n\n:param inverted: true to invert the encoder, false otherwise" + "tooltip": "Write an RTR frame to the CAN device with a specific ID. This ID is 10\nbits. The length by spec must match what is returned by the responding\ndevice\n\n:param apiId: The API ID to write.\n:param message: the CAN message." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.AnalogEncoder" + "type": "wpilib.CAN" }, { "defaultValue": "", - "name": "min", - "type": "float" + "name": "apiId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "max", - "type": "float" + "name": "message", + "type": "hal.CANMessage" } ], - "declaringClassName": "wpilib.AnalogEncoder", - "functionName": "setVoltagePercentageRange", - "returnType": "None", - "tooltip": "Set the encoder voltage percentage range. Analog sensors are not always\nfully stable at the end of their travel ranges. Shrinking this range down\ncan help mitigate issues with that.\n\n:param min: minimum voltage percentage (0-1 range)\n:param max: maximum voltage percentage (0-1 range)" + "declaringClassName": "wpilib.CAN", + "functionName": "writeRTRFrameNoError", + "returnType": "int", + "tooltip": "Write an RTR frame to the CAN device with a specific ID. This ID is 10\nbits. The length by spec must match what is returned by the responding\ndevice\n\n:param apiId: The API ID to write.\n:param message: the CAN message." } ], "instanceVariables": [], @@ -2736,17265 +2368,1435 @@ "staticMethods": [] }, { - "className": "wpilib.AnalogGyro", - "classVariables": [ + "className": "wpilib.CANStatus", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.CANStatus", + "functionName": "__init__", + "returnType": "wpilib.CANStatus", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ { - "name": "kAverageBits", + "name": "busOffCount", "tooltip": "", "type": "int", - "writable": false + "writable": true }, { - "name": "kCalibrationSampleTime", + "name": "percentBusUtilization", "tooltip": "", "type": "float", - "writable": false + "writable": true }, { - "name": "kDefaultVoltsPerDegreePerSecond", + "name": "receiveErrorCount", "tooltip": "", - "type": "float", - "writable": false + "type": "int", + "writable": true }, { - "name": "kOversampleBits", + "name": "transmitErrorCount", "tooltip": "", "type": "int", - "writable": false + "writable": true }, { - "name": "kSamplesPerSecond", + "name": "txFullCount", "tooltip": "", - "type": "float", - "writable": false + "type": "int", + "writable": true } ], - "constructors": [ + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.Color", + "classVariables": [ { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "__init__", - "returnType": "wpilib.AnalogGyro", - "tooltip": "%Gyro constructor using the Analog Input channel number.\n\n:param channel: The analog channel the gyro is connected to. Gyros can only\n be used on on-board Analog Inputs 0-1." + "name": "kAliceBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "__init__", - "returnType": "wpilib.AnalogGyro", - "tooltip": "%Gyro constructor with a precreated AnalogInput object.\n\nUse this constructor when the analog channel needs to be shared.\nThis object will not clean up the AnalogInput object when using this\nconstructor.\n\n:param channel: A pointer to the AnalogInput object that the gyro is\n connected to." + "name": "kAntiqueWhite", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - }, - { - "defaultValue": "", - "name": "center", - "type": "int" - }, - { - "defaultValue": "", - "name": "offset", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "__init__", - "returnType": "wpilib.AnalogGyro", - "tooltip": "%Gyro constructor using the Analog Input channel number with parameters for\npresetting the center and offset values. Bypasses calibration.\n\n:param channel: The analog channel the gyro is connected to. Gyros can only\n be used on on-board Analog Inputs 0-1.\n:param center: Preset uncalibrated value to use as the accumulator center\n value.\n:param offset: Preset uncalibrated value to use as the gyro offset." + "name": "kAqua", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "wpilib.AnalogInput" - }, - { - "defaultValue": "", - "name": "center", - "type": "int" - }, - { - "defaultValue": "", - "name": "offset", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "__init__", - "returnType": "wpilib.AnalogGyro", - "tooltip": "%Gyro constructor with a precreated AnalogInput object and calibrated\nparameters.\n\nUse this constructor when the analog channel needs to be shared.\nThis object will not clean up the AnalogInput object when using this\nconstructor.\n\n:param channel: A pointer to the AnalogInput object that the gyro is\n connected to.\n:param center: Preset uncalibrated value to use as the accumulator center\n value.\n:param offset: Preset uncalibrated value to use as the gyro offset." - } - ], - "enums": [], - "instanceMethods": [ + "name": "kAquamarine", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "calibrate", - "returnType": "None", - "tooltip": "Calibrate the gyro by running for a number of samples and computing the\ncenter value. Then use the center value as the Accumulator center value for\nsubsequent measurements.\n\nIt's important to make sure that the robot is not moving while the\ncentering calculations are in progress, this is typically done when the\nrobot is first turned on while it's sitting at rest before the competition\nstarts." + "name": "kAzure", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "getAnalogInput", - "returnType": "wpilib.AnalogInput", - "tooltip": "Gets the analog input for the gyro.\n\n:returns: AnalogInput" + "name": "kBeige", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "getAngle", - "returnType": "float", - "tooltip": "Return the actual angle in degrees that the robot is currently facing.\n\nThe angle is based on the current accumulator value corrected by the\noversampling rate, the gyro type and the A/D calibration values. The angle\nis continuous, that is it will continue from 360->361 degrees. This allows\nalgorithms that wouldn't want to see a discontinuity in the gyro output as\nit sweeps from 360 to 0 on the second time around.\n\n:returns: The current heading of the robot in degrees. This heading is based\n on integration of the returned rate from the gyro." + "name": "kBisque", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "getCenter", - "returnType": "int", - "tooltip": "Return the gyro center value. If run after calibration,\nthe center value can be used as a preset later.\n\n:returns: the current center value" + "name": "kBlack", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "getOffset", - "returnType": "float", - "tooltip": "Return the gyro offset value. If run after calibration,\nthe offset value can be used as a preset later.\n\n:returns: the current offset value" + "name": "kBlanchedAlmond", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "getRate", - "returnType": "float", - "tooltip": "Return the rate of rotation of the gyro\n\nThe rate is based on the most recent reading of the gyro analog value\n\n:returns: the current rate in degrees per second" + "name": "kBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "getRotation2d", - "returnType": "wpimath.geometry.Rotation2d", - "tooltip": "Return the heading of the robot as a Rotation2d.\n\nThe angle is continuous, that is it will continue from 360 to 361 degrees.\nThis allows algorithms that wouldn't want to see a discontinuity in the\ngyro output as it sweeps past from 360 to 0 on the second time around.\n\nThe angle is expected to increase as the gyro turns counterclockwise when\nlooked at from the top. It needs to follow the NWU axis convention.\n\n:returns: the current heading of the robot as a Rotation2d. This heading is\n based on integration of the returned rate from the gyro." + "name": "kBlueViolet", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "initGyro", - "returnType": "None", - "tooltip": "Initialize the gyro.\n\nCalibration is handled by Calibrate()." + "name": "kBrown", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" + "name": "kBurlywood", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "reset", - "returnType": "None", - "tooltip": "Reset the gyro.\n\nResets the gyro to a heading of zero. This can be used if there is\nsignificant drift in the gyro and it needs to be recalibrated after it has\nbeen running." + "name": "kCadetBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - }, - { - "defaultValue": "", - "name": "volts", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "setDeadband", - "returnType": "None", - "tooltip": "Set the size of the neutral zone.\n\nAny voltage from the gyro less than this amount from the center is\nconsidered stationary. Setting a deadband will decrease the amount of\ndrift when the gyro isn't rotating, but will make it less accurate.\n\n:param volts: The size of the deadband in volts" + "name": "kChartreuse", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogGyro" - }, - { - "defaultValue": "", - "name": "voltsPerDegreePerSecond", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogGyro", - "functionName": "setSensitivity", - "returnType": "None", - "tooltip": "Set the gyro sensitivity.\n\nThis takes the number of volts/degree/second sensitivity of the gyro and\nuses it in subsequent calculations to allow the code to work with multiple\ngyros. This value is typically found in the gyro datasheet.\n\n:param voltsPerDegreePerSecond: The sensitivity in Volts/degree/second" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.AnalogInput", - "classVariables": [ + "name": "kChocolate", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "name": "kAccumulatorModuleNumber", + "name": "kCoral", "tooltip": "", - "type": "int", + "type": "wpilib.Color", "writable": false }, { - "name": "kAccumulatorNumChannels", + "name": "kCornflowerBlue", "tooltip": "", - "type": "int", + "type": "wpilib.Color", "writable": false - } - ], - "constructors": [ + }, { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "__init__", - "returnType": "wpilib.AnalogInput", - "tooltip": "Construct an analog input.\n\n:param channel: The channel number on the roboRIO to represent. 0-3 are\n on-board 4-7 are on the MXP port." - } - ], - "enums": [], - "instanceMethods": [ + "name": "kCornsilk", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getAccumulatorCount", - "returnType": "int", - "tooltip": "Read the number of accumulated values.\n\nRead the count of the accumulated values since the accumulator was last\nReset().\n\n:returns: The number of times samples from the channel were accumulated." + "name": "kCrimson", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getAccumulatorOutput", - "returnType": "tuple[int, int]", - "tooltip": "Read the accumulated value and the number of accumulated values atomically.\n\nThis function reads the value and count from the FPGA atomically.\nThis can be used for averaging.\n\n:param value: Reference to the 64-bit accumulated output.\n:param count: Reference to the number of accumulation cycles." + "name": "kCyan", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getAccumulatorValue", - "returnType": "int", - "tooltip": "Read the accumulated value.\n\nRead the value that has been accumulating.\nThe accumulator is attached after the oversample and average engine.\n\n:returns: The 64-bit value accumulated since the last Reset()." + "name": "kDarkBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getAverageBits", - "returnType": "int", - "tooltip": "Get the number of averaging bits previously configured.\n\nThis gets the number of averaging bits from the FPGA. The actual number of\naveraged samples is 2^bits. The averaging is done automatically in the\nFPGA.\n\n:returns: Number of bits of averaging previously configured." + "name": "kDarkCyan", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getAverageValue", - "returnType": "int", - "tooltip": "Get a sample from the output of the oversample and average engine for this\nchannel.\n\nThe sample is 12-bit + the bits configured in SetOversampleBits().\nThe value configured in SetAverageBits() will cause this value to be\naveraged 2**bits number of samples.\n\nThis is not a sliding window. The sample will not change until\n2**(OversampleBits + AverageBits) samples have been acquired from the\nmodule on this channel.\n\nUse GetAverageVoltage() to get the analog value in calibrated units.\n\n:returns: A sample from the oversample and average engine for this channel." + "name": "kDarkGoldenrod", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getAverageVoltage", - "returnType": "float", - "tooltip": "Get a scaled sample from the output of the oversample and average engine\nfor this channel.\n\nThe value is scaled to units of Volts using the calibrated scaling data\nfrom GetLSBWeight() and GetOffset().\n\nUsing oversampling will cause this value to be higher resolution, but it\nwill update more slowly.\n\nUsing averaging will cause this value to be more stable, but it will update\nmore slowly.\n\n:returns: A scaled sample from the output of the oversample and average\n engine for this channel." + "name": "kDarkGray", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "Get the channel number.\n\n:returns: The channel number." + "name": "kDarkGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getLSBWeight", - "returnType": "int", - "tooltip": "Get the factory scaling least significant bit weight constant.\n\nVolts = ((LSB_Weight * 1e-9) * raw) - (Offset * 1e-9)\n\n:returns: Least significant bit weight." + "name": "kDarkKhaki", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getOffset", - "returnType": "int", - "tooltip": "Get the factory scaling offset constant.\n\nVolts = ((LSB_Weight * 1e-9) * raw) - (Offset * 1e-9)\n\n:returns: Offset constant." + "name": "kDarkMagenta", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getOversampleBits", - "returnType": "int", - "tooltip": "Get the number of oversample bits previously configured.\n\nThis gets the number of oversample bits from the FPGA. The actual number of\noversampled values is 2^bits. The oversampling is done automatically in the\nFPGA.\n\n:returns: Number of bits of oversampling previously configured." + "name": "kDarkOliveGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getValue", - "returnType": "int", - "tooltip": "Get a sample straight from this channel.\n\nThe sample is a 12-bit value representing the 0V to 5V range of the A/D\nconverter in the module. The units are in A/D converter codes. Use\nGetVoltage() to get the analog value in calibrated units.\n\n:returns: A sample straight from this channel." + "name": "kDarkOrange", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getVoltage", - "returnType": "float", - "tooltip": "Get a scaled sample straight from this channel.\n\nThe value is scaled to units of Volts using the calibrated scaling data\nfrom GetLSBWeight() and GetOffset().\n\n:returns: A scaled sample straight from this channel." + "name": "kDarkOrchid", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "initAccumulator", - "returnType": "None", - "tooltip": "Initialize the accumulator." + "name": "kDarkRed", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" + "name": "kDarkSalmon", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "isAccumulatorChannel", - "returnType": "bool", - "tooltip": "Is the channel attached to an accumulator.\n\n:returns: The analog input is attached to an accumulator." + "name": "kDarkSeaGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "resetAccumulator", - "returnType": "None", - "tooltip": "Resets the accumulator to the initial value." + "name": "kDarkSlateBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - }, - { - "defaultValue": "", - "name": "center", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "setAccumulatorCenter", - "returnType": "None", - "tooltip": "Set the center value of the accumulator.\n\nThe center value is subtracted from each A/D value before it is added to\nthe accumulator. This is used for the center value of devices like gyros\nand accelerometers to take the device offset into account when integrating.\n\nThis center value is based on the output of the oversampled and averaged\nsource from the accumulator channel. Because of this, any non-zero\noversample bits will affect the size of the value for this field." + "name": "kDarkSlateGray", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - }, - { - "defaultValue": "", - "name": "deadband", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "setAccumulatorDeadband", - "returnType": "None", - "tooltip": "Set the accumulator's deadband." + "name": "kDarkTurquoise", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - }, - { - "defaultValue": "", - "name": "value", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "setAccumulatorInitialValue", - "returnType": "None", - "tooltip": "Set an initial value for the accumulator.\n\nThis will be added to all values returned to the user.\n\n:param value: The value that the accumulator should start from when reset." + "name": "kDarkViolet", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - }, - { - "defaultValue": "", - "name": "bits", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "setAverageBits", - "returnType": "None", - "tooltip": "Set the number of averaging bits.\n\nThis sets the number of averaging bits. The actual number of averaged\nsamples is 2^bits.\n\nUse averaging to improve the stability of your measurement at the expense\nof sampling rate. The averaging is done automatically in the FPGA.\n\n:param bits: Number of bits of averaging." + "name": "kDeepPink", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - }, - { - "defaultValue": "", - "name": "bits", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "setOversampleBits", - "returnType": "None", - "tooltip": "Set the number of oversample bits.\n\nThis sets the number of oversample bits. The actual number of oversampled\nvalues is 2^bits. Use oversampling to improve the resolution of your\nmeasurements at the expense of sampling rate. The oversampling is done\nautomatically in the FPGA.\n\n:param bits: Number of bits of oversampling." + "name": "kDeepSkyBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogInput" - }, - { - "defaultValue": "", - "name": "device", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "setSimDevice", - "returnType": "None", - "tooltip": "Indicates this input is used by a simulated device.\n\n:param device: simulated device handle" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "getSampleRate", - "returnType": "float", - "tooltip": "Get the current sample rate for all channels\n\n:returns: Sample rate." - }, - { - "args": [ - { - "defaultValue": "", - "name": "samplesPerSecond", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogInput", - "functionName": "setSampleRate", - "returnType": "None", - "tooltip": "Set the sample rate per channel for all analog channels.\n\nThe maximum rate is 500kS/s divided by the number of channels in use.\nThis is 62500 samples/s per channel.\n\n:param samplesPerSecond: The number of samples per second." - } - ] - }, - { - "className": "wpilib.AnalogOutput", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogOutput", - "functionName": "__init__", - "returnType": "wpilib.AnalogOutput", - "tooltip": "Construct an analog output on the given channel.\n\nAll analog outputs are located on the MXP port.\n\n:param channel: The channel number on the roboRIO to represent." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogOutput" - } - ], - "declaringClassName": "wpilib.AnalogOutput", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "Get the channel of this AnalogOutput." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogOutput" - } - ], - "declaringClassName": "wpilib.AnalogOutput", - "functionName": "getVoltage", - "returnType": "float", - "tooltip": "Get the voltage of the analog output.\n\n:returns: The value in Volts, from 0.0 to +5.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogOutput" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.AnalogOutput", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogOutput" - }, - { - "defaultValue": "", - "name": "voltage", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogOutput", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Set the value of the analog output.\n\n:param voltage: The output value in Volts, from 0.0 to +5.0." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.AnalogPotentiometer", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - }, - { - "defaultValue": "1.0", - "name": "fullRange", - "type": "float" - }, - { - "defaultValue": "0.0", - "name": "offset", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogPotentiometer", - "functionName": "__init__", - "returnType": "wpilib.AnalogPotentiometer", - "tooltip": "Construct an Analog Potentiometer object from a channel number.\n\nUse the fullRange and offset values so that the output produces meaningful\nvalues. I.E: you have a 270 degree potentiometer and you want the output to\nbe degrees with the halfway point as 0 degrees. The fullRange value is\n270.0 degrees and the offset is -135.0 since the halfway point after\nscaling is 135 degrees.\n\nThis will calculate the result from the fullRange times the fraction of the\nsupply voltage, plus the offset.\n\n:param channel: The Analog Input channel number on the roboRIO the\n potentiometer is plugged into. 0-3 are on-board and 4-7\n are on the MXP port.\n:param fullRange: The value (in desired units) representing the full\n 0-5V range of the input.\n:param offset: The value (in desired units) representing the\n angular output at 0V." - }, - { - "args": [ - { - "defaultValue": "", - "name": "input", - "type": "wpilib.AnalogInput" - }, - { - "defaultValue": "1.0", - "name": "fullRange", - "type": "float" - }, - { - "defaultValue": "0.0", - "name": "offset", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogPotentiometer", - "functionName": "__init__", - "returnType": "wpilib.AnalogPotentiometer", - "tooltip": "Construct an Analog Potentiometer object from an existing Analog Input\npointer.\n\nUse the fullRange and offset values so that the output produces meaningful\nvalues. I.E: you have a 270 degree potentiometer and you want the output to\nbe degrees with the halfway point as 0 degrees. The fullRange value is\n270.0 degrees and the offset is -135.0 since the halfway point after\nscaling is 135 degrees.\n\nThis will calculate the result from the fullRange times the fraction of the\nsupply voltage, plus the offset.\n\n:param input: The existing Analog Input pointer\n:param fullRange: The value (in desired units) representing the full\n 0-5V range of the input.\n:param offset: The value (in desired units) representing the\n angular output at 0V." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogPotentiometer" - } - ], - "declaringClassName": "wpilib.AnalogPotentiometer", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the current reading of the potentiometer.\n\n:returns: The current position of the potentiometer (in the units used for\n fullRange and offset)." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogPotentiometer" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.AnalogPotentiometer", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.AnalogTrigger", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "__init__", - "returnType": "wpilib.AnalogTrigger", - "tooltip": "Constructor for an analog trigger given a channel number.\n\n:param channel: The channel number on the roboRIO to represent. 0-3 are\n on-board 4-7 are on the MXP port." - }, - { - "args": [ - { - "defaultValue": "", - "name": "input", - "type": "wpilib.AnalogInput" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "__init__", - "returnType": "wpilib.AnalogTrigger", - "tooltip": "Construct an analog trigger using an existing analog input.\n\nThis should be used in the case of sharing an analog channel between the\ntrigger and an analog input object.\n\n:param input: A shared_ptr to the existing AnalogInput object" - }, - { - "args": [ - { - "defaultValue": "", - "name": "dutyCycle", - "type": "wpilib.DutyCycle" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "__init__", - "returnType": "wpilib.AnalogTrigger", - "tooltip": "Construct an analog trigger using an existing duty cycle input.\n\n:param dutyCycle: A shared_ptr to the existing DutyCycle object" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTrigger" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.AnalogTriggerType" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "createOutput", - "returnType": "wpilib.AnalogTriggerOutput", - "tooltip": "Creates an AnalogTriggerOutput object.\n\n:param type: An enum of the type of output object to create.\n\n:returns: A pointer to a new AnalogTriggerOutput object." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTrigger" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "getInWindow", - "returnType": "bool", - "tooltip": "Return the InWindow output of the analog trigger.\n\nTrue if the analog input is between the upper and lower limits.\n\n:returns: True if the analog input is between the upper and lower limits." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTrigger" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "getIndex", - "returnType": "int", - "tooltip": "Return the index of the analog trigger.\n\nThis is the FPGA index of this analog trigger instance.\n\n:returns: The index of the analog trigger." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTrigger" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "getTriggerState", - "returnType": "bool", - "tooltip": "Return the TriggerState output of the analog trigger.\n\nTrue if above upper limit.\nFalse if below lower limit.\nIf in Hysteresis, maintain previous state.\n\n:returns: True if above upper limit. False if below lower limit. If in\n Hysteresis, maintain previous state." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTrigger" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTrigger" - }, - { - "defaultValue": "", - "name": "useAveragedValue", - "type": "bool" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "setAveraged", - "returnType": "None", - "tooltip": "Configure the analog trigger to use the averaged vs. raw values.\n\nIf the value is true, then the averaged value is selected for the analog\ntrigger, otherwise the immediate value is used.\n\n:param useAveragedValue: If true, use the Averaged value, otherwise use the\n instantaneous reading" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTrigger" - }, - { - "defaultValue": "", - "name": "useFilteredValue", - "type": "bool" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "setFiltered", - "returnType": "None", - "tooltip": "Configure the analog trigger to use a filtered value.\n\nThe analog trigger will operate with a 3 point average rejection filter.\nThis is designed to help with 360 degree pot applications for the period\nwhere the pot crosses through zero.\n\n:param useFilteredValue: If true, use the 3 point rejection filter,\n otherwise use the unfiltered value" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTrigger" - }, - { - "defaultValue": "", - "name": "lower", - "type": "float" - }, - { - "defaultValue": "", - "name": "upper", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "setLimitsDutyCycle", - "returnType": "None", - "tooltip": "Set the upper and lower duty cycle limits of the analog trigger.\n\nThe limits are given as floating point values between 0 and 1.\n\n:param lower: The lower limit of the trigger in percentage.\n:param upper: The upper limit of the trigger in percentage." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTrigger" - }, - { - "defaultValue": "", - "name": "lower", - "type": "int" - }, - { - "defaultValue": "", - "name": "upper", - "type": "int" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "setLimitsRaw", - "returnType": "None", - "tooltip": "Set the upper and lower limits of the analog trigger.\n\nThe limits are given in ADC codes. If oversampling is used, the units must\nbe scaled appropriately.\n\n:param lower: The lower limit of the trigger in ADC codes (12-bit values).\n:param upper: The upper limit of the trigger in ADC codes (12-bit values)." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTrigger" - }, - { - "defaultValue": "", - "name": "lower", - "type": "float" - }, - { - "defaultValue": "", - "name": "upper", - "type": "float" - } - ], - "declaringClassName": "wpilib.AnalogTrigger", - "functionName": "setLimitsVoltage", - "returnType": "None", - "tooltip": "Set the upper and lower limits of the analog trigger.\n\nThe limits are given as floating point voltage values.\n\n:param lower: The lower limit of the trigger in Volts.\n:param upper: The upper limit of the trigger in Volts." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.AnalogTriggerOutput", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "trigger", - "type": "wpilib.AnalogTrigger" - }, - { - "defaultValue": "", - "name": "outputType", - "type": "wpilib.AnalogTriggerType" - } - ], - "declaringClassName": "wpilib.AnalogTriggerOutput", - "functionName": "__init__", - "returnType": "wpilib.AnalogTriggerOutput", - "tooltip": "Create an object that represents one of the four outputs from an analog\ntrigger.\n\nBecause this class derives from DigitalSource, it can be passed into\nrouting functions for Counter, Encoder, etc.\n\n:param trigger: A pointer to the trigger for which this is an output.\n:param outputType: An enum that specifies the output on the trigger to\n represent." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTriggerOutput" - } - ], - "declaringClassName": "wpilib.AnalogTriggerOutput", - "functionName": "get", - "returnType": "bool", - "tooltip": "Get the state of the analog trigger output.\n\n:returns: The state of the analog trigger output." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTriggerOutput" - } - ], - "declaringClassName": "wpilib.AnalogTriggerOutput", - "functionName": "getAnalogTriggerTypeForRouting", - "returnType": "wpilib.AnalogTriggerType", - "tooltip": ":returns: The type of analog trigger output to be used." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTriggerOutput" - } - ], - "declaringClassName": "wpilib.AnalogTriggerOutput", - "functionName": "getChannel", - "returnType": "int", - "tooltip": ":returns: The channel of the source." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTriggerOutput" - } - ], - "declaringClassName": "wpilib.AnalogTriggerOutput", - "functionName": "getPortHandleForRouting", - "returnType": "int", - "tooltip": ":returns: The HAL Handle to the specified source." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTriggerOutput" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.AnalogTriggerOutput", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.AnalogTriggerOutput" - } - ], - "declaringClassName": "wpilib.AnalogTriggerOutput", - "functionName": "isAnalogTrigger", - "returnType": "bool", - "tooltip": "Is source an AnalogTrigger" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.BuiltInAccelerometer", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "range", - "type": "wpilib.BuiltInAccelerometer.Range" - } - ], - "declaringClassName": "wpilib.BuiltInAccelerometer", - "functionName": "__init__", - "returnType": "wpilib.BuiltInAccelerometer", - "tooltip": "Constructor.\n\n:param range: The range the accelerometer will measure" - } - ], - "enums": [ - { - "enumClassName": "wpilib.BuiltInAccelerometer.Range", - "enumValues": [ - "kRange_2G", - "kRange_4G", - "kRange_8G" - ], - "moduleName": "wpilib", - "tooltip": "Accelerometer range.\n\nMembers:\n\n kRange_2G : 2 Gs max.\n\n kRange_4G : 4 Gs max.\n\n kRange_8G : 8 Gs max." - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.BuiltInAccelerometer" - } - ], - "declaringClassName": "wpilib.BuiltInAccelerometer", - "functionName": "getX", - "returnType": "float", - "tooltip": ":returns: The acceleration of the roboRIO along the X axis in g-forces" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.BuiltInAccelerometer" - } - ], - "declaringClassName": "wpilib.BuiltInAccelerometer", - "functionName": "getY", - "returnType": "float", - "tooltip": ":returns: The acceleration of the roboRIO along the Y axis in g-forces" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.BuiltInAccelerometer" - } - ], - "declaringClassName": "wpilib.BuiltInAccelerometer", - "functionName": "getZ", - "returnType": "float", - "tooltip": ":returns: The acceleration of the roboRIO along the Z axis in g-forces" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.BuiltInAccelerometer" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.BuiltInAccelerometer", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.BuiltInAccelerometer" - }, - { - "defaultValue": "", - "name": "range", - "type": "wpilib.BuiltInAccelerometer.Range" - } - ], - "declaringClassName": "wpilib.BuiltInAccelerometer", - "functionName": "setRange", - "returnType": "None", - "tooltip": "Set the measuring range of the accelerometer.\n\n:param range: The maximum acceleration, positive or negative, that the\n accelerometer will measure." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.CAN", - "classVariables": [ - { - "name": "kTeamDeviceType", - "tooltip": "", - "type": "hal.CANDeviceType", - "writable": false - }, - { - "name": "kTeamManufacturer", - "tooltip": "", - "type": "hal.CANManufacturer", - "writable": false - } - ], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "deviceId", - "type": "int" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "__init__", - "returnType": "wpilib.CAN", - "tooltip": "Create a new CAN communication interface with the specific device ID.\nThis uses the team manufacturer and device types.\nThe device ID is 6 bits (0-63)\n\n:param deviceId: The device id" - }, - { - "args": [ - { - "defaultValue": "", - "name": "deviceId", - "type": "int" - }, - { - "defaultValue": "", - "name": "deviceManufacturer", - "type": "int" - }, - { - "defaultValue": "", - "name": "deviceType", - "type": "int" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "__init__", - "returnType": "wpilib.CAN", - "tooltip": "Create a new CAN communication interface with a specific device ID,\nmanufacturer and device type. The device ID is 6 bits, the\nmanufacturer is 8 bits, and the device type is 5 bits.\n\n:param deviceId: The device ID\n:param deviceManufacturer: The device manufacturer\n:param deviceType: The device type" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.CAN" - }, - { - "defaultValue": "", - "name": "apiId", - "type": "int" - }, - { - "defaultValue": "", - "name": "data", - "type": "wpilib.CANData" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "readPacketLatest", - "returnType": "bool", - "tooltip": "Read a CAN packet. The will continuously return the last packet received,\nwithout accounting for packet age.\n\n:param apiId: The API ID to read.\n:param data: Storage for the received data.\n\n:returns: True if the data is valid, otherwise false." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.CAN" - }, - { - "defaultValue": "", - "name": "apiId", - "type": "int" - }, - { - "defaultValue": "", - "name": "data", - "type": "wpilib.CANData" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "readPacketNew", - "returnType": "bool", - "tooltip": "Read a new CAN packet. This will only return properly once per packet\nreceived. Multiple calls without receiving another packet will return\nfalse.\n\n:param apiId: The API ID to read.\n:param data: Storage for the received data.\n\n:returns: True if the data is valid, otherwise false." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.CAN" - }, - { - "defaultValue": "", - "name": "apiId", - "type": "int" - }, - { - "defaultValue": "", - "name": "timeoutMs", - "type": "int" - }, - { - "defaultValue": "", - "name": "data", - "type": "wpilib.CANData" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "readPacketTimeout", - "returnType": "bool", - "tooltip": "Read a CAN packet. The will return the last packet received until the\npacket is older then the requested timeout. Then it will return false.\n\n:param apiId: The API ID to read.\n:param timeoutMs: The timeout time for the packet\n:param data: Storage for the received data.\n\n:returns: True if the data is valid, otherwise false." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.CAN" - }, - { - "defaultValue": "", - "name": "apiId", - "type": "int" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "stopPacketRepeating", - "returnType": "None", - "tooltip": "Stop a repeating packet with a specific ID. This ID is 10 bits.\n\n:param apiId: The API ID to stop repeating" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.CAN" - }, - { - "defaultValue": "", - "name": "data", - "type": "Buffer" - }, - { - "defaultValue": "", - "name": "apiId", - "type": "int" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "writePacket", - "returnType": "None", - "tooltip": "Write a packet to the CAN device with a specific ID. This ID is 10 bits.\n\n:param data: The data to write (8 bytes max)\n:param length: The data length to write\n:param apiId: The API ID to write." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.CAN" - }, - { - "defaultValue": "", - "name": "data", - "type": "Buffer" - }, - { - "defaultValue": "", - "name": "apiId", - "type": "int" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "writePacketNoError", - "returnType": "int", - "tooltip": "Write a packet to the CAN device with a specific ID. This ID is 10 bits.\n\n:param data: The data to write (8 bytes max)\n:param length: The data length to write\n:param apiId: The API ID to write." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.CAN" - }, - { - "defaultValue": "", - "name": "data", - "type": "Buffer" - }, - { - "defaultValue": "", - "name": "apiId", - "type": "int" - }, - { - "defaultValue": "", - "name": "repeatMs", - "type": "int" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "writePacketRepeating", - "returnType": "None", - "tooltip": "Write a repeating packet to the CAN device with a specific ID. This ID is\n10 bits. The RoboRIO will automatically repeat the packet at the specified\ninterval\n\n:param data: The data to write (8 bytes max)\n:param length: The data length to write\n:param apiId: The API ID to write.\n:param repeatMs: The period to repeat the packet at." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.CAN" - }, - { - "defaultValue": "", - "name": "data", - "type": "Buffer" - }, - { - "defaultValue": "", - "name": "apiId", - "type": "int" - }, - { - "defaultValue": "", - "name": "repeatMs", - "type": "int" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "writePacketRepeatingNoError", - "returnType": "int", - "tooltip": "Write a repeating packet to the CAN device with a specific ID. This ID is\n10 bits. The RoboRIO will automatically repeat the packet at the specified\ninterval\n\n:param data: The data to write (8 bytes max)\n:param length: The data length to write\n:param apiId: The API ID to write.\n:param repeatMs: The period to repeat the packet at." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.CAN" - }, - { - "defaultValue": "", - "name": "length", - "type": "int" - }, - { - "defaultValue": "", - "name": "apiId", - "type": "int" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "writeRTRFrame", - "returnType": "None", - "tooltip": "Write an RTR frame to the CAN device with a specific ID. This ID is 10\nbits. The length by spec must match what is returned by the responding\ndevice\n\n:param length: The length to request (0 to 8)\n:param apiId: The API ID to write." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.CAN" - }, - { - "defaultValue": "", - "name": "length", - "type": "int" - }, - { - "defaultValue": "", - "name": "apiId", - "type": "int" - } - ], - "declaringClassName": "wpilib.CAN", - "functionName": "writeRTRFrameNoError", - "returnType": "int", - "tooltip": "Write an RTR frame to the CAN device with a specific ID. This ID is 10\nbits. The length by spec must match what is returned by the responding\ndevice\n\n:param length: The length to request (0 to 8)\n:param apiId: The API ID to write." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.CAN", - "functionName": "getTimestampBaseTime", - "returnType": "int", - "tooltip": "Reads the current value of the millisecond-resolution timer that CANData\ntimestamps are based on\n\n:returns: Current value of timer used as a base time for CANData timestamps\n in milliseconds" - } - ] - }, - { - "className": "wpilib.CANData", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.CANData", - "functionName": "__init__", - "returnType": "wpilib.CANData", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [ - { - "name": "data", - "tooltip": "Contents of the CAN packet.", - "type": "memoryview", - "writable": false - }, - { - "name": "length", - "tooltip": "Length of packet in bytes.", - "type": "int", - "writable": true - }, - { - "name": "timestamp", - "tooltip": "CAN frame timestamp in milliseconds.", - "type": "int", - "writable": true - } - ], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.CANStatus", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.CANStatus", - "functionName": "__init__", - "returnType": "wpilib.CANStatus", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [ - { - "name": "busOffCount", - "tooltip": "", - "type": "int", - "writable": true - }, - { - "name": "percentBusUtilization", - "tooltip": "", - "type": "float", - "writable": true - }, - { - "name": "receiveErrorCount", - "tooltip": "", - "type": "int", - "writable": true - }, - { - "name": "transmitErrorCount", - "tooltip": "", - "type": "int", - "writable": true - }, - { - "name": "txFullCount", - "tooltip": "", - "type": "int", - "writable": true - } - ], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.Color", - "classVariables": [ - { - "name": "kAliceBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kAntiqueWhite", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kAqua", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kAquamarine", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kAzure", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kBeige", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kBisque", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kBlack", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kBlanchedAlmond", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kBlueViolet", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kBrown", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kBurlywood", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kCadetBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kChartreuse", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kChocolate", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kCoral", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kCornflowerBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kCornsilk", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kCrimson", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kCyan", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkCyan", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkGoldenrod", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkGray", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkKhaki", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkMagenta", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkOliveGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkOrange", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkOrchid", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkRed", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkSalmon", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkSeaGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkSlateBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkSlateGray", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkTurquoise", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDarkViolet", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDeepPink", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDeepSkyBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDenim", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDimGray", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kDodgerBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kFirebrick", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kFirstBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kFirstRed", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kFloralWhite", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kForestGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kFuchsia", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kGainsboro", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kGhostWhite", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kGold", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kGoldenrod", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kGray", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kGreenYellow", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kHoneydew", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kHotPink", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kIndianRed", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kIndigo", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kIvory", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kKhaki", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLavender", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLavenderBlush", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLawnGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLemonChiffon", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightCoral", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightCyan", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightGoldenrodYellow", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightGray", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightPink", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightSalmon", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightSeaGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightSkyBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightSlateGray", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightSteelBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLightYellow", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLime", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLimeGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kLinen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMagenta", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMaroon", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMediumAquamarine", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMediumBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMediumOrchid", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMediumPurple", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMediumSeaGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMediumSlateBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMediumSpringGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMediumTurquoise", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMediumVioletRed", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMidnightBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMintcream", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMistyRose", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kMoccasin", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kNavajoWhite", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kNavy", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kOldLace", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kOlive", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kOliveDrab", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kOrange", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kOrangeRed", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kOrchid", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPaleGoldenrod", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPaleGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPaleTurquoise", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPaleVioletRed", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPapayaWhip", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPeachPuff", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPeru", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPink", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPlum", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPowderBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kPurple", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kRed", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kRosyBrown", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kRoyalBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSaddleBrown", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSalmon", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSandyBrown", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSeaGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSeashell", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSienna", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSilver", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSkyBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSlateBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSlateGray", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSnow", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSpringGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kSteelBlue", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kTan", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kTeal", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kThistle", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kTomato", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kTurquoise", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kViolet", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kWheat", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kWhite", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kWhiteSmoke", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kYellow", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - }, - { - "name": "kYellowGreen", - "tooltip": "", - "type": "wpilib.Color", - "writable": false - } - ], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.Color", - "functionName": "__init__", - "returnType": "wpilib.Color", - "tooltip": "Constructs a default color (black)." - }, - { - "args": [ - { - "defaultValue": "", - "name": "red", - "type": "float" - }, - { - "defaultValue": "", - "name": "green", - "type": "float" - }, - { - "defaultValue": "", - "name": "blue", - "type": "float" - } - ], - "declaringClassName": "wpilib.Color", - "functionName": "__init__", - "returnType": "wpilib.Color", - "tooltip": "Constructs a Color from doubles (0-1).\n\n:param red: Red value (0-1)\n:param green: Green value (0-1)\n:param blue: Blue value (0-1)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "r", - "type": "int" - }, - { - "defaultValue": "", - "name": "g", - "type": "int" - }, - { - "defaultValue": "", - "name": "b", - "type": "int" - } - ], - "declaringClassName": "wpilib.Color", - "functionName": "__init__", - "returnType": "wpilib.Color", - "tooltip": "Constructs a Color from ints (0-255).\n\n:param r: Red value (0-255)\n:param g: Green value (0-255)\n:param b: Blue value (0-255)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "hexString", - "type": "str" - } - ], - "declaringClassName": "wpilib.Color", - "functionName": "__init__", - "returnType": "wpilib.Color", - "tooltip": "Constructs a Color from a hex string.\n\n:param hexString: a string of the format \\#RRGGBB\n @throws std::invalid_argument if the hex string is invalid." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Color" - } - ], - "declaringClassName": "wpilib.Color", - "functionName": "hexString", - "returnType": "str", - "tooltip": "Return this color represented as a hex string.\n\n:returns: a string of the format \\#RRGGBB" - } - ], - "instanceVariables": [ - { - "name": "blue", - "tooltip": "Blue component (0-1).", - "type": "float", - "writable": false - }, - { - "name": "green", - "tooltip": "Green component (0-1).", - "type": "float", - "writable": false - }, - { - "name": "red", - "tooltip": "Red component (0-1).", - "type": "float", - "writable": false - } - ], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "h", - "type": "int" - }, - { - "defaultValue": "", - "name": "s", - "type": "int" - }, - { - "defaultValue": "", - "name": "v", - "type": "int" - } - ], - "declaringClassName": "wpilib.Color", - "functionName": "fromHSV", - "returnType": "wpilib.Color", - "tooltip": "Creates a Color from HSV values.\n\n:param h: The h value [0-180)\n:param s: The s value [0-255]\n:param v: The v value [0-255]\n\n:returns: The color" - } - ] - }, - { - "className": "wpilib.Color8Bit", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.Color8Bit", - "functionName": "__init__", - "returnType": "wpilib.Color8Bit", - "tooltip": "Constructs a default color (black)." - }, - { - "args": [ - { - "defaultValue": "", - "name": "red", - "type": "int" - }, - { - "defaultValue": "", - "name": "green", - "type": "int" - }, - { - "defaultValue": "", - "name": "blue", - "type": "int" - } - ], - "declaringClassName": "wpilib.Color8Bit", - "functionName": "__init__", - "returnType": "wpilib.Color8Bit", - "tooltip": "Constructs a Color8Bit.\n\n:param red: Red value (0-255)\n:param green: Green value (0-255)\n:param blue: Blue value (0-255)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "color", - "type": "wpilib.Color" - } - ], - "declaringClassName": "wpilib.Color8Bit", - "functionName": "__init__", - "returnType": "wpilib.Color8Bit", - "tooltip": "Constructs a Color8Bit from a Color.\n\n:param color: The color" - }, - { - "args": [ - { - "defaultValue": "", - "name": "hexString", - "type": "str" - } - ], - "declaringClassName": "wpilib.Color8Bit", - "functionName": "__init__", - "returnType": "wpilib.Color8Bit", - "tooltip": "Constructs a Color8Bit from a hex string.\n\n:param hexString: a string of the format \\#RRGGBB\n @throws std::invalid_argument if the hex string is invalid." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Color8Bit" - } - ], - "declaringClassName": "wpilib.Color8Bit", - "functionName": "hexString", - "returnType": "str", - "tooltip": "Return this color represented as a hex string.\n\n:returns: a string of the format \\#RRGGBB" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Color8Bit" - } - ], - "declaringClassName": "wpilib.Color8Bit", - "functionName": "toColor", - "returnType": "wpilib.Color", - "tooltip": "" - } - ], - "instanceVariables": [ - { - "name": "blue", - "tooltip": "Blue component (0-255).", - "type": "int", - "writable": false - }, - { - "name": "green", - "tooltip": "Green component (0-255).", - "type": "int", - "writable": false - }, - { - "name": "red", - "tooltip": "Red component (0-255).", - "type": "int", - "writable": false - } - ], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "hexString", - "type": "str" - } - ], - "declaringClassName": "wpilib.Color8Bit", - "functionName": "fromHexString", - "returnType": "wpilib.Color8Bit", - "tooltip": "Create a Color8Bit from a hex string.\n\n:param hexString: a string of the format \\#RRGGBB\n\n:returns: Color8Bit object from hex string.\n @throws std::invalid_argument if the hex string is invalid." - } - ] - }, - { - "className": "wpilib.Compressor", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "module", - "type": "int" - }, - { - "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "__init__", - "returnType": "wpilib.Compressor", - "tooltip": "Constructs a compressor for a specified module and type.\n\n:param module: The module ID to use.\n:param moduleType: The module type to use." - }, - { - "args": [ - { - "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "__init__", - "returnType": "wpilib.Compressor", - "tooltip": "Constructs a compressor for a default module and specified type.\n\n:param moduleType: The module type to use." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "disable", - "returnType": "None", - "tooltip": "Disable the compressor." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - }, - { - "defaultValue": "", - "name": "minPressure", - "type": "wpimath.units.pounds_per_square_inch" - }, - { - "defaultValue": "", - "name": "maxPressure", - "type": "wpimath.units.pounds_per_square_inch" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "enableAnalog", - "returnType": "None", - "tooltip": "If supported by the device, enables the compressor in analog mode. This\nmode uses an analog pressure sensor connected to analog channel 0 to cycle\nthe compressor. The compressor will turn on when the pressure drops below\n``minPressure`` and will turn off when the pressure reaches {@code\nmaxPressure}. This mode is only supported by the REV PH with the REV Analog\nPressure Sensor connected to analog channel 0.\n\nOn CTRE PCM, this will enable digital control.\n\n:param minPressure: The minimum pressure. The compressor will turn on when\n the pressure drops below this value.\n:param maxPressure: The maximum pressure. The compressor will turn off when\n the pressure reaches this value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "enableDigital", - "returnType": "None", - "tooltip": "Enables the compressor in digital mode using the digital pressure switch.\nThe compressor will turn on when the pressure switch indicates that the\nsystem is not full, and will turn off when the pressure switch indicates\nthat the system is full." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - }, - { - "defaultValue": "", - "name": "minPressure", - "type": "wpimath.units.pounds_per_square_inch" - }, - { - "defaultValue": "", - "name": "maxPressure", - "type": "wpimath.units.pounds_per_square_inch" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "enableHybrid", - "returnType": "None", - "tooltip": "If supported by the device, enables the compressor in hybrid mode. This\nmode uses both a digital pressure switch and an analog pressure sensor\nconnected to analog channel 0 to cycle the compressor. This mode is only\nsupported by the REV PH with the REV Analog Pressure Sensor connected to\nanalog channel 0.\n\nThe compressor will turn on when \\a both:\n\n- The digital pressure switch indicates the system is not full AND\n- The analog pressure sensor indicates that the pressure in the system\nis below the specified minimum pressure.\n\nThe compressor will turn off when \\a either:\n\n- The digital pressure switch is disconnected or indicates that the system\nis full OR\n- The pressure detected by the analog sensor is greater than the specified\nmaximum pressure.\n\nOn CTRE PCM, this will enable digital control.\n\n:param minPressure: The minimum pressure. The compressor will turn on\n when the pressure drops below this value and the pressure switch indicates\n that the system is not full.\n:param maxPressure: The maximum pressure. The compressor will turn\n off when the pressure reaches this value or the pressure switch is\n disconnected or indicates that the system is full." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "getAnalogVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "If supported by the device, returns the analog input voltage (on channel\n0).\n\nThis function is only supported by the REV PH. On CTRE PCM, this will\nreturn 0.\n\n:returns: The analog input voltage, in volts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "getConfigType", - "returnType": "wpilib.CompressorConfigType", - "tooltip": "Returns the active compressor configuration.\n\n:returns: The active compressor configuration." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "getCurrent", - "returnType": "wpimath.units.amperes", - "tooltip": "Get the current drawn by the compressor.\n\n:returns: Current drawn by the compressor." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "getPressure", - "returnType": "wpimath.units.pounds_per_square_inch", - "tooltip": "If supported by the device, returns the pressure read by the analog\npressure sensor (on channel 0).\n\nThis function is only supported by the REV PH with the REV Analog Pressure\nSensor. On CTRE PCM, this will return 0.\n\n:returns: The pressure read by the analog pressure sensor." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "getPressureSwitchValue", - "returnType": "bool", - "tooltip": "Returns the state of the pressure switch.\n\n:returns: True if pressure switch indicates that the system is not full,\n otherwise false." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Compressor" - } - ], - "declaringClassName": "wpilib.Compressor", - "functionName": "isEnabled", - "returnType": "bool", - "tooltip": "Returns whether the compressor is active or not.\n\n:returns: true if the compressor is on - otherwise false." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.Counter", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "mode", - "type": "wpilib.Counter.Mode" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "__init__", - "returnType": "wpilib.Counter", - "tooltip": "Create an instance of a counter where no sources are selected.\n\nThey all must be selected by calling functions to specify the up source and\nthe down source independently.\n\nThis creates a ChipObject counter and initializes status variables\nappropriately.\n\nThe counter will start counting immediately.\n\n:param mode: The counter mode" - }, - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "__init__", - "returnType": "wpilib.Counter", - "tooltip": "Create an instance of a Counter object.\n\nCreate an up-Counter instance given a channel.\n\nThe counter will start counting immediately.\n\n:param channel: The DIO channel to use as the up source. 0-9 are on-board,\n 10-25 are on the MXP" - }, - { - "args": [ - { - "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "__init__", - "returnType": "wpilib.Counter", - "tooltip": "Create an instance of a counter from a Digital Source (such as a Digital\nInput).\n\nThis is used if an existing digital input is to be shared by multiple other\nobjects such as encoders or if the Digital Source is not a Digital Input\nchannel (such as an Analog %Trigger).\n\nThe counter will start counting immediately.\n\n:param source: A pointer to the existing DigitalSource object. It will be\n set as the Up Source." - }, - { - "args": [ - { - "defaultValue": "", - "name": "trigger", - "type": "wpilib.AnalogTrigger" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "__init__", - "returnType": "wpilib.Counter", - "tooltip": "Create an instance of a Counter object.\n\nCreate an instance of a simple up-Counter given an analog trigger.\nUse the trigger state output from the analog trigger.\n\nThe counter will start counting immediately.\n\n:param trigger: The reference to the existing AnalogTrigger object." - }, - { - "args": [ - { - "defaultValue": "", - "name": "encodingType", - "type": "wpilib.interfaces.CounterBase.EncodingType" - }, - { - "defaultValue": "", - "name": "upSource", - "type": "wpilib.DigitalSource" - }, - { - "defaultValue": "", - "name": "downSource", - "type": "wpilib.DigitalSource" - }, - { - "defaultValue": "", - "name": "inverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "__init__", - "returnType": "wpilib.Counter", - "tooltip": "Create an instance of a Counter object.\n\nCreates a full up-down counter given two Digital Sources.\n\n:param encodingType: The quadrature decoding mode (1x or 2x)\n:param upSource: The pointer to the DigitalSource to set as the up\n source\n:param downSource: The pointer to the DigitalSource to set as the down\n source\n:param inverted: True to invert the output (reverse the direction)" - } - ], - "enums": [ - { - "enumClassName": "wpilib.Counter.Mode", - "enumValues": [ - "kExternalDirection", - "kPulseLength", - "kSemiperiod", - "kTwoPulse" - ], - "moduleName": "wpilib", - "tooltip": "Members:\n\n kTwoPulse\n\n kSemiperiod\n\n kPulseLength\n\n kExternalDirection" - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "clearDownSource", - "returnType": "None", - "tooltip": "Disable the down counting source to the counter." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "clearUpSource", - "returnType": "None", - "tooltip": "Disable the up counting source to the counter." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "get", - "returnType": "int", - "tooltip": "Read the current counter value.\n\nRead the value at this instant. It may still be running, so it reflects the\ncurrent value. Next time it is read, it might have a different value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "getDirection", - "returnType": "bool", - "tooltip": "The last direction the counter value changed.\n\n:returns: The last direction the counter value changed." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "getDistance", - "returnType": "float", - "tooltip": "Read the current scaled counter value. Read the value at this instant,\nscaled by the distance per pulse (defaults to 1).\n\n:returns: The distance since the last reset" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "getFPGAIndex", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "getPeriod", - "returnType": "wpimath.units.seconds", - "tooltip": "Get the Period of the most recent count.\n\nReturns the time interval of the most recent count. This can be used for\nvelocity calculations to determine shaft speed.\n\n:returns: The period between the last two pulses in units of seconds." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "getRate", - "returnType": "float", - "tooltip": "Get the current rate of the Counter. Read the current rate of the counter\naccounting for the distance per pulse value. The default value for distance\nper pulse (1) yields units of pulses per second.\n\n:returns: The rate in units/sec" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "getSamplesToAverage", - "returnType": "int", - "tooltip": "Get the Samples to Average which specifies the number of samples of the\ntimer to average when calculating the period.\n\nPerform averaging to account for mechanical imperfections or as\noversampling to increase resolution.\n\n:returns: The number of samples being averaged (from 1 to 127)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "getStopped", - "returnType": "bool", - "tooltip": "Determine if the clock is stopped.\n\nDetermine if the clocked input is stopped based on the MaxPeriod value set\nusing the SetMaxPeriod method. If the clock exceeds the MaxPeriod, then the\ndevice (and counter) are assumed to be stopped and it returns true.\n\n:returns: Returns true if the most recent counter period exceeds the\n MaxPeriod value set by SetMaxPeriod." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "reset", - "returnType": "None", - "tooltip": "Reset the Counter to zero.\n\nSet the counter value to zero. This doesn't effect the running state of the\ncounter, just sets the current value to zero." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "distancePerPulse", - "type": "float" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setDistancePerPulse", - "returnType": "None", - "tooltip": "Set the distance per pulse for this counter. This sets the multiplier used\nto determine the distance driven based on the count value from the encoder.\nSet this value based on the Pulses per Revolution and factor in any gearing\nreductions. This distance can be in any units you like, linear or angular.\n\n:param distancePerPulse: The scale factor that will be used to convert\n pulses to useful units." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setDownSource", - "returnType": "None", - "tooltip": "Set the down counting source to be a digital input channel.\n\n:param channel: The DIO channel to use as the up source. 0-9 are on-board,\n 10-25 are on the MXP" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "analogTrigger", - "type": "wpilib.AnalogTrigger" - }, - { - "defaultValue": "", - "name": "triggerType", - "type": "wpilib.AnalogTriggerType" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setDownSource", - "returnType": "None", - "tooltip": "Set the down counting source to be an analog trigger.\n\n:param analogTrigger: The analog trigger object that is used for the Down\n Source\n:param triggerType: The analog trigger output that will trigger the\n counter." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setDownSource", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "risingEdge", - "type": "bool" - }, - { - "defaultValue": "", - "name": "fallingEdge", - "type": "bool" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setDownSourceEdge", - "returnType": "None", - "tooltip": "Set the edge sensitivity on a down counting source.\n\nSet the down source to either detect rising edges or falling edges.\n\n:param risingEdge: True to trigger on rising edges\n:param fallingEdge: True to trigger on falling edges" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setExternalDirectionMode", - "returnType": "None", - "tooltip": "Set external direction mode on this counter.\n\nCounts are sourced on the Up counter input.\nThe Down counter input represents the direction to count." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "maxPeriod", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setMaxPeriod", - "returnType": "None", - "tooltip": "Set the maximum period where the device is still considered \"moving\".\n\nSets the maximum period where the device is considered moving. This value\nis used to determine the \"stopped\" state of the counter using the\nGetStopped method.\n\n:param maxPeriod: The maximum period where the counted device is considered\n moving in seconds." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setPulseLengthMode", - "returnType": "None", - "tooltip": "Configure the counter to count in up or down based on the length of the\ninput pulse.\n\nThis mode is most useful for direction sensitive gear tooth sensors.\n\n:param threshold: The pulse length beyond which the counter counts the\n opposite direction. Units are seconds." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "reverseDirection", - "type": "bool" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setReverseDirection", - "returnType": "None", - "tooltip": "Set the Counter to return reversed sensing on the direction.\n\nThis allows counters to change the direction they are counting in the case\nof 1X and 2X quadrature encoding only. Any other counter mode isn't\nsupported.\n\n:param reverseDirection: true if the value counted should be negated." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "samplesToAverage", - "type": "int" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setSamplesToAverage", - "returnType": "None", - "tooltip": "Set the Samples to Average which specifies the number of samples of the\ntimer to average when calculating the period. Perform averaging to account\nfor mechanical imperfections or as oversampling to increase resolution.\n\n:param samplesToAverage: The number of samples to average from 1 to 127." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "highSemiPeriod", - "type": "bool" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setSemiPeriodMode", - "returnType": "None", - "tooltip": "Set Semi-period mode on this counter.\n\nCounts up on both rising and falling edges." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setUpDownCounterMode", - "returnType": "None", - "tooltip": "Set standard up / down counting mode on this counter.\n\nUp and down counts are sourced independently from two inputs." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setUpSource", - "returnType": "None", - "tooltip": "Set the up source for the counter as a digital input channel.\n\n:param channel: The DIO channel to use as the up source. 0-9 are on-board,\n 10-25 are on the MXP" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "analogTrigger", - "type": "wpilib.AnalogTrigger" - }, - { - "defaultValue": "", - "name": "triggerType", - "type": "wpilib.AnalogTriggerType" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setUpSource", - "returnType": "None", - "tooltip": "Set the up counting source to be an analog trigger.\n\n:param analogTrigger: The analog trigger object that is used for the Up\n Source\n:param triggerType: The analog trigger output that will trigger the\n counter." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setUpSource", - "returnType": "None", - "tooltip": "Set the source object that causes the counter to count up.\n\nSet the up counting DigitalSource.\n\n:param source: Pointer to the DigitalSource object to set as the up source" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "risingEdge", - "type": "bool" - }, - { - "defaultValue": "", - "name": "fallingEdge", - "type": "bool" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setUpSourceEdge", - "returnType": "None", - "tooltip": "Set the edge sensitivity on an up counting source.\n\nSet the up source to either detect rising edges or falling edges or both.\n\n:param risingEdge: True to trigger on rising edges\n:param fallingEdge: True to trigger on falling edges" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Counter" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.Counter", - "functionName": "setUpdateWhenEmpty", - "returnType": "None", - "tooltip": "Select whether you want to continue updating the event timer output when\nthere are no samples captured.\n\nThe output of the event timer has a buffer of periods that are averaged and\nposted to a register on the FPGA. When the timer detects that the event\nsource has stopped (based on the MaxPeriod) the buffer of samples to be\naveraged is emptied. If you enable the update when empty, you will be\nnotified of the stopped source and the event time will report 0 samples.\nIf you disable update when empty, the most recent average will remain on\nthe output until a new sample is acquired. You will never see 0 samples\noutput (except when there have been no events since an FPGA reset) and you\nwill likely not see the stopped bit become true (since it is updated at the\nend of an average and there are no samples to average).\n\n:param enabled: True to enable update when empty" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.DMC60", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.DMC60", - "functionName": "__init__", - "returnType": "wpilib.DMC60", - "tooltip": "Constructor for a DMC 60 connected via PWM.\n\n:param channel: The PWM channel that the DMC 60 is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.DMC60", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.DSControlWord", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "__init__", - "returnType": "wpilib.DSControlWord", - "tooltip": "DSControlWord constructor.\n\nUpon construction, the current Driver Station control word is read and\nstored internally." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DSControlWord" - } - ], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "isAutonomous", - "returnType": "bool", - "tooltip": "Check if the DS is commanding autonomous mode.\n\n:returns: True if the robot is being commanded to be in autonomous mode" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DSControlWord" - } - ], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "isAutonomousEnabled", - "returnType": "bool", - "tooltip": "Check if the DS is commanding autonomous mode and if it has enabled the\nrobot.\n\n:returns: True if the robot is being commanded to be in autonomous mode and\n enabled." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DSControlWord" - } - ], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "isDSAttached", - "returnType": "bool", - "tooltip": "Check if the DS is attached.\n\n:returns: True if the DS is connected to the robot" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DSControlWord" - } - ], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "isDisabled", - "returnType": "bool", - "tooltip": "Check if the robot is disabled.\n\n:returns: True if the robot is explicitly disabled or the DS is not connected" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DSControlWord" - } - ], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "isEStopped", - "returnType": "bool", - "tooltip": "Check if the robot is e-stopped.\n\n:returns: True if the robot is e-stopped" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DSControlWord" - } - ], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "isEnabled", - "returnType": "bool", - "tooltip": "Check if the DS has enabled the robot.\n\n:returns: True if the robot is enabled and the DS is connected" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DSControlWord" - } - ], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "isFMSAttached", - "returnType": "bool", - "tooltip": "Is the driver station attached to a Field Management System?\n\n:returns: True if the robot is competing on a field being controlled by a\n Field Management System" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DSControlWord" - } - ], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "isTeleop", - "returnType": "bool", - "tooltip": "Check if the DS is commanding teleop mode.\n\n:returns: True if the robot is being commanded to be in teleop mode" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DSControlWord" - } - ], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "isTeleopEnabled", - "returnType": "bool", - "tooltip": "Check if the DS is commanding teleop mode and if it has enabled the robot.\n\n:returns: True if the robot is being commanded to be in teleop mode and\n enabled." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DSControlWord" - } - ], - "declaringClassName": "wpilib.DSControlWord", - "functionName": "isTest", - "returnType": "bool", - "tooltip": "Check if the DS is commanding test mode.\n\n:returns: True if the robot is being commanded to be in test mode" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.DataLogManager", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.DataLogManager", - "functionName": "__init__", - "returnType": "wpilib.DataLogManager", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.DataLogManager", - "functionName": "getLog", - "returnType": "wpiutil.log.DataLog", - "tooltip": "Get the managed data log (for custom logging). Starts the data log manager\nif not already started.\n\n:returns: data log" - }, - { - "args": [], - "declaringClassName": "wpilib.DataLogManager", - "functionName": "getLogDir", - "returnType": "str", - "tooltip": "Get the log directory.\n\n:returns: log directory" - }, - { - "args": [ - { - "defaultValue": "", - "name": "message", - "type": "str" - } - ], - "declaringClassName": "wpilib.DataLogManager", - "functionName": "log", - "returnType": "None", - "tooltip": "Log a message to the \"messages\" entry. The message is also printed to\nstandard output (followed by a newline).\n\n:param message: message" - }, - { - "args": [ - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.DataLogManager", - "functionName": "logConsoleOutput", - "returnType": "None", - "tooltip": "Enable or disable logging of the console output. Defaults to enabled.\n\n:param enabled: true to enable, false to disable" - }, - { - "args": [ - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.DataLogManager", - "functionName": "logNetworkTables", - "returnType": "None", - "tooltip": "Enable or disable logging of NetworkTables data. Note that unlike the\nnetwork interface for NetworkTables, this will capture every value change.\nDefaults to enabled.\n\n:param enabled: true to enable, false to disable" - }, - { - "args": [ - { - "defaultValue": "''", - "name": "dir", - "type": "str" - }, - { - "defaultValue": "''", - "name": "filename", - "type": "str" - }, - { - "defaultValue": "0.25", - "name": "period", - "type": "float" - } - ], - "declaringClassName": "wpilib.DataLogManager", - "functionName": "start", - "returnType": "None", - "tooltip": "Start data log manager. The parameters have no effect if the data log\nmanager was already started (e.g. by calling another static function).\n\n:param dir: if not empty, directory to use for data log storage\n:param filename: filename to use; if none provided, the filename is\n automatically generated\n:param period: time between automatic flushes to disk, in seconds;\n this is a time/storage tradeoff" - }, - { - "args": [], - "declaringClassName": "wpilib.DataLogManager", - "functionName": "stop", - "returnType": "None", - "tooltip": "Stop data log manager." - } - ] - }, - { - "className": "wpilib.DigitalGlitchFilter", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "__init__", - "returnType": "wpilib.DigitalGlitchFilter", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - }, - { - "defaultValue": "", - "name": "input", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "add", - "returnType": "None", - "tooltip": "Assigns the DigitalSource to this glitch filter.\n\n:param input: The DigitalSource to add." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - }, - { - "defaultValue": "", - "name": "input", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "add", - "returnType": "None", - "tooltip": "Assigns the Encoder to this glitch filter.\n\n:param input: The Encoder to add." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - }, - { - "defaultValue": "", - "name": "input", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "add", - "returnType": "None", - "tooltip": "Assigns the Counter to this glitch filter.\n\n:param input: The Counter to add." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "getPeriodCycles", - "returnType": "int", - "tooltip": "Gets the number of cycles that the input must not change state for.\n\n:returns: The number of cycles." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "getPeriodNanoSeconds", - "returnType": "int", - "tooltip": "Gets the number of nanoseconds that the input must not change state for.\n\n:returns: The number of nanoseconds." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - }, - { - "defaultValue": "", - "name": "input", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "remove", - "returnType": "None", - "tooltip": "Removes a digital input from this filter.\n\nRemoves the DigitalSource from this glitch filter and re-assigns it to\nthe default filter.\n\n:param input: The DigitalSource to remove." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - }, - { - "defaultValue": "", - "name": "input", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "remove", - "returnType": "None", - "tooltip": "Removes an encoder from this filter.\n\nRemoves the Encoder from this glitch filter and re-assigns it to\nthe default filter.\n\n:param input: The Encoder to remove." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - }, - { - "defaultValue": "", - "name": "input", - "type": "wpilib.Counter" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "remove", - "returnType": "None", - "tooltip": "Removes a counter from this filter.\n\nRemoves the Counter from this glitch filter and re-assigns it to\nthe default filter.\n\n:param input: The Counter to remove." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - }, - { - "defaultValue": "", - "name": "fpgaCycles", - "type": "int" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "setPeriodCycles", - "returnType": "None", - "tooltip": "Sets the number of cycles that the input must not change state for.\n\n:param fpgaCycles: The number of FPGA cycles." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalGlitchFilter" - }, - { - "defaultValue": "", - "name": "nanoseconds", - "type": "int" - } - ], - "declaringClassName": "wpilib.DigitalGlitchFilter", - "functionName": "setPeriodNanoSeconds", - "returnType": "None", - "tooltip": "Sets the number of nanoseconds that the input must not change state for.\n\n:param nanoseconds: The number of nanoseconds." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.DigitalInput", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.DigitalInput", - "functionName": "__init__", - "returnType": "wpilib.DigitalInput", - "tooltip": "Create an instance of a Digital Input class.\n\nCreates a digital input given a channel.\n\n:param channel: The DIO channel 0-9 are on-board, 10-25 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalInput" - } - ], - "declaringClassName": "wpilib.DigitalInput", - "functionName": "get", - "returnType": "bool", - "tooltip": "Get the value from a digital input channel.\n\nRetrieve the value of a single digital input channel from the FPGA." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalInput" - } - ], - "declaringClassName": "wpilib.DigitalInput", - "functionName": "getAnalogTriggerTypeForRouting", - "returnType": "wpilib.AnalogTriggerType", - "tooltip": ":returns: The type of analog trigger output to be used. 0 for Digitals" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalInput" - } - ], - "declaringClassName": "wpilib.DigitalInput", - "functionName": "getChannel", - "returnType": "int", - "tooltip": ":returns: The GPIO channel number that this object represents." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalInput" - } - ], - "declaringClassName": "wpilib.DigitalInput", - "functionName": "getPortHandleForRouting", - "returnType": "int", - "tooltip": ":returns: The HAL Handle to the specified source." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalInput" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.DigitalInput", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalInput" - } - ], - "declaringClassName": "wpilib.DigitalInput", - "functionName": "isAnalogTrigger", - "returnType": "bool", - "tooltip": "Is source an AnalogTrigger" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalInput" - }, - { - "defaultValue": "", - "name": "device", - "type": "int" - } - ], - "declaringClassName": "wpilib.DigitalInput", - "functionName": "setSimDevice", - "returnType": "None", - "tooltip": "Indicates this input is used by a simulated device.\n\n:param device: simulated device handle" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.DigitalOutput", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "__init__", - "returnType": "wpilib.DigitalOutput", - "tooltip": "Create an instance of a digital output.\n\nCreate a digital output given a channel.\n\n:param channel: The digital channel 0-9 are on-board, 10-25 are on the MXP\n port" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "disablePWM", - "returnType": "None", - "tooltip": "Change this line from a PWM output back to a static Digital Output line.\n\nFree up one of the 6 DO PWM generator resources that were in use." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - }, - { - "defaultValue": "", - "name": "dutyCycle", - "type": "float" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "enablePPS", - "returnType": "None", - "tooltip": "Enable a PWM PPS (Pulse Per Second) Output on this line.\n\nAllocate one of the 6 DO PWM generator resources from this module.\n\nSupply the duty-cycle to output.\n\nThe resolution of the duty cycle is 8-bit.\n\n:param dutyCycle: The duty-cycle to start generating. [0..1]" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - }, - { - "defaultValue": "", - "name": "initialDutyCycle", - "type": "float" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "enablePWM", - "returnType": "None", - "tooltip": "Enable a PWM Output on this line.\n\nAllocate one of the 6 DO PWM generator resources from this module.\n\nSupply the initial duty-cycle to output so as to avoid a glitch when first\nstarting.\n\nThe resolution of the duty cycle is 8-bit for low frequencies (1kHz or\nless) but is reduced the higher the frequency of the PWM signal is.\n\n:param initialDutyCycle: The duty-cycle to start generating. [0..1]" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "get", - "returnType": "bool", - "tooltip": "Gets the value being output from the Digital Output.\n\n:returns: the state of the digital output." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "getAnalogTriggerTypeForRouting", - "returnType": "wpilib.AnalogTriggerType", - "tooltip": ":returns: The type of analog trigger output to be used. 0 for Digitals" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "getChannel", - "returnType": "int", - "tooltip": ":returns: The GPIO channel number that this object represents." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "getPortHandleForRouting", - "returnType": "int", - "tooltip": ":returns: The HAL Handle to the specified source." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "isAnalogTrigger", - "returnType": "bool", - "tooltip": "Is source an AnalogTrigger" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "isPulsing", - "returnType": "bool", - "tooltip": "Determine if the pulse is still going.\n\nDetermine if a previously started pulse is still going." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - }, - { - "defaultValue": "", - "name": "pulseLength", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "pulse", - "returnType": "None", - "tooltip": "Output a single pulse on the digital output line.\n\nSend a single pulse on the digital output line where the pulse duration is\nspecified in seconds. Maximum of 65535 microseconds.\n\n:param pulseLength: The pulse length in seconds" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - }, - { - "defaultValue": "", - "name": "value", - "type": "bool" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the value of a digital output.\n\nSet the value of a digital output to either one (true) or zero (false).\n\n:param value: 1 (true) for high, 0 (false) for disabled" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - }, - { - "defaultValue": "", - "name": "rate", - "type": "float" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "setPWMRate", - "returnType": "None", - "tooltip": "Change the PWM frequency of the PWM output on a Digital Output line.\n\nThe valid range is from 0.6 Hz to 19 kHz. The frequency resolution is\nlogarithmic.\n\nThere is only one PWM frequency for all digital channels.\n\n:param rate: The frequency to output all digital output PWM signals." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - }, - { - "defaultValue": "", - "name": "device", - "type": "int" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "setSimDevice", - "returnType": "None", - "tooltip": "Indicates this output is used by a simulated device.\n\n:param device: simulated device handle" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalOutput" - }, - { - "defaultValue": "", - "name": "dutyCycle", - "type": "float" - } - ], - "declaringClassName": "wpilib.DigitalOutput", - "functionName": "updateDutyCycle", - "returnType": "None", - "tooltip": "Change the duty-cycle that is being generated on the line.\n\nThe resolution of the duty cycle is 8-bit for low frequencies (1kHz or\nless) but is reduced the higher the frequency of the PWM signal is.\n\n:param dutyCycle: The duty-cycle to change to. [0..1]" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.DigitalSource", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.DigitalSource", - "functionName": "__init__", - "returnType": "wpilib.DigitalSource", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.DigitalSource", - "functionName": "getAnalogTriggerTypeForRouting", - "returnType": "wpilib.AnalogTriggerType", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.DigitalSource", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.DigitalSource", - "functionName": "getPortHandleForRouting", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.DigitalSource", - "functionName": "isAnalogTrigger", - "returnType": "bool", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.DoubleSolenoid", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "module", - "type": "int" - }, - { - "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" - }, - { - "defaultValue": "", - "name": "forwardChannel", - "type": "int" - }, - { - "defaultValue": "", - "name": "reverseChannel", - "type": "int" - } - ], - "declaringClassName": "wpilib.DoubleSolenoid", - "functionName": "__init__", - "returnType": "wpilib.DoubleSolenoid", - "tooltip": "Constructs a double solenoid for a specified module of a specific module\ntype.\n\n:param module: The module of the solenoid module to use.\n:param moduleType: The module type to use.\n:param forwardChannel: The forward channel on the module to control.\n:param reverseChannel: The reverse channel on the module to control." - }, - { - "args": [ - { - "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" - }, - { - "defaultValue": "", - "name": "forwardChannel", - "type": "int" - }, - { - "defaultValue": "", - "name": "reverseChannel", - "type": "int" - } - ], - "declaringClassName": "wpilib.DoubleSolenoid", - "functionName": "__init__", - "returnType": "wpilib.DoubleSolenoid", - "tooltip": "Constructs a double solenoid for a default module of a specific module\ntype.\n\n:param moduleType: The module type to use.\n:param forwardChannel: The forward channel on the module to control.\n:param reverseChannel: The reverse channel on the module to control." - } - ], - "enums": [ - { - "enumClassName": "wpilib.DoubleSolenoid.Value", - "enumValues": [ - "kForward", - "kOff", - "kReverse" - ], - "moduleName": "wpilib", - "tooltip": "Possible values for a DoubleSolenoid.\n\nMembers:\n\n kOff : Off position.\n\n kForward : Forward position.\n\n kReverse : Reverse position." - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DoubleSolenoid" - } - ], - "declaringClassName": "wpilib.DoubleSolenoid", - "functionName": "get", - "returnType": "wpilib.DoubleSolenoid.Value", - "tooltip": "Read the current value of the solenoid.\n\n:returns: The current value of the solenoid." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DoubleSolenoid" - } - ], - "declaringClassName": "wpilib.DoubleSolenoid", - "functionName": "getFwdChannel", - "returnType": "int", - "tooltip": "Get the forward channel.\n\n:returns: the forward channel." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DoubleSolenoid" - } - ], - "declaringClassName": "wpilib.DoubleSolenoid", - "functionName": "getRevChannel", - "returnType": "int", - "tooltip": "Get the reverse channel.\n\n:returns: the reverse channel." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DoubleSolenoid" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.DoubleSolenoid", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DoubleSolenoid" - } - ], - "declaringClassName": "wpilib.DoubleSolenoid", - "functionName": "isFwdSolenoidDisabled", - "returnType": "bool", - "tooltip": "Check if the forward solenoid is Disabled.\n\nIf a solenoid is shorted, it is added to the DisabledList and disabled\nuntil power cycle, or until faults are cleared.\n\n@see ClearAllStickyFaults()\n\n:returns: If solenoid is disabled due to short." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DoubleSolenoid" - } - ], - "declaringClassName": "wpilib.DoubleSolenoid", - "functionName": "isRevSolenoidDisabled", - "returnType": "bool", - "tooltip": "Check if the reverse solenoid is Disabled.\n\nIf a solenoid is shorted, it is added to the DisabledList and disabled\nuntil power cycle, or until faults are cleared.\n\n@see ClearAllStickyFaults()\n\n:returns: If solenoid is disabled due to short." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DoubleSolenoid" - }, - { - "defaultValue": "", - "name": "value", - "type": "wpilib.DoubleSolenoid.Value" - } - ], - "declaringClassName": "wpilib.DoubleSolenoid", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the value of a solenoid.\n\n:param value: The value to set (Off, Forward or Reverse)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DoubleSolenoid" - } - ], - "declaringClassName": "wpilib.DoubleSolenoid", - "functionName": "toggle", - "returnType": "None", - "tooltip": "Toggle the value of the solenoid.\n\nIf the solenoid is set to forward, it'll be set to reverse. If the solenoid\nis set to reverse, it'll be set to forward. If the solenoid is set to off,\nnothing happens." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.DriverStation", - "classVariables": [ - { - "name": "kJoystickPorts", - "tooltip": "", - "type": "int", - "writable": false - } - ], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "__init__", - "returnType": "wpilib.DriverStation", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [ - { - "enumClassName": "wpilib.DriverStation.Alliance", - "enumValues": [ - "kBlue", - "kRed" - ], - "moduleName": "wpilib", - "tooltip": "The robot alliance that the robot is a part of.\n\nMembers:\n\n kRed : Red alliance.\n\n kBlue : Blue alliance." - }, - { - "enumClassName": "wpilib.DriverStation.MatchType", - "enumValues": [ - "kElimination", - "kNone", - "kPractice", - "kQualification" - ], - "moduleName": "wpilib", - "tooltip": "The type of robot match that the robot is part of.\n\nMembers:\n\n kNone : None.\n\n kPractice : Practice.\n\n kQualification : Qualification.\n\n kElimination : Elimination." - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DriverStation" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getControlState", - "returnType": "tuple[bool, bool, bool]", - "tooltip": "More efficient way to determine what state the robot is in.\n\n:returns: booleans representing enabled, isautonomous, istest\n\n.. versionadded:: 2019.2.1\n\n.. note:: This function only exists in RobotPy" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getAlliance", - "returnType": "Optional[wpilib.DriverStation.Alliance]", - "tooltip": "Get the current alliance from the FMS.\n\nIf the FMS is not connected, it is set from the team alliance setting on\nthe driver station.\n\n:returns: The alliance (red or blue) or an empty optional if the alliance is\n invalid" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getBatteryVoltage", - "returnType": "float", - "tooltip": "Read the battery voltage.\n\n:returns: The battery voltage in Volts." - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getEventName", - "returnType": "str", - "tooltip": "Returns the name of the competition event provided by the FMS.\n\n:returns: A string containing the event name" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getGameSpecificMessage", - "returnType": "str", - "tooltip": "Returns the game specific message provided by the FMS.\n\nIf the FMS is not connected, it is set from the game data setting on the\ndriver station.\n\n:returns: A string containing the game specific message." - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getJoystickAxisType", - "returnType": "int", - "tooltip": "Returns the types of Axes on a given joystick port.\n\n:param stick: The joystick port number and the target axis\n:param axis: The analog axis value to read from the joystick.\n\n:returns: What type of axis the axis is reporting to be" - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getJoystickIsXbox", - "returnType": "bool", - "tooltip": "Returns a boolean indicating if the controller is an xbox controller.\n\n:param stick: The joystick port number\n\n:returns: A boolean that is true if the controller is an xbox controller." - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getJoystickName", - "returnType": "str", - "tooltip": "Returns the name of the joystick at the given port.\n\n:param stick: The joystick port number\n\n:returns: The name of the joystick at the given port" - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getJoystickType", - "returnType": "int", - "tooltip": "Returns the type of joystick at a given port.\n\n:param stick: The joystick port number\n\n:returns: The HID type of joystick at the given port" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getLocation", - "returnType": "Optional[int]", - "tooltip": "Return the driver station location from the FMS.\n\nIf the FMS is not connected, it is set from the team alliance setting on\nthe driver station.\n\nThis could return 1, 2, or 3.\n\n:returns: The location of the driver station (1-3, 0 for invalid)" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getMatchNumber", - "returnType": "int", - "tooltip": "Returns the match number provided by the FMS.\n\n:returns: The number of the match" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getMatchTime", - "returnType": "wpimath.units.seconds", - "tooltip": "Return the approximate match time. The FMS does not send an official match\ntime to the robots, but does send an approximate match time. The value will\ncount down the time remaining in the current period (auto or teleop).\nWarning: This is not an official time (so it cannot be used to dispute ref\ncalls or guarantee that a function will trigger before the match ends).\n\nWhen connected to the real field, this number only changes in full\ninteger increments, and always counts down.\n\nWhen the DS is in practice mode, this number is a floating point number,\nand counts down.\n\nWhen the DS is in teleop or autonomous mode, this number is a floating\npoint number, and counts up.\n\nSimulation matches DS behavior without an FMS connected.\n\n:returns: Time remaining in current match period (auto or teleop) in seconds" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getMatchType", - "returnType": "wpilib.DriverStation.MatchType", - "tooltip": "Returns the type of match being played provided by the FMS.\n\n:returns: The match type enum (kNone, kPractice, kQualification,\n kElimination)" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getReplayNumber", - "returnType": "int", - "tooltip": "Returns the number of times the current match has been replayed from the\nFMS.\n\n:returns: The number of replays" - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getStickAxis", - "returnType": "float", - "tooltip": "Get the value of the axis on a joystick.\n\nThis depends on the mapping of the joystick connected to the specified\nport.\n\n:param stick: The joystick to read.\n:param axis: The analog axis value to read from the joystick.\n\n:returns: The value of the axis on the joystick." - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getStickAxisCount", - "returnType": "int", - "tooltip": "Returns the number of axes on a given joystick port.\n\n:param stick: The joystick port number\n\n:returns: The number of axes on the indicated joystick" - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getStickButton", - "returnType": "bool", - "tooltip": "The state of one joystick button. %Button indexes begin at 1.\n\n:param stick: The joystick to read.\n:param button: The button index, beginning at 1.\n\n:returns: The state of the joystick button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getStickButtonCount", - "returnType": "int", - "tooltip": "Returns the number of buttons on a given joystick port.\n\n:param stick: The joystick port number\n\n:returns: The number of buttons on the indicated joystick" - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getStickButtonPressed", - "returnType": "bool", - "tooltip": "Whether one joystick button was pressed since the last check. %Button\nindexes begin at 1.\n\n:param stick: The joystick to read.\n:param button: The button index, beginning at 1.\n\n:returns: Whether the joystick button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getStickButtonReleased", - "returnType": "bool", - "tooltip": "Whether one joystick button was released since the last check. %Button\nindexes begin at 1.\n\n:param stick: The joystick to read.\n:param button: The button index, beginning at 1.\n\n:returns: Whether the joystick button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getStickButtons", - "returnType": "int", - "tooltip": "The state of the buttons on the joystick.\n\n:param stick: The joystick to read.\n\n:returns: The state of the buttons on the joystick." - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - }, - { - "defaultValue": "", - "name": "pov", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getStickPOV", - "returnType": "int", - "tooltip": "Get the state of a POV on the joystick.\n\n:returns: the angle of the POV in degrees, or -1 if the POV is not pressed." - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "getStickPOVCount", - "returnType": "int", - "tooltip": "Returns the number of POVs on a given joystick port.\n\n:param stick: The joystick port number\n\n:returns: The number of POVs on the indicated joystick" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isAutonomous", - "returnType": "bool", - "tooltip": "Check if the DS is commanding autonomous mode.\n\n:returns: True if the robot is being commanded to be in autonomous mode" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isAutonomousEnabled", - "returnType": "bool", - "tooltip": "Check if the DS is commanding autonomous mode and if it has enabled the\nrobot.\n\n:returns: True if the robot is being commanded to be in autonomous mode and\n enabled." - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isDSAttached", - "returnType": "bool", - "tooltip": "Check if the DS is attached.\n\n:returns: True if the DS is connected to the robot" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isDisabled", - "returnType": "bool", - "tooltip": "Check if the robot is disabled.\n\n:returns: True if the robot is explicitly disabled or the DS is not connected" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isEStopped", - "returnType": "bool", - "tooltip": "Check if the robot is e-stopped.\n\n:returns: True if the robot is e-stopped" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isEnabled", - "returnType": "bool", - "tooltip": "Check if the DS has enabled the robot.\n\n:returns: True if the robot is enabled and the DS is connected" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isFMSAttached", - "returnType": "bool", - "tooltip": "Is the driver station attached to a Field Management System?\n\n:returns: True if the robot is competing on a field being controlled by a\n Field Management System" - }, - { - "args": [ - { - "defaultValue": "", - "name": "stick", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isJoystickConnected", - "returnType": "bool", - "tooltip": "Returns if a joystick is connected to the Driver Station.\n\nThis makes a best effort guess by looking at the reported number of axis,\nbuttons, and POVs attached.\n\n:param stick: The joystick port number\n\n:returns: true if a joystick is connected" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isJoystickConnectionWarningSilenced", - "returnType": "bool", - "tooltip": "Returns whether joystick connection warnings are silenced. This will\nalways return false when connected to the FMS.\n\n:returns: Whether joystick connection warnings are silenced." - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isTeleop", - "returnType": "bool", - "tooltip": "Check if the DS is commanding teleop mode.\n\n:returns: True if the robot is being commanded to be in teleop mode" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isTeleopEnabled", - "returnType": "bool", - "tooltip": "Check if the DS is commanding teleop mode and if it has enabled the robot.\n\n:returns: True if the robot is being commanded to be in teleop mode and\n enabled." - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isTest", - "returnType": "bool", - "tooltip": "Check if the DS is commanding test mode.\n\n:returns: True if the robot is being commanded to be in test mode" - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "isTestEnabled", - "returnType": "bool", - "tooltip": "Check if the DS is commanding Test mode and if it has enabled the robot.\n\n:returns: True if the robot is being commanded to be in Test mode and\n enabled." - }, - { - "args": [ - { - "defaultValue": "", - "name": "handle", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "provideRefreshedDataEventHandle", - "returnType": "None", - "tooltip": "Registers the given handle for DS data refresh notifications.\n\n:param handle: The event handle." - }, - { - "args": [], - "declaringClassName": "wpilib.DriverStation", - "functionName": "refreshData", - "returnType": "None", - "tooltip": "Copy data from the DS task for the user. If no new data exists, it will\njust be returned, otherwise the data will be copied from the DS polling\nloop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "handle", - "type": "int" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "removeRefreshedDataEventHandle", - "returnType": "None", - "tooltip": "Unregisters the given handle from DS data refresh notifications.\n\n:param handle: The event handle." - }, - { - "args": [ - { - "defaultValue": "", - "name": "silence", - "type": "bool" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "silenceJoystickConnectionWarning", - "returnType": "None", - "tooltip": "Allows the user to specify whether they want joystick connection warnings\nto be printed to the console. This setting is ignored when the FMS is\nconnected -- warnings will always be on in that scenario.\n\n:param silence: Whether warning messages should be silenced." - }, - { - "args": [ - { - "defaultValue": "", - "name": "log", - "type": "wpiutil.log.DataLog" - }, - { - "defaultValue": "True", - "name": "logJoysticks", - "type": "bool" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "startDataLog", - "returnType": "None", - "tooltip": "Starts logging DriverStation data to data log. Repeated calls are ignored.\n\n:param log: data log\n:param logJoysticks: if true, log joystick data" - }, - { - "args": [ - { - "defaultValue": "", - "name": "timeout", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.DriverStation", - "functionName": "waitForDsConnection", - "returnType": "bool", - "tooltip": "Wait for a DS connection.\n\n:param timeout: timeout in seconds. 0 for infinite.\n\n:returns: true if connected, false if timeout" - } - ] - }, - { - "className": "wpilib.DutyCycle", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.DutyCycle", - "functionName": "__init__", - "returnType": "wpilib.DutyCycle", - "tooltip": "Constructs a DutyCycle input from a DigitalSource input.\n\nThis class does not own the inputted source.\n\n:param source: The DigitalSource to use." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycle" - } - ], - "declaringClassName": "wpilib.DutyCycle", - "functionName": "getFPGAIndex", - "returnType": "int", - "tooltip": "Get the FPGA index for the DutyCycle.\n\n:returns: the FPGA index" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycle" - } - ], - "declaringClassName": "wpilib.DutyCycle", - "functionName": "getFrequency", - "returnType": "int", - "tooltip": "Get the frequency of the duty cycle signal.\n\n:returns: frequency in Hertz" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycle" - } - ], - "declaringClassName": "wpilib.DutyCycle", - "functionName": "getHighTime", - "returnType": "wpimath.units.seconds", - "tooltip": "Get the raw high time of the duty cycle signal.\n\n:returns: high time of last pulse" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycle" - } - ], - "declaringClassName": "wpilib.DutyCycle", - "functionName": "getOutput", - "returnType": "float", - "tooltip": "Get the output ratio of the duty cycle signal.\n\n0 means always low, 1 means always high.\n\n:returns: output ratio between 0 and 1" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycle" - } - ], - "declaringClassName": "wpilib.DutyCycle", - "functionName": "getSourceChannel", - "returnType": "int", - "tooltip": "Get the channel of the source.\n\n:returns: the source channel" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.DutyCycleEncoder", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "__init__", - "returnType": "wpilib.DutyCycleEncoder", - "tooltip": "Construct a new DutyCycleEncoder on a specific channel.\n\nThis has a fullRange of 1 and an expectedZero of 0.\n\n:param channel: the channel to attach to" - }, - { - "args": [ - { - "defaultValue": "", - "name": "dutyCycle", - "type": "wpilib.DutyCycle" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "__init__", - "returnType": "wpilib.DutyCycleEncoder", - "tooltip": "Construct a new DutyCycleEncoder attached to an existing DutyCycle object.\n\nThis has a fullRange of 1 and an expectedZero of 0.\n\n:param dutyCycle: the duty cycle to attach to" - }, - { - "args": [ - { - "defaultValue": "", - "name": "digitalSource", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "__init__", - "returnType": "wpilib.DutyCycleEncoder", - "tooltip": "Construct a new DutyCycleEncoder attached to a DigitalSource object.\n\nThis has a fullRange of 1 and an expectedZero of 0.\n\n:param digitalSource: the digital source to attach to" - }, - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - }, - { - "defaultValue": "", - "name": "fullRange", - "type": "float" - }, - { - "defaultValue": "", - "name": "expectedZero", - "type": "float" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "__init__", - "returnType": "wpilib.DutyCycleEncoder", - "tooltip": "Construct a new DutyCycleEncoder on a specific channel.\n\n:param channel: the channel to attach to\n:param fullRange: the value to report at maximum travel\n:param expectedZero: the reading where you would expect a 0 from get()" - }, - { - "args": [ - { - "defaultValue": "", - "name": "dutyCycle", - "type": "wpilib.DutyCycle" - }, - { - "defaultValue": "", - "name": "fullRange", - "type": "float" - }, - { - "defaultValue": "", - "name": "expectedZero", - "type": "float" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "__init__", - "returnType": "wpilib.DutyCycleEncoder", - "tooltip": "Construct a new DutyCycleEncoder attached to an existing DutyCycle object.\n\n:param dutyCycle: the duty cycle to attach to\n:param fullRange: the value to report at maximum travel\n:param expectedZero: the reading where you would expect a 0 from get()" - }, - { - "args": [ - { - "defaultValue": "", - "name": "digitalSource", - "type": "wpilib.DigitalSource" - }, - { - "defaultValue": "", - "name": "fullRange", - "type": "float" - }, - { - "defaultValue": "", - "name": "expectedZero", - "type": "float" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "__init__", - "returnType": "wpilib.DutyCycleEncoder", - "tooltip": "Construct a new DutyCycleEncoder attached to a DigitalSource object.\n\n:param digitalSource: the digital source to attach to\n:param fullRange: the value to report at maximum travel\n:param expectedZero: the reading where you would expect a 0 from get()" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycleEncoder" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the encoder value.\n\n:returns: the encoder value scaled by the full range input" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycleEncoder" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "getFPGAIndex", - "returnType": "int", - "tooltip": "Get the FPGA index for the DutyCycleEncoder.\n\n:returns: the FPGA index" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycleEncoder" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "getFrequency", - "returnType": "int", - "tooltip": "Get the frequency in Hz of the duty cycle signal from the encoder.\n\n:returns: duty cycle frequency in Hz" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycleEncoder" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "getSourceChannel", - "returnType": "int", - "tooltip": "Get the channel of the source.\n\n:returns: the source channel" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycleEncoder" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycleEncoder" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "isConnected", - "returnType": "bool", - "tooltip": "Get if the sensor is connected\n\nThis uses the duty cycle frequency to determine if the sensor is connected.\nBy default, a value of 100 Hz is used as the threshold, and this value can\nbe changed with SetConnectedFrequencyThreshold.\n\n:returns: true if the sensor is connected" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycleEncoder" - }, - { - "defaultValue": "", - "name": "frequency", - "type": "wpimath.units.hertz" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "setAssumedFrequency", - "returnType": "None", - "tooltip": "Sets the assumed frequency of the connected device.\n\nBy default, the DutyCycle engine has to compute the frequency of the\ninput signal. This can result in both delayed readings and jumpy readings.\nTo solve this, you can pass the expected frequency of the sensor to this\nfunction. This will use that frequency to compute the DutyCycle percentage,\nrather than the computed frequency.\n\n:param frequency: the assumed frequency of the sensor" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycleEncoder" - }, - { - "defaultValue": "", - "name": "frequency", - "type": "int" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "setConnectedFrequencyThreshold", - "returnType": "None", - "tooltip": "Change the frequency threshold for detecting connection used by\nIsConnected.\n\n:param frequency: the minimum frequency in Hz." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycleEncoder" - }, - { - "defaultValue": "", - "name": "min", - "type": "float" - }, - { - "defaultValue": "", - "name": "max", - "type": "float" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "setDutyCycleRange", - "returnType": "None", - "tooltip": "Set the encoder duty cycle range. As the encoder needs to maintain a duty\ncycle, the duty cycle cannot go all the way to 0% or all the way to 100%.\nFor example, an encoder with a 4096 us period might have a minimum duty\ncycle of 1 us / 4096 us and a maximum duty cycle of 4095 / 4096 us. Setting\nthe range will result in an encoder duty cycle less than or equal to the\nminimum being output as 0 rotation, the duty cycle greater than or equal to\nthe maximum being output as 1 rotation, and values in between linearly\nscaled from 0 to 1.\n\n:param min: minimum duty cycle (0-1 range)\n:param max: maximum duty cycle (0-1 range)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.DutyCycleEncoder" - }, - { - "defaultValue": "", - "name": "inverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.DutyCycleEncoder", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "Set if this encoder is inverted.\n\n:param inverted: true to invert the encoder, false otherwise" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.Encoder", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "aChannel", - "type": "int" - }, - { - "defaultValue": "", - "name": "bChannel", - "type": "int" - }, - { - "defaultValue": "False", - "name": "reverseDirection", - "type": "bool" - }, - { - "defaultValue": "", - "name": "encodingType", - "type": "wpilib.interfaces.CounterBase.EncodingType" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "__init__", - "returnType": "wpilib.Encoder", - "tooltip": "Encoder constructor.\n\nConstruct a Encoder given a and b channels.\n\nThe counter will start counting immediately.\n\n:param aChannel: The a channel DIO channel. 0-9 are on-board, 10-25\n are on the MXP port\n:param bChannel: The b channel DIO channel. 0-9 are on-board, 10-25\n are on the MXP port\n:param reverseDirection: represents the orientation of the encoder and\n inverts the output values if necessary so forward\n represents positive values.\n:param encodingType: either k1X, k2X, or k4X to indicate 1X, 2X or 4X\n decoding. If 4X is selected, then an encoder FPGA\n object is used and the returned counts will be 4x\n the encoder spec'd value since all rising and\n falling edges are counted. If 1X or 2X are selected\n then a counter object will be used and the returned\n value will either exactly match the spec'd count or\n be double (2x) the spec'd count." - }, - { - "args": [ - { - "defaultValue": "", - "name": "aSource", - "type": "wpilib.DigitalSource" - }, - { - "defaultValue": "", - "name": "bSource", - "type": "wpilib.DigitalSource" - }, - { - "defaultValue": "False", - "name": "reverseDirection", - "type": "bool" - }, - { - "defaultValue": "", - "name": "encodingType", - "type": "wpilib.interfaces.CounterBase.EncodingType" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "__init__", - "returnType": "wpilib.Encoder", - "tooltip": "" - } - ], - "enums": [ - { - "enumClassName": "wpilib.Encoder.IndexingType", - "enumValues": [ - "kResetOnFallingEdge", - "kResetOnRisingEdge", - "kResetWhileHigh", - "kResetWhileLow" - ], - "moduleName": "wpilib", - "tooltip": "Encoder indexing types.\n\nMembers:\n\n kResetWhileHigh : Reset while the signal is high.\n\n kResetWhileLow : Reset while the signal is low.\n\n kResetOnFallingEdge : Reset on falling edge of the signal.\n\n kResetOnRisingEdge : Reset on rising edge of the signal." - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "get", - "returnType": "int", - "tooltip": "Gets the current count.\n\nReturns the current count on the Encoder. This method compensates for the\ndecoding type.\n\n:returns: Current count from the Encoder adjusted for the 1x, 2x, or 4x scale\n factor." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "getDirection", - "returnType": "bool", - "tooltip": "The last direction the encoder value changed.\n\n:returns: The last direction the encoder value changed." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "getDistance", - "returnType": "float", - "tooltip": "Get the distance the robot has driven since the last reset.\n\n:returns: The distance driven since the last reset as scaled by the value\n from SetDistancePerPulse()." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "getDistancePerPulse", - "returnType": "float", - "tooltip": "Get the distance per pulse for this encoder.\n\n:returns: The scale factor that will be used to convert pulses to useful\n units." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "getEncodingScale", - "returnType": "int", - "tooltip": "The encoding scale factor 1x, 2x, or 4x, per the requested encodingType.\n\nUsed to divide raw edge counts down to spec'd counts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "getFPGAIndex", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "getPeriod", - "returnType": "wpimath.units.seconds", - "tooltip": "Returns the period of the most recent pulse.\n\nReturns the period of the most recent Encoder pulse in seconds. This method\ncompensates for the decoding type.\n\nWarning: This returns unscaled periods. Use GetRate() for rates that are\nscaled using the value from SetDistancePerPulse().\n\n:deprecated: Use getRate() in favor of this method.\n\n:returns: Period in seconds of the most recent pulse." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "getRate", - "returnType": "float", - "tooltip": "Get the current rate of the encoder.\n\nUnits are distance per second as scaled by the value from\nSetDistancePerPulse().\n\n:returns: The current rate of the encoder." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "getRaw", - "returnType": "int", - "tooltip": "Gets the raw value from the encoder.\n\nThe raw value is the actual count unscaled by the 1x, 2x, or 4x scale\nfactor.\n\n:returns: Current raw count from the encoder" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "getSamplesToAverage", - "returnType": "int", - "tooltip": "Get the Samples to Average which specifies the number of samples of the\ntimer to average when calculating the period.\n\nPerform averaging to account for mechanical imperfections or as\noversampling to increase resolution.\n\n:returns: The number of samples being averaged (from 1 to 127)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "getStopped", - "returnType": "bool", - "tooltip": "Determine if the encoder is stopped.\n\nUsing the MaxPeriod value, a boolean is returned that is true if the\nencoder is considered stopped and false if it is still moving. A stopped\nencoder is one where the most recent pulse width exceeds the MaxPeriod.\n\n:returns: True if the encoder is considered stopped." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "reset", - "returnType": "None", - "tooltip": "Reset the Encoder distance to zero.\n\nResets the current count to zero on the encoder." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - }, - { - "defaultValue": "", - "name": "distancePerPulse", - "type": "float" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "setDistancePerPulse", - "returnType": "None", - "tooltip": "Set the distance per pulse for this encoder.\n\nThis sets the multiplier used to determine the distance driven based on the\ncount value from the encoder.\n\nDo not include the decoding type in this scale. The library already\ncompensates for the decoding type.\n\nSet this value based on the encoder's rated Pulses per Revolution and\nfactor in gearing reductions following the encoder shaft.\n\nThis distance can be in any units you like, linear or angular.\n\n:param distancePerPulse: The scale factor that will be used to convert\n pulses to useful units." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.Encoder.IndexingType" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "setIndexSource", - "returnType": "None", - "tooltip": "Set the index source for the encoder.\n\nWhen this source is activated, the encoder count automatically resets.\n\n:param channel: A DIO channel to set as the encoder index\n:param type: The state that will cause the encoder to reset" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - }, - { - "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.Encoder.IndexingType" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "setIndexSource", - "returnType": "None", - "tooltip": "Set the index source for the encoder.\n\nWhen this source is activated, the encoder count automatically resets.\n\n:param source: A digital source to set as the encoder index\n:param type: The state that will cause the encoder to reset" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - }, - { - "defaultValue": "", - "name": "maxPeriod", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "setMaxPeriod", - "returnType": "None", - "tooltip": "Sets the maximum period for stopped detection.\n\nSets the value that represents the maximum period of the Encoder before it\nwill assume that the attached device is stopped. This timeout allows users\nto determine if the wheels or other shaft has stopped rotating.\nThis method compensates for the decoding type.\n\n:deprecated: Use SetMinRate() in favor of this method. This takes unscaled\n periods and SetMinRate() scales using value from\n SetDistancePerPulse().\n\n:param maxPeriod: The maximum time between rising and falling edges before\n the FPGA will report the device stopped. This is expressed\n in seconds." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - }, - { - "defaultValue": "", - "name": "minRate", - "type": "float" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "setMinRate", - "returnType": "None", - "tooltip": "Set the minimum rate of the device before the hardware reports it stopped.\n\n:param minRate: The minimum rate. The units are in distance per second as\n scaled by the value from SetDistancePerPulse()." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - }, - { - "defaultValue": "", - "name": "reverseDirection", - "type": "bool" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "setReverseDirection", - "returnType": "None", - "tooltip": "Set the direction sensing for this encoder.\n\nThis sets the direction sensing on the encoder so that it could count in\nthe correct software direction regardless of the mounting.\n\n:param reverseDirection: true if the encoder direction should be reversed" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - }, - { - "defaultValue": "", - "name": "samplesToAverage", - "type": "int" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "setSamplesToAverage", - "returnType": "None", - "tooltip": "Set the Samples to Average which specifies the number of samples of the\ntimer to average when calculating the period.\n\nPerform averaging to account for mechanical imperfections or as\noversampling to increase resolution.\n\n:param samplesToAverage: The number of samples to average from 1 to 127." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Encoder" - }, - { - "defaultValue": "", - "name": "device", - "type": "int" - } - ], - "declaringClassName": "wpilib.Encoder", - "functionName": "setSimDevice", - "returnType": "None", - "tooltip": "Indicates this encoder is used by a simulated device.\n\n:param device: simulated device handle" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.Field2d", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.Field2d", - "functionName": "__init__", - "returnType": "wpilib.Field2d", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Field2d" - }, - { - "defaultValue": "", - "name": "name", - "type": "str" - } - ], - "declaringClassName": "wpilib.Field2d", - "functionName": "getObject", - "returnType": "wpilib.FieldObject2d", - "tooltip": "Get or create a field object.\n\n:returns: Field object" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Field2d" - } - ], - "declaringClassName": "wpilib.Field2d", - "functionName": "getRobotObject", - "returnType": "wpilib.FieldObject2d", - "tooltip": "Get the robot object.\n\n:returns: Field object for robot" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Field2d" - } - ], - "declaringClassName": "wpilib.Field2d", - "functionName": "getRobotPose", - "returnType": "wpimath.geometry.Pose2d", - "tooltip": "Get the robot pose.\n\n:returns: 2D pose" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Field2d" - }, - { - "defaultValue": "", - "name": "builder", - "type": "ntcore.NTSendableBuilder" - } - ], - "declaringClassName": "wpilib.Field2d", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Field2d" - }, - { - "defaultValue": "", - "name": "pose", - "type": "wpimath.geometry.Pose2d" - } - ], - "declaringClassName": "wpilib.Field2d", - "functionName": "setRobotPose", - "returnType": "None", - "tooltip": "Set the robot pose from a Pose object.\n\n:param pose: 2D pose" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Field2d" - }, - { - "defaultValue": "", - "name": "x", - "type": "wpimath.units.meters" - }, - { - "defaultValue": "", - "name": "y", - "type": "wpimath.units.meters" - }, - { - "defaultValue": "", - "name": "rotation", - "type": "wpimath.geometry.Rotation2d" - } - ], - "declaringClassName": "wpilib.Field2d", - "functionName": "setRobotPose", - "returnType": "None", - "tooltip": "Set the robot pose from x, y, and rotation.\n\n:param x: X location\n:param y: Y location\n:param rotation: rotation" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.FieldObject2d", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.FieldObject2d", - "functionName": "__init__", - "returnType": "wpilib.FieldObject2d", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.FieldObject2d" - } - ], - "declaringClassName": "wpilib.FieldObject2d", - "functionName": "getPose", - "returnType": "wpimath.geometry.Pose2d", - "tooltip": "Get the pose.\n\n:returns: 2D pose, or 0,0,0 if unknown / does not exist" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.FieldObject2d" - } - ], - "declaringClassName": "wpilib.FieldObject2d", - "functionName": "getPoses", - "returnType": "list[wpimath.geometry.Pose2d]", - "tooltip": "Get multiple poses.\n\n:returns: vector of 2D poses" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.FieldObject2d" - }, - { - "defaultValue": "", - "name": "pose", - "type": "wpimath.geometry.Pose2d" - } - ], - "declaringClassName": "wpilib.FieldObject2d", - "functionName": "setPose", - "returnType": "None", - "tooltip": "Set the pose from a Pose object.\n\n:param pose: 2D pose" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.FieldObject2d" - }, - { - "defaultValue": "", - "name": "x", - "type": "wpimath.units.meters" - }, - { - "defaultValue": "", - "name": "y", - "type": "wpimath.units.meters" - }, - { - "defaultValue": "", - "name": "rotation", - "type": "wpimath.geometry.Rotation2d" - } - ], - "declaringClassName": "wpilib.FieldObject2d", - "functionName": "setPose", - "returnType": "None", - "tooltip": "Set the pose from x, y, and rotation.\n\n:param x: X location\n:param y: Y location\n:param rotation: rotation" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.FieldObject2d" - }, - { - "defaultValue": "", - "name": "poses", - "type": "List[wpimath.geometry.Pose2d]" - } - ], - "declaringClassName": "wpilib.FieldObject2d", - "functionName": "setPoses", - "returnType": "None", - "tooltip": "Set multiple poses from an array of Pose objects.\nThe total number of poses is limited to 85.\n\n:param poses: array of 2D poses" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.FieldObject2d" - }, - { - "defaultValue": "", - "name": "trajectory", - "type": "wpimath.trajectory.Trajectory" - } - ], - "declaringClassName": "wpilib.FieldObject2d", - "functionName": "setTrajectory", - "returnType": "None", - "tooltip": "Sets poses from a trajectory.\n\n:param trajectory: The trajectory from which poses should be added." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.I2C", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "port", - "type": "wpilib.I2C.Port" - }, - { - "defaultValue": "", - "name": "deviceAddress", - "type": "int" - } - ], - "declaringClassName": "wpilib.I2C", - "functionName": "__init__", - "returnType": "wpilib.I2C", - "tooltip": "Constructor.\n\n:param port: The I2C port to which the device is connected.\n:param deviceAddress: The address of the device on the I2C bus." - } - ], - "enums": [ - { - "enumClassName": "wpilib.I2C.Port", - "enumValues": [ - "kMXP", - "kOnboard" - ], - "moduleName": "wpilib", - "tooltip": "I2C connection ports.\n\nMembers:\n\n kOnboard : Onboard I2C port.\n\n kMXP : MXP (roboRIO MXP) I2C port." - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.I2C" - } - ], - "declaringClassName": "wpilib.I2C", - "functionName": "addressOnly", - "returnType": "bool", - "tooltip": "Attempt to address a device on the I2C bus.\n\nThis allows you to figure out if there is a device on the I2C bus that\nresponds to the address specified in the constructor.\n\n:returns: Transfer Aborted... false for success, true for aborted." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.I2C" - } - ], - "declaringClassName": "wpilib.I2C", - "functionName": "getDeviceAddress", - "returnType": "int", - "tooltip": "Returns I2C device address.\n\n:returns: I2C device address." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.I2C" - } - ], - "declaringClassName": "wpilib.I2C", - "functionName": "getPort", - "returnType": "wpilib.I2C.Port", - "tooltip": "Returns I2C port.\n\n:returns: I2C port." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.I2C" - }, - { - "defaultValue": "", - "name": "registerAddress", - "type": "int" - }, - { - "defaultValue": "", - "name": "data", - "type": "Buffer" - } - ], - "declaringClassName": "wpilib.I2C", - "functionName": "read", - "returnType": "bool", - "tooltip": "Execute a read transaction with the device.\n\nRead bytes from a device.\nMost I2C devices will auto-increment the register pointer internally\nallowing you to read consecutive registers on a device in a single\ntransaction.\n\n:param registerAddress: The register to read first in the transaction.\n:param count: The number of bytes to read in the transaction.\n:param data: A pointer to the array of bytes to store the data\n read from the device.\n\n:returns: Transfer Aborted... false for success, true for aborted." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.I2C" - }, - { - "defaultValue": "", - "name": "buffer", - "type": "Buffer" - } - ], - "declaringClassName": "wpilib.I2C", - "functionName": "readOnly", - "returnType": "bool", - "tooltip": "Execute a read only transaction with the device.\n\nRead bytes from a device. This method does not write any data to prompt the\ndevice.\n\n:param buffer: A pointer to the array of bytes to store the data read from\n the device.\n:param count: The number of bytes to read in the transaction.\n\n:returns: Transfer Aborted... false for success, true for aborted." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.I2C" - }, - { - "defaultValue": "", - "name": "dataToSend", - "type": "Buffer" - }, - { - "defaultValue": "", - "name": "dataReceived", - "type": "Buffer" - } - ], - "declaringClassName": "wpilib.I2C", - "functionName": "transaction", - "returnType": "bool", - "tooltip": "Generic transaction.\n\nThis is a lower-level interface to the I2C hardware giving you more control\nover each transaction. If you intend to write multiple bytes in the same\ntransaction and do not plan to receive anything back, use writeBulk()\ninstead. Calling this with a receiveSize of 0 will result in an error.\n\n:param dataToSend: Buffer of data to send as part of the transaction.\n:param sendSize: Number of bytes to send as part of the transaction.\n:param dataReceived: Buffer to read data into.\n:param receiveSize: Number of bytes to read from the device.\n\n:returns: Transfer Aborted... false for success, true for aborted." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.I2C" - }, - { - "defaultValue": "", - "name": "registerAddress", - "type": "int" - }, - { - "defaultValue": "", - "name": "expected", - "type": "Buffer" - } - ], - "declaringClassName": "wpilib.I2C", - "functionName": "verifySensor", - "returnType": "bool", - "tooltip": "Verify that a device's registers contain expected values.\n\nMost devices will have a set of registers that contain a known value that\ncan be used to identify them. This allows an I2C device driver to easily\nverify that the device contains the expected value.\n\n@pre The device must support and be configured to use register\nauto-increment.\n\n:param registerAddress: The base register to start reading from the device.\n:param count: The size of the field to be verified.\n:param expected: A buffer containing the values expected from the\n device." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.I2C" - }, - { - "defaultValue": "", - "name": "registerAddress", - "type": "int" - }, - { - "defaultValue": "", - "name": "data", - "type": "int" - } - ], - "declaringClassName": "wpilib.I2C", - "functionName": "write", - "returnType": "bool", - "tooltip": "Execute a write transaction with the device.\n\nWrite a single byte to a register on a device and wait until the\ntransaction is complete.\n\n:param registerAddress: The address of the register on the device to be\n written.\n:param data: The byte to write to the register on the device.\n\n:returns: Transfer Aborted... false for success, true for aborted." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.I2C" - }, - { - "defaultValue": "", - "name": "data", - "type": "Buffer" - } - ], - "declaringClassName": "wpilib.I2C", - "functionName": "writeBulk", - "returnType": "bool", - "tooltip": "Execute a bulk write transaction with the device.\n\nWrite multiple bytes to a device and wait until the\ntransaction is complete.\n\n:param data: The data to write to the register on the device.\n:param count: The number of bytes to be written.\n\n:returns: Transfer Aborted... false for success, true for aborted." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.IterativeRobotBase", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "period", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "__init__", - "returnType": "wpilib.IterativeRobotBase", - "tooltip": "Constructor for IterativeRobotBase.\n\n:param period: Period." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "autonomousExit", - "returnType": "None", - "tooltip": "Exit code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits autonomous mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "autonomousInit", - "returnType": "None", - "tooltip": "Initialization code for autonomous mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters autonomous mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "autonomousPeriodic", - "returnType": "None", - "tooltip": "Periodic code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in\nautonomous mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "disabledExit", - "returnType": "None", - "tooltip": "Exit code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits disabled mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "disabledInit", - "returnType": "None", - "tooltip": "Initialization code for disabled mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time\nthe robot enters disabled mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "disabledPeriodic", - "returnType": "None", - "tooltip": "Periodic code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in disabled\nmode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "driverStationConnected", - "returnType": "None", - "tooltip": "Code that needs to know the DS state should go here.\n\nUsers should override this method for initialization that needs to occur\nafter the DS is connected, such as needing the alliance information." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - }, - { - "defaultValue": "", - "name": "testLW", - "type": "bool" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "enableLiveWindowInTest", - "returnType": "None", - "tooltip": "Sets whether LiveWindow operation is enabled during test mode.\n\n:param testLW: True to enable, false to disable. Defaults to false.\n @throws if called in test mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "endCompetition", - "returnType": "None", - "tooltip": "Ends the main loop in StartCompetition()." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "getControlState", - "returnType": "tuple[bool, bool, bool]", - "tooltip": "More efficient way to determine what state the robot is in.\n\n:returns: booleans representing enabled, isautonomous, istest\n\n.. versionadded:: 2019.2.1\n\n.. note:: This function only exists in RobotPy" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "getPeriod", - "returnType": "wpimath.units.seconds", - "tooltip": "Gets time period between calls to Periodic() functions." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isAutonomous", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Autonomous mode.\n\n:returns: True if the robot is currently operating Autonomously as determined\n by the Driver Station." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isAutonomousEnabled", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Autonomous mode and enabled.\n\n:returns: True if the robot us currently operating Autonomously while enabled\n as determined by the Driver Station." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isDisabled", - "returnType": "bool", - "tooltip": "Determine if the Robot is currently disabled.\n\n:returns: True if the Robot is currently disabled by the Driver Station." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isEnabled", - "returnType": "bool", - "tooltip": "Determine if the Robot is currently enabled.\n\n:returns: True if the Robot is currently enabled by the Driver Station." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "isLiveWindowEnabledInTest", - "returnType": "bool", - "tooltip": "Whether LiveWindow operation is enabled during test mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTeleop", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Operator Control mode.\n\n:returns: True if the robot is currently operating in Tele-Op mode as\n determined by the Driver Station." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTeleopEnabled", - "returnType": "bool", - "tooltip": "Determine if the robot is current in Operator Control mode and enabled.\n\n:returns: True if the robot is currently operating in Tele-Op mode while\n enabled as determined by the Driver Station." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTest", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Test mode.\n\n:returns: True if the robot is currently running in Test mode as determined\n by the Driver Station." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTestEnabled", - "returnType": "bool", - "tooltip": "Determine if the robot is current in Test mode and enabled.\n\n:returns: True if the robot is currently operating in Test mode while\n enabled as determined by the Driver Station." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "printWatchdogEpochs", - "returnType": "None", - "tooltip": "Prints list of epochs added so far and their times." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "robotInit", - "returnType": "None", - "tooltip": "Robot-wide initialization code should go here.\n\nUsers should override this method for default Robot-wide initialization\nwhich will be called when the robot is first powered on. It will be called\nexactly one time.\n\nNote: This method is functionally identical to the class constructor so\nthat should be used instead." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "robotPeriodic", - "returnType": "None", - "tooltip": "Periodic code for all modes should go here.\n\nThis function is called each time a new packet is received from the driver\nstation." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "setNetworkTablesFlushEnabled", - "returnType": "None", - "tooltip": "Enables or disables flushing NetworkTables every loop iteration.\nBy default, this is enabled.\n\n:deprecated: Deprecated without replacement.\n\n:param enabled: True to enable, false to disable" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "startCompetition", - "returnType": "None", - "tooltip": "Start the main robot code. This function will be called once and should not\nexit until signalled by EndCompetition()" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "teleopExit", - "returnType": "None", - "tooltip": "Exit code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits teleop mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "teleopInit", - "returnType": "None", - "tooltip": "Initialization code for teleop mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters teleop mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "teleopPeriodic", - "returnType": "None", - "tooltip": "Periodic code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in teleop\nmode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "testExit", - "returnType": "None", - "tooltip": "Exit code for test mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits test mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "testInit", - "returnType": "None", - "tooltip": "Initialization code for test mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters test mode." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "testPeriodic", - "returnType": "None", - "tooltip": "Periodic code for test mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in test\nmode." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "getRuntimeType", - "returnType": "wpilib.RuntimeType", - "tooltip": "Get the current runtime type.\n\n:returns: Current runtime type." - }, - { - "args": [], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "isReal", - "returnType": "bool", - "tooltip": "Get if the robot is real.\n\n:returns: If the robot is running in the real world." - }, - { - "args": [], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "isSimulation", - "returnType": "bool", - "tooltip": "Get if the robot is a simulation.\n\n:returns: If the robot is running in simulation." - }, - { - "args": [ - { - "defaultValue": "", - "name": "robot_cls", - "type": "object" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "main", - "returnType": "object", - "tooltip": "Starting point for the application" - } - ] - }, - { - "className": "wpilib.Jaguar", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Jaguar", - "functionName": "__init__", - "returnType": "wpilib.Jaguar", - "tooltip": "Constructor for a Jaguar connected via PWM.\n\n:param channel: The PWM channel that the Jaguar is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.Jaguar", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.Joystick", - "classVariables": [ - { - "name": "kDefaultThrottleChannel", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kDefaultTwistChannel", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kDefaultXChannel", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kDefaultYChannel", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kDefaultZChannel", - "tooltip": "", - "type": "int", - "writable": false - } - ], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "port", - "type": "int" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "__init__", - "returnType": "wpilib.Joystick", - "tooltip": "Construct an instance of a joystick.\n\nThe joystick index is the USB port on the Driver Station.\n\n:param port: The port on the Driver Station that the joystick is plugged\n into (0-5)." - } - ], - "enums": [ - { - "enumClassName": "wpilib.Joystick.AxisType", - "enumValues": [ - "kThrottleAxis", - "kTwistAxis", - "kXAxis", - "kYAxis", - "kZAxis" - ], - "moduleName": "wpilib", - "tooltip": "Represents an analog axis on a joystick.\n\nMembers:\n\n kXAxis : X axis.\n\n kYAxis : Y axis.\n\n kZAxis : Z axis.\n\n kTwistAxis : Twist axis.\n\n kThrottleAxis : Throttle axis." - }, - { - "enumClassName": "wpilib.Joystick.ButtonType", - "enumValues": [ - "kTopButton", - "kTriggerButton" - ], - "moduleName": "wpilib", - "tooltip": "Represents a digital button on a joystick.\n\nMembers:\n\n kTriggerButton : kTrigger.\n\n kTopButton : kTop." - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "angle", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POV", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "pov", - "type": "int" - }, - { - "defaultValue": "", - "name": "angle", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POV", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVCenter", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the center (not pressed) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the center of a POV on the\n HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDown", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 180 degree angle (down)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 180 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDownLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 225 degree angle (down\nleft) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 225 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDownRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 135 degree angle (right\ndown) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 135 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 270 degree angle (left)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 270 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 90 degree angle (right)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 90 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUp", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 0 degree angle (up) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 0 degree angle of a POV on\n the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUpLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 315 degree angle (left\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 315 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUpRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 45 degree angle (right\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 45 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "axisGreaterThan", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance that is true when the axis value is greater\nthan threshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value above which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is greater than\n the provided threshold." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "axisLessThan", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance that is true when the axis value is less than\nthreshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value below which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is less than the\n provided threshold." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "button", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around this button's digital signal.\n\n:param button: the button index\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the button's digital signal attached\n to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getAxisCount", - "returnType": "int", - "tooltip": "Get the number of axes for the HID.\n\n:returns: the number of axis for the current HID" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getAxisType", - "returnType": "int", - "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getButtonCount", - "returnType": "int", - "tooltip": "Get the number of buttons for the HID.\n\n:returns: the number of buttons on the current HID" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getDirectionDegrees", - "returnType": "wpimath.units.degrees", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getDirectionRadians", - "returnType": "wpimath.units.radians", - "tooltip": "Get the direction of the vector formed by the joystick and its origin.\n\n:returns: The direction of the vector." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getMagnitude", - "returnType": "float", - "tooltip": "Get the magnitude of the direction vector formed by the joystick's\ncurrent position relative to its origin.\n\n:returns: The magnitude of the direction vector" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getName", - "returnType": "str", - "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "0", - "name": "pov", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPOV", - "returnType": "int", - "tooltip": "Get the angle in degrees of a POV on the HID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(e.g. right is 90, upper-left is 315).\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV in degrees, or -1 if the POV is not pressed." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPOVCount", - "returnType": "int", - "tooltip": "Get the number of POVs for the HID.\n\n:returns: the number of POVs for the current HID" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPort", - "returnType": "int", - "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawAxis", - "returnType": "float", - "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButton", - "returnType": "bool", - "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonPressed", - "returnType": "bool", - "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonReleased", - "returnType": "bool", - "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getThrottle", - "returnType": "float", - "tooltip": "Get the throttle value of the current joystick.\n\nThis depends on the mapping of the joystick connected to the current port." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getThrottleChannel", - "returnType": "int", - "tooltip": "Get the channel currently associated with the throttle axis.\n\n:returns: The channel for the axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getTop", - "returnType": "bool", - "tooltip": "Read the state of the top button on the joystick.\n\nLook up which button has been assigned to the top and read its state.\n\n:returns: The state of the top button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getTopPressed", - "returnType": "bool", - "tooltip": "Whether the top button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getTopReleased", - "returnType": "bool", - "tooltip": "Whether the top button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getTrigger", - "returnType": "bool", - "tooltip": "Read the state of the trigger on the joystick.\n\nLook up which button has been assigned to the trigger and read its state.\n\n:returns: The state of the trigger." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getTriggerPressed", - "returnType": "bool", - "tooltip": "Whether the trigger was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getTriggerReleased", - "returnType": "bool", - "tooltip": "Whether the trigger was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getTwist", - "returnType": "float", - "tooltip": "Get the twist value of the current joystick.\n\nThis depends on the mapping of the joystick connected to the current port." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getTwistChannel", - "returnType": "int", - "tooltip": "Get the channel currently associated with the twist axis.\n\n:returns: The channel for the axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getType", - "returnType": "wpilib.interfaces.GenericHID.HIDType", - "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getX", - "returnType": "float", - "tooltip": "Get the X value of the current joystick.\n\nThis depends on the mapping of the joystick connected to the current port." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getXChannel", - "returnType": "int", - "tooltip": "Get the channel currently associated with the X axis.\n\n:returns: The channel for the axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getY", - "returnType": "float", - "tooltip": "Get the Y value of the current joystick.\n\nThis depends on the mapping of the joystick connected to the current port." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getYChannel", - "returnType": "int", - "tooltip": "Get the channel currently associated with the Y axis.\n\n:returns: The channel for the axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getZ", - "returnType": "float", - "tooltip": "Get the Z value of the current joystick.\n\nThis depends on the mapping of the joystick connected to the current port." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "getZChannel", - "returnType": "int", - "tooltip": "Get the channel currently associated with the Z axis.\n\n:returns: The channel for the axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "isConnected", - "returnType": "bool", - "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "outputNumber", - "type": "int" - }, - { - "defaultValue": "", - "name": "value", - "type": "bool" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setOutput", - "returnType": "None", - "tooltip": "Set a single HID output value for the HID.\n\n:param outputNumber: The index of the output to set (1-32)\n:param value: The value to set the output to" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "value", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setOutputs", - "returnType": "None", - "tooltip": "Set all output values for the HID.\n\n:param value: The 32 bit output value (1 bit for each output)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.interfaces.GenericHID.RumbleType" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setRumble", - "returnType": "None", - "tooltip": "Set the rumble output for the HID.\n\nThe DS currently supports 2 rumble values, left rumble and right rumble.\n\n:param type: Which rumble value to set\n:param value: The normalized value (0 to 1) to set the rumble to" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "setThrottleChannel", - "returnType": "None", - "tooltip": "Set the channel associated with the throttle axis.\n\n:param channel: The channel to set the axis to." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "setTwistChannel", - "returnType": "None", - "tooltip": "Set the channel associated with the twist axis.\n\n:param channel: The channel to set the axis to." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "setXChannel", - "returnType": "None", - "tooltip": "Set the channel associated with the X axis.\n\n:param channel: The channel to set the axis to." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "setYChannel", - "returnType": "None", - "tooltip": "Set the channel associated with the Y axis.\n\n:param channel: The channel to set the axis to." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "setZChannel", - "returnType": "None", - "tooltip": "Set the channel associated with the Z axis.\n\n:param channel: The channel to set the axis to." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "top", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the top button's digital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the top button's digital signal\n attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Joystick" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.Joystick", - "functionName": "trigger", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the trigger button's digital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the trigger button's digital signal\n attached to the given loop." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.LEDPattern", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "impl", - "type": "Callable[[wpilib.LEDPattern.LEDReader, Callable[[int, wpilib.Color], None]], None]" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "__init__", - "returnType": "wpilib.LEDPattern", - "tooltip": "" - } - ], - "enums": [ - { - "enumClassName": "wpilib.LEDPattern.GradientType", - "enumValues": [ - "kContinuous", - "kDiscontinuous" - ], - "moduleName": "wpilib", - "tooltip": "Types of gradients.\n\nMembers:\n\n kContinuous : A continuous gradient, where the gradient wraps around to allow for\nseamless scrolling effects.\n\n kDiscontinuous : A discontinuous gradient, where the first pixel is set to the first color\nof the gradient and the final pixel is set to the last color of the\ngradient. There is no wrapping effect, so scrolling effects will display\nan obvious seam." - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "reader", - "type": "wpilib.LEDPattern.LEDReader" - }, - { - "defaultValue": "", - "name": "writer", - "type": "Callable[[int, wpilib.Color], None]" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "applyTo", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "data", - "type": "List[wpilib.AddressableLED.LEDData]" - }, - { - "defaultValue": "", - "name": "writer", - "type": "Callable[[int, wpilib.Color], None]" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "applyTo", - "returnType": "None", - "tooltip": "Writes the pattern to an LED buffer. Dynamic animations should be called\nperiodically (such as with a command or with a periodic method) to refresh\nthe buffer over time.\n\nThis method is intentionally designed to use separate objects for reading\nand writing data. By splitting them up, we can easily modify the behavior\nof some base pattern to make it scroll, blink, or breathe by intercepting\nthe data writes to transform their behavior to whatever we like.\n\n:param data: the current data of the LED strip\n:param writer: data writer for setting new LED colors on the LED strip" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "data", - "type": "List[wpilib.AddressableLED.LEDData]" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "applyTo", - "returnType": "None", - "tooltip": "Writes the pattern to an LED buffer. Dynamic animations should be called\nperiodically (such as with a command or with a periodic method) to refresh\nthe buffer over time.\n\nThis method is intentionally designed to use separate objects for reading\nand writing data. By splitting them up, we can easily modify the behavior\nof some base pattern to make it scroll, blink, or breathe by intercepting\nthe data writes to transform their behavior to whatever we like.\n\n:param data: the current data of the LED strip" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "relativeBrightness", - "type": "float" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "atBrightness", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that plays this one, but at a different brightness.\nBrightness multipliers are applied per-channel in the RGB space; no HSL or\nHSV conversions are applied. Multipliers are also uncapped, which may\nresult in the original colors washing out and appearing less saturated or\neven just a bright white.\n\nThis method is predominantly intended for dimming LEDs to avoid\npainfully bright or distracting patterns from playing (apologies to the\n2024 NE Greater Boston field staff).\n\nFor example, dimming can be done simply by adding a call to\n`atBrightness` at the end of a pattern:\n\n::\n\n // Solid red, but at 50% brightness\n frc::LEDPattern::Solid(frc::Color::kRed).AtBrightness(0.5);\n \n // Solid white, but at only 10% (i.e. ~0.5V)\n frc::LEDPattern::Solid(frc:Color::kWhite).AtBrightness(0.1);\n\n:param relativeBrightness: the multiplier to apply to all channels to modify\n brightness\n\n:returns: the input pattern, displayed at" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "other", - "type": "wpilib.LEDPattern" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "blend", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that displays outputs as a combination of this pattern\nand another. Color values are calculated as the average color of both\npatterns; if both patterns set the same LED to the same color, then it is\nset to that color, but if one pattern sets to one color and the other\npattern sets it to off, then it will show the color of the first pattern\nbut at approximately half brightness. This is different from {@link\nLEDPattern::OverlayOn(const LEDPattern&)}, which will show the base pattern\nat full brightness if the overlay is set to off at that position.\n\n:param other: the pattern to blend with\n\n:returns: the blended pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "onTime", - "type": "wpimath.units.seconds" - }, - { - "defaultValue": "", - "name": "offTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "blink", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that switches between playing this pattern and turning\nthe entire LED strip off.\n\n:param onTime: how long the pattern should play for, per cycle\n:param offTime: how long the pattern should be turned off for, per cycle\n\n:returns: the blinking pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "onTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "blink", - "returnType": "wpilib.LEDPattern", - "tooltip": "Like {@link LEDPattern::Blink(units::second_t)}, but where the\n\"off\" time is exactly equal to the \"on\" time.\n\n:param onTime: how long the pattern should play for (and be turned off for),\n per cycle\n\n:returns: the blinking pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "period", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "breathe", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that brightens and dims this one over time. Brightness\nfollows a sinusoidal pattern.\n\n:param period: how fast the breathing pattern should complete a single cycle\n\n:returns: the breathing pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "indexMapper", - "type": "Callable[[int, int], int]" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "mapIndex", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern with remapped indices.\n\n:param indexMapper: the index mapper\n\n:returns: the mapped pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "mask", - "type": "wpilib.LEDPattern" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "mask", - "returnType": "wpilib.LEDPattern", - "tooltip": "Similar to {@link LEDPattern::Blend(const LEDPattern&)}, but performs a\nbitwise mask on each color channel rather than averaging the colors for\neach LED. This can be helpful for displaying only a portion of the base\npattern by applying a mask that sets the desired area to white, and all\nother areas to black. However, it can also be used to display only certain\ncolor channels or hues; for example, masking with {@code\nLEDPattern.color(Color.kRed)} will turn off the green and blue channels on\nthe output pattern, leaving only the red LEDs to be illuminated.\n\n:param mask: the mask to apply\n\n:returns: the masked pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "offset", - "type": "int" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "offsetBy", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that displays this one, but offset by a certain number of\nLEDs. The offset pattern will wrap around, if necessary.\n\n:param offset: how many LEDs to offset by\n\n:returns: the offset pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "base", - "type": "wpilib.LEDPattern" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "overlayOn", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that plays this pattern overlaid on another. Anywhere\nthis pattern sets an LED to off (or {@link frc::Color::kBlack}), the base\npattern will be displayed instead.\n\n:param base: the base pattern to overlay on top of\n\n:returns: the combined overlay pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "reversed", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that displays this one in reverse. Scrolling patterns\nwill scroll in the opposite direction (but at the same speed). It will\ntreat the end of an LED strip as the start, and the start of the strip as\nthe end. This can be useful for making ping-pong patterns that travel from\none end of an LED strip to the other, then reverse direction and move back\nto the start. This can also be useful when working with LED strips\nconnected in a serpentine pattern (where the start of one strip is\nconnected to the end of the previous one).\n\n:returns: the reverse pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "velocity", - "type": "wpimath.units.meters_per_second" - }, - { - "defaultValue": "", - "name": "ledSpacing", - "type": "wpimath.units.meters" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "scrollAtAbsoluteSpeed", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that plays this one scrolling up an LED strip. A negative\nvelocity makes the pattern play in reverse.\n\nFor example, scrolling a pattern at 4 inches per second along an LED\nstrip with 60 LEDs per meter:\n\n::\n\n // LEDs per meter, a known value taken from the spec sheet of our\n particular LED strip units::meter_t LED_SPACING = units::meter_t{1 /60.0};\n \n frc::LEDPattern rainbow = frc::LEDPattern::Rainbow();\n frc::LEDPattern scrollingRainbow =\n rainbow.ScrollAtAbsoluteSpeed(units::feet_per_second_t{1 / 3.0},\n LED_SPACING);\n\nNote that this pattern will scroll *faster* if applied to a less\ndense LED strip (such as 30 LEDs per meter), or *slower* if applied to\na denser LED strip (such as 120 or 144 LEDs per meter).\n\n:param velocity: how fast the pattern should move along a physical LED strip\n:param ledSpacing: the distance between adjacent LEDs on the physical LED\n strip\n\n:returns: the scrolling pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "velocity", - "type": "wpimath.units.hertz" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "scrollAtRelativeSpeed", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that plays this one scrolling up the buffer. The velocity\ncontrols how fast the pattern returns back to its original position, and is\nin terms of the length of the LED strip; scrolling across a segment that is\n10 LEDs long will travel twice as fast as on a segment that's only 5 LEDs\nlong (assuming equal LED density on both segments)." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern" - }, - { - "defaultValue": "", - "name": "signal", - "type": "Callable[[], bool]" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "synchronizedBlink", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that blinks this one on and off in sync with a true/false\nsignal. The pattern will play while the signal outputs ``true``, and\nwill turn off while the signal outputs\n``false``.\n\n:param signal: the signal to synchronize with\n\n:returns: the blinking pattern" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "type", - "type": "wpilib.LEDPattern.GradientType" - }, - { - "defaultValue": "", - "name": "colors", - "type": "List[wpilib.Color]" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "gradient", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that displays a non-animated gradient of colors across\nthe entire length of the LED strip. Colors are evenly distributed along the\nfull length of the LED strip. The gradient type is configured with the\n``type`` parameter, allowing the gradient to be either continuous (no\nseams, good for scrolling effects) or discontinuous (a clear seam is\nvisible, but the gradient applies to the full length of the LED strip\nwithout needing to use some space for wrapping).\n\n:param type: the type of gradient (continuous or discontinuous)\n:param colors: the colors to display in the gradient\n\n:returns: a motionless gradient pattern" - }, - { - "args": [], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "off", - "returnType": "wpilib.LEDPattern", - "tooltip": "A pattern that turns off all LEDs." - }, - { - "args": [ - { - "defaultValue": "", - "name": "progressFunction", - "type": "Callable[[], float]" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "progressMaskLayer", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that works as a mask layer for {@link\nLEDPattern::Mask(const LEDPattern&)} that illuminates only the portion of\nthe LED strip corresponding with some progress. The mask pattern will start\nfrom the base and set LEDs to white at a proportion equal to the progress\nreturned by the function. Some usages for this could be for displaying\nprogress of a flywheel to its target velocity, progress of a complex\nautonomous sequence, or the height of an elevator.\n\nFor example, creating a mask for displaying a red-to-blue gradient,\nstarting from the red end, based on where an elevator is in its range of\ntravel.\n\n::\n\n frc::LEDPattern basePattern =\n frc::LEDPattern::Gradient(frc::Color::kRed, frc::Color::kBlue);\n frc::LEDPattern progressPattern =\n basePattern.Mask(frc::LEDPattern::ProgressMaskLayer([&]() {\n return elevator.GetHeight() / elevator.MaxHeight();\n });\n\n:param progressFunction: the function to call to determine the progress.\n This should return values in the range [0, 1]; any values outside that\n range will be clamped.\n\n:returns: the mask pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "saturation", - "type": "int" - }, - { - "defaultValue": "", - "name": "value", - "type": "int" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "rainbow", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates an LED pattern that displays a rainbow across the color wheel. The\nrainbow pattern will stretch across the entire length of the LED strip.\n\n:param saturation: the saturation of the HSV colors, in [0, 255]\n:param value: the value of the HSV colors, in [0, 255]\n\n:returns: the rainbow pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "color", - "type": "wpilib.Color" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "solid", - "returnType": "wpilib.LEDPattern", - "tooltip": "Creates a pattern that displays a single static color along the entire\nlength of the LED strip.\n\n:param color: the color to display\n\n:returns: the pattern" - }, - { - "args": [ - { - "defaultValue": "", - "name": "steps", - "type": "List[tuple[float, wpilib.Color]]" - } - ], - "declaringClassName": "wpilib.LEDPattern", - "functionName": "steps", - "returnType": "wpilib.LEDPattern", - "tooltip": "Display a set of colors in steps across the length of the LED strip. No\ninterpolation is done between colors. Colors are specified by the first LED\non the strip to show that color. The last color in the map will be\ndisplayed all the way to the end of the strip. LEDs positioned before the\nfirst specified step will be turned off (you can think of this as if\nthere's a 0 -> black step by default).\n\n:param steps: a map of progress to the color to start displaying at that\n position along the LED strip\n\n:returns: a motionless step pattern" - } - ] - }, - { - "className": "wpilib.LEDPattern.LEDReader", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "impl", - "type": "Callable[[int], wpilib.AddressableLED.LEDData]" - }, - { - "defaultValue": "", - "name": "size", - "type": "int" - } - ], - "declaringClassName": "wpilib.LEDPattern.LEDReader", - "functionName": "__init__", - "returnType": "wpilib.LEDPattern.LEDReader", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.LEDPattern.LEDReader" - } - ], - "declaringClassName": "wpilib.LEDPattern.LEDReader", - "functionName": "size", - "returnType": "int", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.LiveWindow", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.LiveWindow", - "functionName": "__init__", - "returnType": "wpilib.LiveWindow", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.LiveWindow", - "functionName": "disableAllTelemetry", - "returnType": "None", - "tooltip": "Disable ALL telemetry." - }, - { - "args": [ - { - "defaultValue": "", - "name": "component", - "type": "wpiutil.Sendable" - } - ], - "declaringClassName": "wpilib.LiveWindow", - "functionName": "disableTelemetry", - "returnType": "None", - "tooltip": "Disable telemetry for a single component.\n\n:param component: sendable" - }, - { - "args": [], - "declaringClassName": "wpilib.LiveWindow", - "functionName": "enableAllTelemetry", - "returnType": "None", - "tooltip": "Enable ALL telemetry." - }, - { - "args": [ - { - "defaultValue": "", - "name": "component", - "type": "wpiutil.Sendable" - } - ], - "declaringClassName": "wpilib.LiveWindow", - "functionName": "enableTelemetry", - "returnType": "None", - "tooltip": "Enable telemetry for a single component.\n\n:param component: sendable" - }, - { - "args": [], - "declaringClassName": "wpilib.LiveWindow", - "functionName": "isEnabled", - "returnType": "bool", - "tooltip": "Returns true if LiveWindow is enabled.\n\n:returns: True if LiveWindow is enabled." - }, - { - "args": [ - { - "defaultValue": "", - "name": "func", - "type": "Callable[[], None]" - } - ], - "declaringClassName": "wpilib.LiveWindow", - "functionName": "setDisabledCallback", - "returnType": "None", - "tooltip": "Sets function to be called when LiveWindow is disabled.\n\n:param func: function (or nullptr for none)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.LiveWindow", - "functionName": "setEnabled", - "returnType": "None", - "tooltip": "Change the enabled status of LiveWindow.\n\nIf it changes to enabled, start livewindow running otherwise stop it" - }, - { - "args": [ - { - "defaultValue": "", - "name": "func", - "type": "Callable[[], None]" - } - ], - "declaringClassName": "wpilib.LiveWindow", - "functionName": "setEnabledCallback", - "returnType": "None", - "tooltip": "Sets function to be called when LiveWindow is enabled.\n\n:param func: function (or nullptr for none)" - }, - { - "args": [], - "declaringClassName": "wpilib.LiveWindow", - "functionName": "updateValues", - "returnType": "None", - "tooltip": "Tell all the sensors to update (send) their values.\n\nActuators are handled through callbacks on their value changing from the\nSmartDashboard widgets." - } - ] - }, - { - "className": "wpilib.Mechanism2d", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "width", - "type": "float" - }, - { - "defaultValue": "", - "name": "height", - "type": "float" - }, - { - "defaultValue": "Color8Bit(red=0, green=0, blue=32)", - "name": "backgroundColor", - "type": "wpilib.Color8Bit" - } - ], - "declaringClassName": "wpilib.Mechanism2d", - "functionName": "__init__", - "returnType": "wpilib.Mechanism2d", - "tooltip": "Create a new Mechanism2d with the given dimensions and background color.\n\nThe dimensions represent the canvas that all the nodes are drawn on. The\ndefault color is dark blue.\n\n:param width: the width\n:param height: the height\n:param backgroundColor: the background color" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Mechanism2d" - }, - { - "defaultValue": "", - "name": "name", - "type": "str" - }, - { - "defaultValue": "", - "name": "x", - "type": "float" - }, - { - "defaultValue": "", - "name": "y", - "type": "float" - } - ], - "declaringClassName": "wpilib.Mechanism2d", - "functionName": "getRoot", - "returnType": "wpilib.MechanismRoot2d", - "tooltip": "Get or create a root in this Mechanism2d with the given name and\nposition.\n\nIf a root with the given name already exists, the given x and y\ncoordinates are not used.\n\n:param name: the root name\n:param x: the root x coordinate\n:param y: the root y coordinate\n\n:returns: a new root object, or the existing one with the given name." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Mechanism2d" - }, - { - "defaultValue": "", - "name": "builder", - "type": "ntcore.NTSendableBuilder" - } - ], - "declaringClassName": "wpilib.Mechanism2d", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Mechanism2d" - }, - { - "defaultValue": "", - "name": "color", - "type": "wpilib.Color8Bit" - } - ], - "declaringClassName": "wpilib.Mechanism2d", - "functionName": "setBackgroundColor", - "returnType": "None", - "tooltip": "Set the Mechanism2d background color.\n\n:param color: the new background color" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.MechanismLigament2d", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.MechanismLigament2d", - "functionName": "__init__", - "returnType": "wpilib.MechanismLigament2d", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismObject2d" - }, - { - "defaultValue": "", - "name": "name", - "type": "str" - }, - { - "defaultValue": "", - "name": "length", - "type": "float" - }, - { - "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" - }, - { - "defaultValue": "6", - "name": "lineWidth", - "type": "float" - }, - { - "defaultValue": "Color8Bit(red=235, green=137, blue=52)", - "name": "color", - "type": "wpilib.Color8Bit" - } - ], - "declaringClassName": "wpilib.MechanismObject2d", - "functionName": "appendLigament", - "returnType": "wpilib.MechanismLigament2d", - "tooltip": "Append a ligament node" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismLigament2d" - } - ], - "declaringClassName": "wpilib.MechanismLigament2d", - "functionName": "getAngle", - "returnType": "float", - "tooltip": "Get the ligament's angle relative to its parent.\n\n:returns: the angle" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismLigament2d" - } - ], - "declaringClassName": "wpilib.MechanismLigament2d", - "functionName": "getColor", - "returnType": "wpilib.Color8Bit", - "tooltip": "Get the ligament color.\n\n:returns: the color of the line" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismLigament2d" - } - ], - "declaringClassName": "wpilib.MechanismLigament2d", - "functionName": "getLength", - "returnType": "float", - "tooltip": "Get the ligament length.\n\n:returns: the line length" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismLigament2d" - } - ], - "declaringClassName": "wpilib.MechanismLigament2d", - "functionName": "getLineWeight", - "returnType": "float", - "tooltip": "Get the line thickness.\n\n:returns: the line thickness" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismObject2d" - } - ], - "declaringClassName": "wpilib.MechanismObject2d", - "functionName": "getName", - "returnType": "str", - "tooltip": "Retrieve the object's name.\n\n:returns: the object's name relative to its parent." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismLigament2d" - }, - { - "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" - } - ], - "declaringClassName": "wpilib.MechanismLigament2d", - "functionName": "setAngle", - "returnType": "None", - "tooltip": "Set the ligament's angle relative to its parent.\n\n:param angle: the angle" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismLigament2d" - }, - { - "defaultValue": "", - "name": "color", - "type": "wpilib.Color8Bit" - } - ], - "declaringClassName": "wpilib.MechanismLigament2d", - "functionName": "setColor", - "returnType": "None", - "tooltip": "Set the ligament color.\n\n:param color: the color of the line" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismLigament2d" - }, - { - "defaultValue": "", - "name": "length", - "type": "float" - } - ], - "declaringClassName": "wpilib.MechanismLigament2d", - "functionName": "setLength", - "returnType": "None", - "tooltip": "Set the ligament's length.\n\n:param length: the line length" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismLigament2d" - }, - { - "defaultValue": "", - "name": "lineWidth", - "type": "float" - } - ], - "declaringClassName": "wpilib.MechanismLigament2d", - "functionName": "setLineWeight", - "returnType": "None", - "tooltip": "Set the line thickness.\n\n:param lineWidth: the line thickness" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.MechanismObject2d", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.MechanismObject2d", - "functionName": "__init__", - "returnType": "wpilib.MechanismObject2d", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismObject2d" - }, - { - "defaultValue": "", - "name": "name", - "type": "str" - }, - { - "defaultValue": "", - "name": "length", - "type": "float" - }, - { - "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" - }, - { - "defaultValue": "6", - "name": "lineWidth", - "type": "float" - }, - { - "defaultValue": "Color8Bit(red=235, green=137, blue=52)", - "name": "color", - "type": "wpilib.Color8Bit" - } - ], - "declaringClassName": "wpilib.MechanismObject2d", - "functionName": "appendLigament", - "returnType": "wpilib.MechanismLigament2d", - "tooltip": "Append a ligament node" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismObject2d" - } - ], - "declaringClassName": "wpilib.MechanismObject2d", - "functionName": "getName", - "returnType": "str", - "tooltip": "Retrieve the object's name.\n\n:returns: the object's name relative to its parent." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.MechanismRoot2d", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.MechanismRoot2d", - "functionName": "__init__", - "returnType": "wpilib.MechanismRoot2d", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismRoot2d" - }, - { - "defaultValue": "", - "name": "name", - "type": "str" - }, - { - "defaultValue": "", - "name": "length", - "type": "float" - }, - { - "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" - }, - { - "defaultValue": "6", - "name": "lineWidth", - "type": "float" - }, - { - "defaultValue": "Color8Bit(red=235, green=137, blue=52)", - "name": "color", - "type": "wpilib.Color8Bit" - } - ], - "declaringClassName": "wpilib.MechanismRoot2d", - "functionName": "appendLigament", - "returnType": "wpilib.MechanismLigament2d", - "tooltip": "Append a ligament node" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismRoot2d" - } - ], - "declaringClassName": "wpilib.MechanismRoot2d", - "functionName": "getName", - "returnType": "str", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MechanismRoot2d" - }, - { - "defaultValue": "", - "name": "x", - "type": "float" - }, - { - "defaultValue": "", - "name": "y", - "type": "float" - } - ], - "declaringClassName": "wpilib.MechanismRoot2d", - "functionName": "setPosition", - "returnType": "None", - "tooltip": "Set the root's position.\n\n:param x: new x coordinate\n:param y: new y coordinate" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.MotorControllerGroup", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - } - ], - "declaringClassName": "wpilib.MotorControllerGroup", - "functionName": "__init__", - "returnType": "wpilib.MotorControllerGroup", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorControllerGroup" - } - ], - "declaringClassName": "wpilib.MotorControllerGroup", - "functionName": "disable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorControllerGroup" - } - ], - "declaringClassName": "wpilib.MotorControllerGroup", - "functionName": "get", - "returnType": "float", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorControllerGroup" - } - ], - "declaringClassName": "wpilib.MotorControllerGroup", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorControllerGroup" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.MotorControllerGroup", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorControllerGroup" - }, - { - "defaultValue": "", - "name": "speed", - "type": "float" - } - ], - "declaringClassName": "wpilib.MotorControllerGroup", - "functionName": "set", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorControllerGroup" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorControllerGroup", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorControllerGroup" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.MotorControllerGroup", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorControllerGroup" - } - ], - "declaringClassName": "wpilib.MotorControllerGroup", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.MotorSafety", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "__init__", - "returnType": "wpilib.MotorSafety", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "Returns a description to print when an error occurs.\n\n:returns: Description to print when an error occurs." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "Called to stop the motor when the timeout expires." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.NidecBrushless", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "pwmChannel", - "type": "int" - }, - { - "defaultValue": "", - "name": "dioChannel", - "type": "int" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "__init__", - "returnType": "wpilib.NidecBrushless", - "tooltip": "Constructor.\n\n:param pwmChannel: The PWM channel that the Nidec Brushless controller is\n attached to. 0-9 are on-board, 10-19 are on the MXP port.\n:param dioChannel: The DIO channel that the Nidec Brushless controller is\n attached to. 0-9 are on-board, 10-25 are on the MXP port." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.NidecBrushless" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "disable", - "returnType": "None", - "tooltip": "Disable the motor. The Enable() function must be called to re-enable the\nmotor." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.NidecBrushless" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "enable", - "returnType": "None", - "tooltip": "Re-enable the motor after Disable() has been called. The Set() function\nmust be called to set a new motor speed." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.NidecBrushless" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.NidecBrushless" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "Gets the channel number associated with the object.\n\n:returns: The channel number." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.NidecBrushless" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.NidecBrushless" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.NidecBrushless" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.NidecBrushless" - }, - { - "defaultValue": "", - "name": "speed", - "type": "float" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param speed: The speed value between -1.0 and 1.0 to set." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.NidecBrushless" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.MotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.interfaces.MotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the MotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.NidecBrushless" - } - ], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.NidecBrushless", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.Notifier", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "handler", - "type": "Callable[[], None]" - } - ], - "declaringClassName": "wpilib.Notifier", - "functionName": "__init__", - "returnType": "wpilib.Notifier", - "tooltip": "Create a Notifier for timer event notification.\n\n:param handler: The handler is called at the notification time which is set\n using StartSingle or StartPeriodic." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Notifier" - }, - { - "defaultValue": "", - "name": "handler", - "type": "Callable[[], None]" - } - ], - "declaringClassName": "wpilib.Notifier", - "functionName": "setCallback", - "returnType": "None", - "tooltip": "Change the handler function.\n\n:param handler: Handler" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Notifier" - }, - { - "defaultValue": "", - "name": "name", - "type": "str" - } - ], - "declaringClassName": "wpilib.Notifier", - "functionName": "setName", - "returnType": "None", - "tooltip": "Sets the name of the notifier. Used for debugging purposes only.\n\n:param name: Name" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Notifier" - }, - { - "defaultValue": "", - "name": "period", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.Notifier", - "functionName": "startPeriodic", - "returnType": "None", - "tooltip": "Register for periodic event notification.\n\nA timer event is queued for periodic event notification. Each time the\ninterrupt occurs, the event will be immediately requeued for the same time\ninterval.\n\n:param period: Period to call the handler starting one period\n after the call to this method." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Notifier" - }, - { - "defaultValue": "", - "name": "delay", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.Notifier", - "functionName": "startSingle", - "returnType": "None", - "tooltip": "Register for single event notification.\n\nA timer event is queued for a single event after the specified delay.\n\n:param delay: Amount of time to wait before the handler is called." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Notifier" - } - ], - "declaringClassName": "wpilib.Notifier", - "functionName": "stop", - "returnType": "None", - "tooltip": "Stop timer events from occurring.\n\nStop any repeating timer events from occurring. This will also remove any\nsingle notification events from the queue.\n\nIf a timer-based call to the registered handler is in progress, this\nfunction will block until the handler call is complete." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "realTime", - "type": "bool" - }, - { - "defaultValue": "", - "name": "priority", - "type": "int" - } - ], - "declaringClassName": "wpilib.Notifier", - "functionName": "setHALThreadPriority", - "returnType": "bool", - "tooltip": "Sets the HAL notifier thread priority.\n\nThe HAL notifier thread is responsible for managing the FPGA's notifier\ninterrupt and waking up user's Notifiers when it's their time to run.\nGiving the HAL notifier thread real-time priority helps ensure the user's\nreal-time Notifiers, if any, are notified to run in a timely manner.\n\n:param realTime: Set to true to set a real-time priority, false for standard\n priority.\n:param priority: Priority to set the thread to. For real-time, this is 1-99\n with 99 being highest. For non-real-time, this is forced to\n 0. See \"man 7 sched\" for more details.\n\n:returns: True on success." - } - ] - }, - { - "className": "wpilib.PS4Controller", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "port", - "type": "int" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "__init__", - "returnType": "wpilib.PS4Controller", - "tooltip": "Construct an instance of a controller.\n\nThe controller index is the USB port on the Driver Station.\n\n:param port: The port on the Driver Station that the controller is plugged\n into (0-5)." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "L1", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the left trigger 1 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left trigger 1 button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "L2", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the left trigger 2 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left trigger 2 button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "L3", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the L3 (left stick) button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the L3 (left stick) button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "angle", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POV", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "pov", - "type": "int" - }, - { - "defaultValue": "", - "name": "angle", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POV", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVCenter", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the center (not pressed) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the center of a POV on the\n HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDown", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 180 degree angle (down)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 180 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDownLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 225 degree angle (down\nleft) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 225 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDownRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 135 degree angle (right\ndown) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 135 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 270 degree angle (left)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 270 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 90 degree angle (right)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 90 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUp", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 0 degree angle (up) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 0 degree angle of a POV on\n the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUpLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 315 degree angle (left\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 315 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUpRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 45 degree angle (right\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 45 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "PS", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the PlayStation button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the PlayStation button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "R1", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the right trigger 1 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right trigger 1 button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "R2", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the right trigger 2 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right trigger 2 button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "R3", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the R3 (right stick) button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the R3 (right stick) button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "axisGreaterThan", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance that is true when the axis value is greater\nthan threshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value above which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is greater than\n the provided threshold." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "axisLessThan", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance that is true when the axis value is less than\nthreshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value below which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is less than the\n provided threshold." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "button", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around this button's digital signal.\n\n:param button: the button index\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the button's digital signal attached\n to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "circle", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the circle button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the circle button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "cross", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the cross button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the cross button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getAxisCount", - "returnType": "int", - "tooltip": "Get the number of axes for the HID.\n\n:returns: the number of axis for the current HID" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getAxisType", - "returnType": "int", - "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getButtonCount", - "returnType": "int", - "tooltip": "Get the number of buttons for the HID.\n\n:returns: the number of buttons on the current HID" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getCircleButton", - "returnType": "bool", - "tooltip": "Read the value of the circle button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getCircleButtonPressed", - "returnType": "bool", - "tooltip": "Whether the circle button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getCircleButtonReleased", - "returnType": "bool", - "tooltip": "Whether the circle button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getCrossButton", - "returnType": "bool", - "tooltip": "Read the value of the cross button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getCrossButtonPressed", - "returnType": "bool", - "tooltip": "Whether the cross button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getCrossButtonReleased", - "returnType": "bool", - "tooltip": "Whether the cross button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getL1Button", - "returnType": "bool", - "tooltip": "Read the value of the left trigger 1 button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getL1ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the left trigger 1 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getL1ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the left trigger 1 button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getL2Axis", - "returnType": "float", - "tooltip": "Get the left trigger 2 axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getL2Button", - "returnType": "bool", - "tooltip": "Read the value of the left trigger 2 button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getL2ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the left trigger 2 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getL2ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the left trigger 2 button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getL3Button", - "returnType": "bool", - "tooltip": "Read the value of the L3 (left stick) button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getL3ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the L3 (left stick) button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getL3ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the L3 (left stick) button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getLeftX", - "returnType": "float", - "tooltip": "Get the X axis value of left side of the controller.\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getLeftY", - "returnType": "float", - "tooltip": "Get the Y axis value of left side of the controller.\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getName", - "returnType": "str", - "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getOptionsButton", - "returnType": "bool", - "tooltip": "Read the value of the options button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getOptionsButtonPressed", - "returnType": "bool", - "tooltip": "Whether the options button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getOptionsButtonReleased", - "returnType": "bool", - "tooltip": "Whether the options button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "0", - "name": "pov", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPOV", - "returnType": "int", - "tooltip": "Get the angle in degrees of a POV on the HID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(e.g. right is 90, upper-left is 315).\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV in degrees, or -1 if the POV is not pressed." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPOVCount", - "returnType": "int", - "tooltip": "Get the number of POVs for the HID.\n\n:returns: the number of POVs for the current HID" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getPSButton", - "returnType": "bool", - "tooltip": "Read the value of the PlayStation button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getPSButtonPressed", - "returnType": "bool", - "tooltip": "Whether the PlayStation button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getPSButtonReleased", - "returnType": "bool", - "tooltip": "Whether the PlayStation button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPort", - "returnType": "int", - "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getR1Button", - "returnType": "bool", - "tooltip": "Read the value of the right trigger 1 button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getR1ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the right trigger 1 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getR1ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the right trigger 1 button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getR2Axis", - "returnType": "float", - "tooltip": "Get the right trigger 2 axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getR2Button", - "returnType": "bool", - "tooltip": "Read the value of the right trigger 2 button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getR2ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the right trigger 2 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getR2ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the right trigger 2 button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getR3Button", - "returnType": "bool", - "tooltip": "Read the value of the R3 (right stick) button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getR3ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the R3 (right stick) button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getR3ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the R3 (right stick) button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawAxis", - "returnType": "float", - "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButton", - "returnType": "bool", - "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonPressed", - "returnType": "bool", - "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonReleased", - "returnType": "bool", - "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getRightX", - "returnType": "float", - "tooltip": "Get the X axis value of right side of the controller.\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getRightY", - "returnType": "float", - "tooltip": "Get the Y axis value of right side of the controller.\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getShareButton", - "returnType": "bool", - "tooltip": "Read the value of the share button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getShareButtonPressed", - "returnType": "bool", - "tooltip": "Whether the share button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getShareButtonReleased", - "returnType": "bool", - "tooltip": "Whether the share button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getSquareButton", - "returnType": "bool", - "tooltip": "Read the value of the square button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getSquareButtonPressed", - "returnType": "bool", - "tooltip": "Whether the square button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getSquareButtonReleased", - "returnType": "bool", - "tooltip": "Whether the square button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getTouchpad", - "returnType": "bool", - "tooltip": "Read the value of the touchpad button on the controller.\n\n:deprecated: Use GetTouchpadButton instead. This function is deprecated for\n removal to make function names consistent to allow the HID classes to be\n automatically generated.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getTouchpadButton", - "returnType": "bool", - "tooltip": "Read the value of the touchpad button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getTouchpadButtonPressed", - "returnType": "bool", - "tooltip": "Whether the touchpad button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getTouchpadButtonReleased", - "returnType": "bool", - "tooltip": "Whether the touchpad button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getTouchpadPressed", - "returnType": "bool", - "tooltip": "Whether the touchpad was pressed since the last check.\n\n:deprecated: Use GetTouchpadButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the touchpad was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getTouchpadReleased", - "returnType": "bool", - "tooltip": "Whether the touchpad was released since the last check.\n\n:deprecated: Use GetLeftBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: Whether the touchpad was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getTriangleButton", - "returnType": "bool", - "tooltip": "Read the value of the triangle button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getTriangleButtonPressed", - "returnType": "bool", - "tooltip": "Whether the triangle button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "getTriangleButtonReleased", - "returnType": "bool", - "tooltip": "Whether the triangle button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getType", - "returnType": "wpilib.interfaces.GenericHID.HIDType", - "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "isConnected", - "returnType": "bool", - "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "options", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the options button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the options button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "outputNumber", - "type": "int" - }, - { - "defaultValue": "", - "name": "value", - "type": "bool" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setOutput", - "returnType": "None", - "tooltip": "Set a single HID output value for the HID.\n\n:param outputNumber: The index of the output to set (1-32)\n:param value: The value to set the output to" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "value", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setOutputs", - "returnType": "None", - "tooltip": "Set all output values for the HID.\n\n:param value: The 32 bit output value (1 bit for each output)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.interfaces.GenericHID.RumbleType" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setRumble", - "returnType": "None", - "tooltip": "Set the rumble output for the HID.\n\nThe DS currently supports 2 rumble values, left rumble and right rumble.\n\n:param type: Which rumble value to set\n:param value: The normalized value (0 to 1) to set the rumble to" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "share", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the share button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the share button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "square", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the square button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the square button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "touchpad", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the touchpad button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the touchpad button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS4Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS4Controller", - "functionName": "triangle", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the triangle button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the triangle button's\n digital signal attached to the given loop." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.PS4Controller.Axis", - "classVariables": [ - { - "name": "kL2", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kLeftX", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kLeftY", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kR2", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kRightX", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kRightY", - "tooltip": "", - "type": "int", - "writable": false - } - ], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.PS4Controller.Axis", - "functionName": "__init__", - "returnType": "wpilib.PS4Controller.Axis", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.PS4Controller.Button", - "classVariables": [ - { - "name": "kCircle", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kCross", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kL1", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kL2", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kL3", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kOptions", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kPS", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kR1", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kR2", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kR3", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kShare", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kSquare", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kTouchpad", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kTriangle", - "tooltip": "", - "type": "int", - "writable": false - } - ], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.PS4Controller.Button", - "functionName": "__init__", - "returnType": "wpilib.PS4Controller.Button", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.PS5Controller", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "port", - "type": "int" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "__init__", - "returnType": "wpilib.PS5Controller", - "tooltip": "Construct an instance of a controller.\n\nThe controller index is the USB port on the Driver Station.\n\n:param port: The port on the Driver Station that the controller is plugged\n into (0-5)." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "L1", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the left trigger 1 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left trigger 1 button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "L2", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the left trigger 2 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left trigger 2 button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "L3", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the L3 (left stick) button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the L3 (left stick) button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "angle", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POV", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "pov", - "type": "int" - }, - { - "defaultValue": "", - "name": "angle", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POV", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVCenter", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the center (not pressed) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the center of a POV on the\n HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDown", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 180 degree angle (down)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 180 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDownLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 225 degree angle (down\nleft) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 225 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDownRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 135 degree angle (right\ndown) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 135 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 270 degree angle (left)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 270 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 90 degree angle (right)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 90 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUp", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 0 degree angle (up) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 0 degree angle of a POV on\n the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUpLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 315 degree angle (left\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 315 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUpRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 45 degree angle (right\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 45 degree angle of a POV\n on the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "PS", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the PlayStation button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the PlayStation button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "R1", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the right trigger 1 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right trigger 1 button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "R2", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the right trigger 2 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right trigger 2 button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "R3", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the R3 (right stick) button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the R3 (right stick) button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "axisGreaterThan", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance that is true when the axis value is greater\nthan threshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value above which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is greater than\n the provided threshold." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "axisLessThan", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance that is true when the axis value is less than\nthreshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value below which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is less than the\n provided threshold." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "button", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around this button's digital signal.\n\n:param button: the button index\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the button's digital signal attached\n to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "circle", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the circle button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the circle button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "create", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the create button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the create button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "cross", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the cross button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the cross button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getAxisCount", - "returnType": "int", - "tooltip": "Get the number of axes for the HID.\n\n:returns: the number of axis for the current HID" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getAxisType", - "returnType": "int", - "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getButtonCount", - "returnType": "int", - "tooltip": "Get the number of buttons for the HID.\n\n:returns: the number of buttons on the current HID" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getCircleButton", - "returnType": "bool", - "tooltip": "Read the value of the circle button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getCircleButtonPressed", - "returnType": "bool", - "tooltip": "Whether the circle button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getCircleButtonReleased", - "returnType": "bool", - "tooltip": "Whether the circle button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getCreateButton", - "returnType": "bool", - "tooltip": "Read the value of the create button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getCreateButtonPressed", - "returnType": "bool", - "tooltip": "Whether the create button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getCreateButtonReleased", - "returnType": "bool", - "tooltip": "Whether the create button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getCrossButton", - "returnType": "bool", - "tooltip": "Read the value of the cross button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getCrossButtonPressed", - "returnType": "bool", - "tooltip": "Whether the cross button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getCrossButtonReleased", - "returnType": "bool", - "tooltip": "Whether the cross button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getL1Button", - "returnType": "bool", - "tooltip": "Read the value of the left trigger 1 button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getL1ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the left trigger 1 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getL1ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the left trigger 1 button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getL2Axis", - "returnType": "float", - "tooltip": "Get the left trigger 2 axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getL2Button", - "returnType": "bool", - "tooltip": "Read the value of the left trigger 2 button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getL2ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the left trigger 2 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getL2ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the left trigger 2 button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getL3Button", - "returnType": "bool", - "tooltip": "Read the value of the L3 (left stick) button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getL3ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the L3 (left stick) button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getL3ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the L3 (left stick) button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getLeftX", - "returnType": "float", - "tooltip": "Get the X axis value of left side of the controller.\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getLeftY", - "returnType": "float", - "tooltip": "Get the Y axis value of left side of the controller.\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getName", - "returnType": "str", - "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getOptionsButton", - "returnType": "bool", - "tooltip": "Read the value of the options button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getOptionsButtonPressed", - "returnType": "bool", - "tooltip": "Whether the options button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getOptionsButtonReleased", - "returnType": "bool", - "tooltip": "Whether the options button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "0", - "name": "pov", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPOV", - "returnType": "int", - "tooltip": "Get the angle in degrees of a POV on the HID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(e.g. right is 90, upper-left is 315).\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV in degrees, or -1 if the POV is not pressed." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPOVCount", - "returnType": "int", - "tooltip": "Get the number of POVs for the HID.\n\n:returns: the number of POVs for the current HID" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getPSButton", - "returnType": "bool", - "tooltip": "Read the value of the PlayStation button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getPSButtonPressed", - "returnType": "bool", - "tooltip": "Whether the PlayStation button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getPSButtonReleased", - "returnType": "bool", - "tooltip": "Whether the PlayStation button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPort", - "returnType": "int", - "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getR1Button", - "returnType": "bool", - "tooltip": "Read the value of the right trigger 1 button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getR1ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the right trigger 1 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getR1ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the right trigger 1 button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getR2Axis", - "returnType": "float", - "tooltip": "Get the right trigger 2 axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getR2Button", - "returnType": "bool", - "tooltip": "Read the value of the right trigger 2 button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getR2ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the right trigger 2 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getR2ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the right trigger 2 button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getR3Button", - "returnType": "bool", - "tooltip": "Read the value of the R3 (right stick) button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getR3ButtonPressed", - "returnType": "bool", - "tooltip": "Whether the R3 (right stick) button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getR3ButtonReleased", - "returnType": "bool", - "tooltip": "Whether the R3 (right stick) button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawAxis", - "returnType": "float", - "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButton", - "returnType": "bool", - "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonPressed", - "returnType": "bool", - "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonReleased", - "returnType": "bool", - "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getRightX", - "returnType": "float", - "tooltip": "Get the X axis value of right side of the controller.\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getRightY", - "returnType": "float", - "tooltip": "Get the Y axis value of right side of the controller.\n\n:returns: the axis value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getSquareButton", - "returnType": "bool", - "tooltip": "Read the value of the square button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getSquareButtonPressed", - "returnType": "bool", - "tooltip": "Whether the square button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getSquareButtonReleased", - "returnType": "bool", - "tooltip": "Whether the square button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getTouchpad", - "returnType": "bool", - "tooltip": "Read the value of the touchpad button on the controller.\n\n:deprecated: Use GetTouchpadButton instead. This function is deprecated for\n removal to make function names consistent to allow the HID classes to be\n automatically generated.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getTouchpadButton", - "returnType": "bool", - "tooltip": "Read the value of the touchpad button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getTouchpadButtonPressed", - "returnType": "bool", - "tooltip": "Whether the touchpad button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getTouchpadButtonReleased", - "returnType": "bool", - "tooltip": "Whether the touchpad button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getTouchpadPressed", - "returnType": "bool", - "tooltip": "Whether the touchpad was pressed since the last check.\n\n:deprecated: Use GetTouchpadButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the touchpad was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getTouchpadReleased", - "returnType": "bool", - "tooltip": "Whether the touchpad was released since the last check.\n\n:deprecated: Use GetLeftBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: Whether the touchpad was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getTriangleButton", - "returnType": "bool", - "tooltip": "Read the value of the triangle button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getTriangleButtonPressed", - "returnType": "bool", - "tooltip": "Whether the triangle button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "getTriangleButtonReleased", - "returnType": "bool", - "tooltip": "Whether the triangle button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getType", - "returnType": "wpilib.interfaces.GenericHID.HIDType", - "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "isConnected", - "returnType": "bool", - "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "options", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the options button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the options button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "outputNumber", - "type": "int" - }, - { - "defaultValue": "", - "name": "value", - "type": "bool" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setOutput", - "returnType": "None", - "tooltip": "Set a single HID output value for the HID.\n\n:param outputNumber: The index of the output to set (1-32)\n:param value: The value to set the output to" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "value", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setOutputs", - "returnType": "None", - "tooltip": "Set all output values for the HID.\n\n:param value: The 32 bit output value (1 bit for each output)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.interfaces.GenericHID.RumbleType" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setRumble", - "returnType": "None", - "tooltip": "Set the rumble output for the HID.\n\nThe DS currently supports 2 rumble values, left rumble and right rumble.\n\n:param type: Which rumble value to set\n:param value: The normalized value (0 to 1) to set the rumble to" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "square", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the square button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the square button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "touchpad", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the touchpad button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the touchpad button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PS5Controller" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.PS5Controller", - "functionName": "triangle", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the triangle button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the triangle button's\n digital signal attached to the given loop." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.PS5Controller.Axis", - "classVariables": [ - { - "name": "kL2", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kLeftX", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kLeftY", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kR2", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kRightX", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kRightY", - "tooltip": "", - "type": "int", - "writable": false - } - ], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.PS5Controller.Axis", - "functionName": "__init__", - "returnType": "wpilib.PS5Controller.Axis", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.PS5Controller.Button", - "classVariables": [ - { - "name": "kCircle", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kCreate", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kCross", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kL1", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kL2", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kL3", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kOptions", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kPS", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kR1", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kR2", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kR3", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kSquare", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kTouchpad", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kTriangle", - "tooltip": "", - "type": "int", - "writable": false - } - ], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.PS5Controller.Button", - "functionName": "__init__", - "returnType": "wpilib.PS5Controller.Button", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.PWM", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - }, - { - "defaultValue": "True", - "name": "registerSendable", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "__init__", - "returnType": "wpilib.PWM", - "tooltip": "Allocate a PWM given a channel number.\n\nChecks channel value range and allocates the appropriate channel.\nThe allocation is only done to help users ensure that they don't double\nassign channels.\n\n:param channel: The PWM channel number. 0-9 are on-board, 10-19 are on the\n MXP port\n:param registerSendable: If true, adds this instance to SendableRegistry\n and LiveWindow" - } - ], - "enums": [ - { - "enumClassName": "wpilib.PWM.PeriodMultiplier", - "enumValues": [ - "kPeriodMultiplier_1X", - "kPeriodMultiplier_2X", - "kPeriodMultiplier_4X" - ], - "moduleName": "wpilib", - "tooltip": "Represents the amount to multiply the minimum servo-pulse pwm period by.\n\nMembers:\n\n kPeriodMultiplier_1X : Don't skip pulses. PWM pulses occur every 5.05 ms\n\n kPeriodMultiplier_2X : Skip every other pulse. PWM pulses occur every 10.10 ms\n\n kPeriodMultiplier_4X : Skip three out of four pulses. PWM pulses occur every 20.20 ms" - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "max", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "deadbandMax", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "center", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "deadbandMin", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "min", - "type": "wpimath.units.microseconds" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "getBounds", - "returnType": "None", - "tooltip": "Get the bounds on the PWM values.\n\nThis gets the bounds on the PWM values for a particular each type of\ncontroller. The values determine the upper and lower speeds as well as the\ndeadband bracket.\n\n:param max: The maximum pwm value\n:param deadbandMax: The high end of the deadband range\n:param center: The center speed (off)\n:param deadbandMin: The low end of the deadband range\n:param min: The minimum pwm value" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "getPosition", - "returnType": "float", - "tooltip": "Get the PWM value in terms of a position.\n\nThis is intended to be used by servos.\n\n@pre SetBounds() called.\n\n:returns: The position the servo is set to between 0.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "getPulseTime", - "returnType": "wpimath.units.microseconds", - "tooltip": "Get the PWM pulse time directly from the hardware.\n\nRead a microsecond value from a PWM channel.\n\n:returns: Microsecond PWM control value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "getSpeed", - "returnType": "float", - "tooltip": "Get the PWM value in terms of speed.\n\nThis is intended to be used by motor controllers.\n\n@pre SetBounds() called.\n\n:returns: The most recently set speed between -1.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "setAlwaysHighMode", - "returnType": "None", - "tooltip": "Sets the PWM output to be a continuous high signal while enabled." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "max", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "deadbandMax", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "center", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "deadbandMin", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "min", - "type": "wpimath.units.microseconds" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "setBounds", - "returnType": "None", - "tooltip": "Set the bounds on the PWM pulse widths.\n\nThis sets the bounds on the PWM values for a particular type of controller.\nThe values determine the upper and lower speeds as well as the deadband\nbracket.\n\n:param max: The max PWM pulse width in us\n:param deadbandMax: The high end of the deadband range pulse width in us\n:param center: The center (off) pulse width in us\n:param deadbandMin: The low end of the deadband pulse width in us\n:param min: The minimum pulse width in us" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "setDisabled", - "returnType": "None", - "tooltip": "Temporarily disables the PWM output. The next set call will re-enable\nthe output." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "mult", - "type": "wpilib.PWM.PeriodMultiplier" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "setPeriodMultiplier", - "returnType": "None", - "tooltip": "Slow down the PWM signal for old devices.\n\n:param mult: The period multiplier to apply to this channel" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "pos", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "setPosition", - "returnType": "None", - "tooltip": "Set the PWM value based on a position.\n\nThis is intended to be used by servos.\n\n@pre SetBounds() called.\n\n:param pos: The position to set the servo between 0.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "time", - "type": "wpimath.units.microseconds" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "setPulseTime", - "returnType": "None", - "tooltip": "Set the PWM pulse time directly to the hardware.\n\nWrite a microsecond value to a PWM channel.\n\n:param time: Microsecond PWM value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "speed", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "setSpeed", - "returnType": "None", - "tooltip": "Set the PWM value based on a speed.\n\nThis is intended to be used by motor controllers.\n\n@pre SetBounds() called.\n\n:param speed: The speed to set the motor controller between -1.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - } - ], - "declaringClassName": "wpilib.PWM", - "functionName": "setZeroLatch", - "returnType": "None", - "tooltip": "Latches PWM to zero." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.PWMMotorController", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "name", - "type": "str" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "__init__", - "returnType": "wpilib.PWMMotorController", - "tooltip": "Constructor for a PWM Motor %Controller connected via PWM.\n\n:param name: Name to use for SendableRegistry\n:param channel: The PWM channel that the controller is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.PWMSparkFlex", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.PWMSparkFlex", - "functionName": "__init__", - "returnType": "wpilib.PWMSparkFlex", - "tooltip": "Constructor for a SPARK Flex connected via PWM.\n\n:param channel: The PWM channel that the SPARK Flex is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.PWMSparkFlex", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.PWMSparkMax", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.PWMSparkMax", - "functionName": "__init__", - "returnType": "wpilib.PWMSparkMax", - "tooltip": "Constructor for a SPARK MAX connected via PWM.\n\n:param channel: The PWM channel that the SPARK MAX is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" + "name": "kDenim", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "name": "kDimGray", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" + "name": "kDodgerBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." + "name": "kFirebrick", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "name": "kFirstBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "name": "kFirstRed", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "name": "kFloralWhite", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + "name": "kForestGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "name": "kFuchsia", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" + "name": "kGainsboro", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "name": "kGhostWhite", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + "name": "kGold", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ + "name": "kGoldenrod", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [], - "declaringClassName": "wpilib.PWMSparkMax", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.PWMTalonFX", - "classVariables": [], - "constructors": [ + "name": "kGray", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.PWMTalonFX", - "functionName": "__init__", - "returnType": "wpilib.PWMTalonFX", - "tooltip": "Constructor for a Talon FX connected via PWM.\n\n:param channel: The PWM channel that the Talon FX is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ + "name": "kGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." + "name": "kGreenYellow", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + "name": "kHoneydew", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" + "name": "kHotPink", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." + "name": "kIndianRed", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." + "name": "kIndigo", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." + "name": "kIvory", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" + "name": "kKhaki", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" + "name": "kLavender", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "name": "kLavenderBlush", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" + "name": "kLawnGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." + "name": "kLemonChiffon", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "name": "kLightBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "name": "kLightCoral", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "name": "kLightCyan", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + "name": "kLightGoldenrodYellow", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "name": "kLightGray", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" + "name": "kLightGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "name": "kLightPink", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + "name": "kLightSalmon", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ + "name": "kLightSeaGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [], - "declaringClassName": "wpilib.PWMTalonFX", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.PWMTalonSRX", - "classVariables": [], - "constructors": [ + "name": "kLightSkyBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, + { + "name": "kLightSlateGray", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, + { + "name": "kLightSteelBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.PWMTalonSRX", - "functionName": "__init__", - "returnType": "wpilib.PWMTalonSRX", - "tooltip": "Constructor for a Talon SRX connected via PWM.\n\n:param channel: The PWM channel that the Talon SRX is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ + "name": "kLightYellow", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." + "name": "kLime", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + "name": "kLimeGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" + "name": "kLinen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." + "name": "kMagenta", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." + "name": "kMaroon", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." + "name": "kMediumAquamarine", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" + "name": "kMediumBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" + "name": "kMediumOrchid", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "name": "kMediumPurple", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" + "name": "kMediumSeaGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." + "name": "kMediumSlateBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "name": "kMediumSpringGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "name": "kMediumTurquoise", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "name": "kMediumVioletRed", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + "name": "kMidnightBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "name": "kMintcream", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" + "name": "kMistyRose", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "name": "kMoccasin", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + "name": "kNavajoWhite", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ + "name": "kNavy", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [], - "declaringClassName": "wpilib.PWMTalonSRX", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.PWMVenom", - "classVariables": [], - "constructors": [ + "name": "kOldLace", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.PWMVenom", - "functionName": "__init__", - "returnType": "wpilib.PWMVenom", - "tooltip": "Constructor for a Venom connected via PWM.\n\n:param channel: The PWM channel that the Venom is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ + "name": "kOlive", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." + "name": "kOliveDrab", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + "name": "kOrange", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" + "name": "kOrangeRed", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." + "name": "kOrchid", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." + "name": "kPaleGoldenrod", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." + "name": "kPaleGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" + "name": "kPaleTurquoise", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" + "name": "kPaleVioletRed", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "name": "kPapayaWhip", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" + "name": "kPeachPuff", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." + "name": "kPeru", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "name": "kPink", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "name": "kPlum", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "name": "kPowderBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + "name": "kPurple", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "name": "kRed", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" + "name": "kRosyBrown", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "name": "kRoyalBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + "name": "kSaddleBrown", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ + "name": "kSalmon", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [], - "declaringClassName": "wpilib.PWMVenom", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.PWMVictorSPX", - "classVariables": [], - "constructors": [ + "name": "kSandyBrown", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.PWMVictorSPX", - "functionName": "__init__", - "returnType": "wpilib.PWMVictorSPX", - "tooltip": "Constructor for a Victor SPX connected via PWM.\n\n:param channel: The PWM channel that the Victor SPX is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ + "name": "kSeaGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false + }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." + "name": "kSeashell", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + "name": "kSienna", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" + "name": "kSilver", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." + "name": "kSkyBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." + "name": "kSlateBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." + "name": "kSlateGray", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" + "name": "kSnow", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" + "name": "kSpringGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "name": "kSteelBlue", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" + "name": "kTan", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." + "name": "kTeal", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "name": "kThistle", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "name": "kTomato", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "name": "kTurquoise", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + "name": "kViolet", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "name": "kWheat", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" + "name": "kWhite", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "name": "kWhiteSmoke", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + "name": "kYellow", + "tooltip": "", + "type": "wpilib.Color", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" + "name": "kYellowGreen", + "tooltip": "", + "type": "wpilib.Color", + "writable": false } ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.PWMVictorSPX", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.PneumaticHub", - "classVariables": [], "constructors": [ { "args": [], - "declaringClassName": "wpilib.PneumaticHub", + "declaringClassName": "wpilib.Color", "functionName": "__init__", - "returnType": "wpilib.PneumaticHub", - "tooltip": "Constructs a PneumaticHub with the default ID (1)." + "returnType": "wpilib.Color", + "tooltip": "Constructs a default color (black)." }, { "args": [ { "defaultValue": "", - "name": "module", - "type": "int" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "__init__", - "returnType": "wpilib.PneumaticHub", - "tooltip": "Constructs a PneumaticHub.\n\n:param module: module number to construct" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "red", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "mask", - "type": "int" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "checkAndReserveSolenoids", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "green", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "checkSolenoidChannel", - "returnType": "bool", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "clearStickyFaults", - "returnType": "None", - "tooltip": "Clears the sticky faults." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "blue", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "disableCompressor", - "returnType": "None", - "tooltip": "Disables the compressor. The compressor will not turn on until\nEnableCompressorDigital(), EnableCompressorAnalog(), or\nEnableCompressorHybrid() are called." + "declaringClassName": "wpilib.Color", + "functionName": "__init__", + "returnType": "wpilib.Color", + "tooltip": "Constructs a Color from doubles (0-1).\n\n:param red: Red value (0-1)\n:param green: Green value (0-1)\n:param blue: Blue value (0-1)" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "r", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "minPressure", - "type": "wpimath.units.pounds_per_square_inch" + "name": "g", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "maxPressure", - "type": "wpimath.units.pounds_per_square_inch" + "name": "b", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "enableCompressorAnalog", - "returnType": "None", - "tooltip": "Enables the compressor in analog mode. This mode uses an analog pressure\nsensor connected to analog channel 0 to cycle the compressor. The\ncompressor will turn on when the pressure drops below ``minPressure``\nand will turn off when the pressure reaches ``maxPressure``.\n\n:param minPressure: The minimum pressure. The compressor will turn on when\n the pressure drops below this value. Range 0 - 120 PSI.\n:param maxPressure: The maximum pressure. The compressor will turn off when\n the pressure reaches this value. Range 0 - 120 PSI. Must be larger then\n minPressure." + "declaringClassName": "wpilib.Color", + "functionName": "__init__", + "returnType": "wpilib.Color", + "tooltip": "Constructs a Color from ints (0-255).\n\n:param r: Red value (0-255)\n:param g: Green value (0-255)\n:param b: Blue value (0-255)" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "hexString", + "type": "str" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "enableCompressorDigital", - "returnType": "None", - "tooltip": "" - }, + "declaringClassName": "wpilib.Color", + "functionName": "__init__", + "returnType": "wpilib.Color", + "tooltip": "Constructs a Color from a hex string.\n\n:param hexString: a string of the format \\#RRGGBB\n @throws std::invalid_argument if the hex string is invalid." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticHub" - }, - { - "defaultValue": "", - "name": "minPressure", - "type": "wpimath.units.pounds_per_square_inch" - }, - { - "defaultValue": "", - "name": "maxPressure", - "type": "wpimath.units.pounds_per_square_inch" + "type": "wpilib.Color" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "enableCompressorHybrid", - "returnType": "None", - "tooltip": "Enables the compressor in hybrid mode. This mode uses both a digital\npressure switch and an analog pressure sensor connected to analog channel 0\nto cycle the compressor.\n\nThe compressor will turn on when \\a both:\n\n- The digital pressure switch indicates the system is not full AND\n- The analog pressure sensor indicates that the pressure in the system is\nbelow the specified minimum pressure.\n\nThe compressor will turn off when \\a either:\n\n- The digital pressure switch is disconnected or indicates that the system\nis full OR\n- The pressure detected by the analog sensor is greater than the specified\nmaximum pressure.\n\n:param minPressure: The minimum pressure. The compressor will turn on when\n the pressure drops below this value and the pressure switch indicates that\n the system is not full. Range 0 - 120 PSI.\n:param maxPressure: The maximum pressure. The compressor will turn off when\n the pressure reaches this value or the pressure switch is disconnected or\n indicates that the system is full. Range 0 - 120 PSI. Must be larger then\n minPressure." - }, + "declaringClassName": "wpilib.Color", + "functionName": "hexString", + "returnType": "str", + "tooltip": "Return this color represented as a hex string.\n\n:returns: a string of the format \\#RRGGBB" + } + ], + "instanceVariables": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - }, - { - "defaultValue": "", - "name": "index", - "type": "int" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "fireOneShot", - "returnType": "None", - "tooltip": "" + "name": "blue", + "tooltip": "Blue component (0-1).", + "type": "float", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "get5VRegulatedVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Returns the current voltage of the regulated 5v supply.\n\n:returns: The current voltage of the 5v supply." + "name": "green", + "tooltip": "Green component (0-1).", + "type": "float", + "writable": false }, + { + "name": "red", + "tooltip": "Red component (0-1).", + "type": "float", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "h", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getAnalogVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Returns the raw voltage of the specified analog input channel.\n\n:param channel: The analog input channel to read voltage from.\n\n:returns: The voltage of the specified analog input channel." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getCompressor", - "returnType": "bool", - "tooltip": "" - }, - { - "args": [ + "name": "s", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "v", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getCompressorConfigType", - "returnType": "wpilib.CompressorConfigType", - "tooltip": "" - }, + "declaringClassName": "wpilib.Color", + "functionName": "fromHSV", + "returnType": "wpilib.Color", + "tooltip": "Creates a Color from HSV values.\n\n:param h: The h value [0-180)\n:param s: The s value [0-255]\n:param v: The v value [0-255]\n\n:returns: The color" + } + ] + }, + { + "className": "wpilib.Color8Bit", + "classVariables": [], + "constructors": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getCompressorCurrent", - "returnType": "wpimath.units.amperes", - "tooltip": "" + "args": [], + "declaringClassName": "wpilib.Color8Bit", + "functionName": "__init__", + "returnType": "wpilib.Color8Bit", + "tooltip": "Constructs a default color (black)." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getFaults", - "returnType": "wpilib.PneumaticHub.Faults", - "tooltip": "Returns the faults currently active on this device.\n\n:returns: The faults." - }, - { - "args": [ + "name": "red", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getInputVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Returns the current input voltage for this device.\n\n:returns: The input voltage." - }, - { - "args": [ + "name": "green", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "blue", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getModuleNumber", - "returnType": "int", - "tooltip": "" + "declaringClassName": "wpilib.Color8Bit", + "functionName": "__init__", + "returnType": "wpilib.Color8Bit", + "tooltip": "Constructs a Color8Bit.\n\n:param red: Red value (0-255)\n:param green: Green value (0-255)\n:param blue: Blue value (0-255)" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" + "name": "color", + "type": "wpilib.Color" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getPressure", - "returnType": "wpimath.units.pounds_per_square_inch", - "tooltip": "Returns the pressure read by an analog pressure sensor on the specified\nanalog input channel.\n\n:param channel: The analog input channel to read pressure from.\n\n:returns: The pressure read by an analog pressure sensor on the specified\n analog input channel." + "declaringClassName": "wpilib.Color8Bit", + "functionName": "__init__", + "returnType": "wpilib.Color8Bit", + "tooltip": "Constructs a Color8Bit from a Color.\n\n:param color: The color" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "hexString", + "type": "str" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getPressureSwitch", - "returnType": "bool", - "tooltip": "" - }, + "declaringClassName": "wpilib.Color8Bit", + "functionName": "__init__", + "returnType": "wpilib.Color8Bit", + "tooltip": "Constructs a Color8Bit from a hex string.\n\n:param hexString: a string of the format \\#RRGGBB\n @throws std::invalid_argument if the hex string is invalid." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticHub" + "type": "wpilib.Color8Bit" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getSolenoidDisabledList", - "returnType": "int", - "tooltip": "" + "declaringClassName": "wpilib.Color8Bit", + "functionName": "hexString", + "returnType": "str", + "tooltip": "Return this color represented as a hex string.\n\n:returns: a string of the format \\#RRGGBB" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticHub" + "type": "wpilib.Color8Bit" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getSolenoids", - "returnType": "int", + "declaringClassName": "wpilib.Color8Bit", + "functionName": "toColor", + "returnType": "wpilib.Color", "tooltip": "" - }, + } + ], + "instanceVariables": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getSolenoidsTotalCurrent", - "returnType": "wpimath.units.amperes", - "tooltip": "Returns the total current drawn by all solenoids.\n\n:returns: Total current drawn by all solenoids." + "name": "blue", + "tooltip": "Blue component (0-255).", + "type": "int", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getSolenoidsVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Returns the current voltage of the solenoid power supply.\n\n:returns: The current voltage of the solenoid power supply." + "name": "green", + "tooltip": "Green component (0-255).", + "type": "int", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" - } - ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getStickyFaults", - "returnType": "wpilib.PneumaticHub.StickyFaults", - "tooltip": "Returns the sticky faults currently active on this device.\n\n:returns: The sticky faults." - }, + "name": "red", + "tooltip": "Red component (0-255).", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "hexString", + "type": "str" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getVersion", - "returnType": "wpilib.PneumaticHub.Version", - "tooltip": "Returns the hardware and firmware versions of this device.\n\n:returns: The hardware and firmware versions." - }, + "declaringClassName": "wpilib.Color8Bit", + "functionName": "fromHexString", + "returnType": "wpilib.Color8Bit", + "tooltip": "Create a Color8Bit from a hex string.\n\n:param hexString: a string of the format \\#RRGGBB\n\n:returns: Color8Bit object from hex string.\n @throws std::invalid_argument if the hex string is invalid." + } + ] + }, + { + "className": "wpilib.Compressor", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "busId", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "module", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "moduleType", + "type": "wpilib.PneumaticsModuleType" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "makeCompressor", + "declaringClassName": "wpilib.Compressor", + "functionName": "__init__", "returnType": "wpilib.Compressor", - "tooltip": "" + "tooltip": "Constructs a compressor for a specified module and type.\n\n:param busId: The bus ID.\n:param module: The module ID to use.\n:param moduleType: The module type to use." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticHub" + "name": "busId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "forwardChannel", - "type": "int" - }, + "name": "moduleType", + "type": "wpilib.PneumaticsModuleType" + } + ], + "declaringClassName": "wpilib.Compressor", + "functionName": "__init__", + "returnType": "wpilib.Compressor", + "tooltip": "Constructs a compressor for a default module and specified type.\n\n:param busId: The bus ID.\n:param moduleType: The module type to use." + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ { "defaultValue": "", - "name": "reverseChannel", - "type": "int" + "name": "self", + "type": "wpilib.Compressor" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "makeDoubleSolenoid", - "returnType": "wpilib.DoubleSolenoid", - "tooltip": "" + "declaringClassName": "wpilib.Compressor", + "functionName": "disable", + "returnType": "None", + "tooltip": "Disable the compressor." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticHub" + "type": "wpilib.Compressor" }, { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "minPressure", + "type": "wpimath.units.pounds_per_square_inch" + }, + { + "defaultValue": "", + "name": "maxPressure", + "type": "wpimath.units.pounds_per_square_inch" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "makeSolenoid", - "returnType": "wpilib.Solenoid", - "tooltip": "" + "declaringClassName": "wpilib.Compressor", + "functionName": "enableAnalog", + "returnType": "None", + "tooltip": "If supported by the device, enables the compressor in analog mode. This\nmode uses an analog pressure sensor connected to analog channel 0 to cycle\nthe compressor. The compressor will turn on when the pressure drops below\n``minPressure`` and will turn off when the pressure reaches {@code\nmaxPressure}. This mode is only supported by the REV PH with the REV Analog\nPressure Sensor connected to analog channel 0.\n\nOn CTRE PCM, this will enable digital control.\n\n:param minPressure: The minimum pressure. The compressor will turn on when\n the pressure drops below this value.\n:param maxPressure: The maximum pressure. The compressor will turn off when\n the pressure reaches this value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticHub" + "type": "wpilib.Compressor" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "reserveCompressor", - "returnType": "bool", - "tooltip": "" + "declaringClassName": "wpilib.Compressor", + "functionName": "enableDigital", + "returnType": "None", + "tooltip": "Enables the compressor in digital mode using the digital pressure switch.\nThe compressor will turn on when the pressure switch indicates that the\nsystem is not full, and will turn off when the pressure switch indicates\nthat the system is full." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticHub" + "type": "wpilib.Compressor" }, { "defaultValue": "", - "name": "index", - "type": "int" + "name": "minPressure", + "type": "wpimath.units.pounds_per_square_inch" }, { "defaultValue": "", - "name": "duration", - "type": "wpimath.units.seconds" + "name": "maxPressure", + "type": "wpimath.units.pounds_per_square_inch" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "setOneShotDuration", + "declaringClassName": "wpilib.Compressor", + "functionName": "enableHybrid", "returnType": "None", - "tooltip": "" + "tooltip": "If supported by the device, enables the compressor in hybrid mode. This\nmode uses both a digital pressure switch and an analog pressure sensor\nconnected to analog channel 0 to cycle the compressor. This mode is only\nsupported by the REV PH with the REV Analog Pressure Sensor connected to\nanalog channel 0.\n\nThe compressor will turn on when \\a both:\n\n- The digital pressure switch indicates the system is not full AND\n- The analog pressure sensor indicates that the pressure in the system\nis below the specified minimum pressure.\n\nThe compressor will turn off when \\a either:\n\n- The digital pressure switch is disconnected or indicates that the system\nis full OR\n- The pressure detected by the analog sensor is greater than the specified\nmaximum pressure.\n\nOn CTRE PCM, this will enable digital control.\n\n:param minPressure: The minimum pressure. The compressor will turn on\n when the pressure drops below this value and the pressure switch indicates\n that the system is not full.\n:param maxPressure: The maximum pressure. The compressor will turn\n off when the pressure reaches this value or the pressure switch is\n disconnected or indicates that the system is full." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticHub" - }, - { - "defaultValue": "", - "name": "mask", - "type": "int" - }, - { - "defaultValue": "", - "name": "values", - "type": "int" + "type": "wpilib.Compressor" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "setSolenoids", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Compressor", + "functionName": "getAnalogVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "If supported by the device, returns the analog input voltage (on channel\n0).\n\nThis function is only supported by the REV PH. On CTRE PCM, this will\nreturn 0.\n\n:returns: The analog input voltage, in volts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticHub" + "type": "wpilib.Compressor" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "unreserveCompressor", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Compressor", + "functionName": "getConfigType", + "returnType": "wpilib.CompressorConfigType", + "tooltip": "Returns the active compressor configuration.\n\n:returns: The active compressor configuration." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticHub" - }, + "type": "wpilib.Compressor" + } + ], + "declaringClassName": "wpilib.Compressor", + "functionName": "getCurrent", + "returnType": "wpimath.units.amperes", + "tooltip": "Get the current drawn by the compressor.\n\n:returns: Current drawn by the compressor." + }, + { + "args": [ { "defaultValue": "", - "name": "mask", - "type": "int" + "name": "self", + "type": "wpilib.Compressor" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "unreserveSolenoids", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ + "declaringClassName": "wpilib.Compressor", + "functionName": "getPressure", + "returnType": "wpimath.units.pounds_per_square_inch", + "tooltip": "If supported by the device, returns the pressure read by the analog\npressure sensor (on channel 0).\n\nThis function is only supported by the REV PH with the REV Analog Pressure\nSensor. On CTRE PCM, this will return 0.\n\n:returns: The pressure read by the analog pressure sensor." + }, { "args": [ { "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" + "name": "self", + "type": "wpilib.Compressor" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getDefaultForType", - "returnType": "int", - "tooltip": "For internal use to get the default for a specific type.\n\n:param moduleType: module type\n\n:returns: module default" + "declaringClassName": "wpilib.Compressor", + "functionName": "getPressureSwitchValue", + "returnType": "bool", + "tooltip": "Returns the state of the pressure switch.\n\n:returns: True if pressure switch indicates that the system is not full,\n otherwise false." }, { "args": [ { "defaultValue": "", - "name": "module", - "type": "int" + "name": "self", + "type": "wpilib.Compressor" }, { "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.PneumaticHub", - "functionName": "getForType", - "returnType": "wpilib.PneumaticsBase", - "tooltip": "For internal use to get a module for a specific type.\n\n:param module: module number\n:param moduleType: module type\n\n:returns: module" - } - ] - }, - { - "className": "wpilib.PneumaticHub.Faults", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.PneumaticHub.Faults", - "functionName": "__init__", - "returnType": "wpilib.PneumaticHub.Faults", + "declaringClassName": "wpilib.Compressor", + "functionName": "initSendable", + "returnType": "None", "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticHub.Faults" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" + "type": "wpilib.Compressor" } ], - "declaringClassName": "wpilib.PneumaticHub.Faults", - "functionName": "getChannelFault", + "declaringClassName": "wpilib.Compressor", + "functionName": "isEnabled", "returnType": "bool", - "tooltip": "Gets whether there is a fault at the specified channel.\n\n:param channel: Channel to check for faults.\n\n:returns: True if a a fault exists at the channel, otherwise false.\n @throws A ChannelIndexOutOfRange error if the provided channel is outside\n of the range supported by the hardware." - } - ], - "instanceVariables": [ - { - "name": "Brownout", - "tooltip": "The input voltage is below the minimum voltage.", - "type": "int", - "writable": true - }, - { - "name": "CanWarning", - "tooltip": "A warning was raised by the device's CAN controller.", - "type": "int", - "writable": true - }, - { - "name": "Channel0Fault", - "tooltip": "Fault on channel 0.", - "type": "int", - "writable": true - }, - { - "name": "Channel10Fault", - "tooltip": "Fault on channel 10.", - "type": "int", - "writable": true - }, - { - "name": "Channel11Fault", - "tooltip": "Fault on channel 11.", - "type": "int", - "writable": true - }, - { - "name": "Channel12Fault", - "tooltip": "Fault on channel 12.", - "type": "int", - "writable": true - }, - { - "name": "Channel13Fault", - "tooltip": "Fault on channel 13.", - "type": "int", - "writable": true - }, - { - "name": "Channel14Fault", - "tooltip": "Fault on channel 14.", - "type": "int", - "writable": true - }, - { - "name": "Channel15Fault", - "tooltip": "Fault on channel 15.", - "type": "int", - "writable": true - }, - { - "name": "Channel1Fault", - "tooltip": "Fault on channel 1.", - "type": "int", - "writable": true - }, - { - "name": "Channel2Fault", - "tooltip": "Fault on channel 2.", - "type": "int", - "writable": true - }, - { - "name": "Channel3Fault", - "tooltip": "Fault on channel 3.", - "type": "int", - "writable": true - }, - { - "name": "Channel4Fault", - "tooltip": "Fault on channel 4.", - "type": "int", - "writable": true - }, - { - "name": "Channel5Fault", - "tooltip": "Fault on channel 5.", - "type": "int", - "writable": true - }, - { - "name": "Channel6Fault", - "tooltip": "Fault on channel 6.", - "type": "int", - "writable": true - }, - { - "name": "Channel7Fault", - "tooltip": "Fault on channel 7.", - "type": "int", - "writable": true - }, - { - "name": "Channel8Fault", - "tooltip": "Fault on channel 8.", - "type": "int", - "writable": true - }, - { - "name": "Channel9Fault", - "tooltip": "Fault on channel 9.", - "type": "int", - "writable": true - }, - { - "name": "CompressorOpen", - "tooltip": "The compressor output has an open circuit.", - "type": "int", - "writable": true - }, - { - "name": "CompressorOverCurrent", - "tooltip": "An overcurrent event occurred on the compressor output.", - "type": "int", - "writable": true - }, - { - "name": "HardwareFault", - "tooltip": "The hardware on the device has malfunctioned.", - "type": "int", - "writable": true - }, - { - "name": "SolenoidOverCurrent", - "tooltip": "An overcurrent event occurred on a solenoid output.", - "type": "int", - "writable": true + "tooltip": "Returns whether the compressor is active or not.\n\n:returns: true if the compressor is on - otherwise false." } ], + "instanceVariables": [], "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.PneumaticHub.StickyFaults", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.PneumaticHub.StickyFaults", - "functionName": "__init__", - "returnType": "wpilib.PneumaticHub.StickyFaults", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [ - { - "name": "Brownout", - "tooltip": "The input voltage is below the minimum voltage.", - "type": "int", - "writable": true - }, - { - "name": "CanBusOff", - "tooltip": "The device's CAN controller experienced a \"Bus Off\" event.", - "type": "int", - "writable": true - }, - { - "name": "CanWarning", - "tooltip": "A warning was raised by the device's CAN controller.", - "type": "int", - "writable": true - }, - { - "name": "CompressorOpen", - "tooltip": "The compressor output has an open circuit.", - "type": "int", - "writable": true - }, - { - "name": "CompressorOverCurrent", - "tooltip": "An overcurrent event occurred on the compressor output.", - "type": "int", - "writable": true - }, + "className": "wpilib.CompressorConfigType", + "classVariables": [ { - "name": "FirmwareFault", - "tooltip": "The firmware on the device has malfunctioned.", - "type": "int", + "name": "Analog", + "tooltip": "", + "type": "wpilib.CompressorConfigType", "writable": true }, { - "name": "HardwareFault", - "tooltip": "The hardware on the device has malfunctioned.", - "type": "int", + "name": "Digital", + "tooltip": "", + "type": "wpilib.CompressorConfigType", "writable": true }, { - "name": "HasReset", - "tooltip": "The device has rebooted.", - "type": "int", + "name": "Disabled", + "tooltip": "", + "type": "wpilib.CompressorConfigType", "writable": true }, { - "name": "SolenoidOverCurrent", - "tooltip": "An overcurrent event occurred on a solenoid output.", - "type": "int", + "name": "Hybrid", + "tooltip": "", + "type": "wpilib.CompressorConfigType", "writable": true } ], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.PneumaticHub.Version", - "classVariables": [], "constructors": [ { - "args": [], - "declaringClassName": "wpilib.PneumaticHub.Version", + "args": [ + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.CompressorConfigType", "functionName": "__init__", - "returnType": "wpilib.PneumaticHub.Version", + "returnType": "wpilib.CompressorConfigType", "tooltip": "" } ], @@ -20002,516 +3804,364 @@ "instanceMethods": [], "instanceVariables": [ { - "name": "FirmwareFix", - "tooltip": "The firmware fix version.", - "type": "int", - "writable": true - }, - { - "name": "FirmwareMajor", - "tooltip": "The firmware major version.", - "type": "int", - "writable": true - }, - { - "name": "FirmwareMinor", - "tooltip": "The firmware minor version.", - "type": "int", - "writable": true - }, - { - "name": "HardwareMajor", - "tooltip": "The hardware major version.", - "type": "int", - "writable": true - }, - { - "name": "HardwareMinor", - "tooltip": "The hardware minor version.", - "type": "int", - "writable": true + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, { - "name": "UniqueId", - "tooltip": "The device's unique ID.", + "name": "value", + "tooltip": "", "type": "int", - "writable": true + "writable": false } ], "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.PneumaticsBase", + "className": "wpilib.DMC60", "classVariables": [], "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "__init__", - "returnType": "wpilib.PneumaticsBase", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsBase" - }, - { - "defaultValue": "", - "name": "mask", - "type": "int" - } - ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "checkAndReserveSolenoids", - "returnType": "int", - "tooltip": "Check to see if the solenoids marked in the bitmask can be reserved, and if\nso, reserve them.\n\n:param mask: The bitmask of solenoids to reserve. The LSB represents\n solenoid 0.\n\n:returns: 0 if successful; mask of solenoids that couldn't be allocated\n otherwise" - }, { "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsBase" - }, { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "checkSolenoidChannel", - "returnType": "bool", - "tooltip": "Check if a solenoid channel is valid.\n\n:param channel: Channel to check\n\n:returns: True if channel exists" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsBase" - } - ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "disableCompressor", - "returnType": "None", - "tooltip": "Disables the compressor." - }, + "declaringClassName": "wpilib.DMC60", + "functionName": "__init__", + "returnType": "wpilib.DMC60", + "tooltip": "Constructor for a DMC 60 connected via PWM.\n\n:param channel: The PWM channel that the DMC 60 is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" - }, - { - "defaultValue": "", - "name": "minPressure", - "type": "wpimath.units.pounds_per_square_inch" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "maxPressure", - "type": "wpimath.units.pounds_per_square_inch" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "enableCompressorAnalog", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", "returnType": "None", - "tooltip": "If supported by the device, enables the compressor in analog mode. This\nmode uses an analog pressure sensor connected to analog channel 0 to cycle\nthe compressor. The compressor will turn on when the pressure drops below\n``minPressure`` and will turn off when the pressure reaches {@code\nmaxPressure}. This mode is only supported by the REV PH with the REV Analog\nPressure Sensor connected to analog channel 0.\n\nOn CTRE PCM, this will enable digital control.\n\n:param minPressure: The minimum pressure. The compressor will turn on\n when the pressure drops below this value.\n:param maxPressure: The maximum pressure. The compressor will turn\n off when the pressure reaches this value." + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "enableCompressorDigital", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", "returnType": "None", - "tooltip": "Enables the compressor in digital mode using the digital pressure switch.\nThe compressor will turn on when the pressure switch indicates that the\nsystem is not full, and will turn off when the pressure switch indicates\nthat the system is full." + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" - }, - { - "defaultValue": "", - "name": "minPressure", - "type": "wpimath.units.pounds_per_square_inch" - }, - { - "defaultValue": "", - "name": "maxPressure", - "type": "wpimath.units.pounds_per_square_inch" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "enableCompressorHybrid", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", "returnType": "None", - "tooltip": "If supported by the device, enables the compressor in hybrid mode. This\nmode uses both a digital pressure switch and an analog pressure sensor\nconnected to analog channel 0 to cycle the compressor. This mode is only\nsupported by the REV PH with the REV Analog Pressure Sensor connected to\nanalog channel 0.\n\nThe compressor will turn on when \\a both:\n\n- The digital pressure switch indicates the system is not full AND\n- The analog pressure sensor indicates that the pressure in the system\nis below the specified minimum pressure.\n\nThe compressor will turn off when \\a either:\n\n- The digital pressure switch is disconnected or indicates that the system\nis full OR\n- The pressure detected by the analog sensor is greater than the specified\nmaximum pressure.\n\nOn CTRE PCM, this will enable digital control.\n\n:param minPressure: The minimum pressure. The compressor will turn on\n when the pressure drops below this value and the pressure switch indicates\n that the system is not full.\n:param maxPressure: The maximum pressure. The compressor will turn\n off when the pressure reaches this value or the pressure switch is\n disconnected or indicates that the system is full." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "index", - "type": "int" + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "fireOneShot", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", "returnType": "None", - "tooltip": "Fire a single solenoid shot.\n\n:param index: solenoid index" + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getAnalogVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "If supported by the device, returns the raw voltage of the specified analog\ninput channel.\n\nThis function is only supported by the REV PH. On CTRE PCM, this will\nreturn 0.\n\n:param channel: The analog input channel to read voltage from.\n\n:returns: The voltage of the specified analog input channel." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getCompressor", - "returnType": "bool", - "tooltip": "Returns whether the compressor is active or not.\n\n:returns: True if the compressor is on - otherwise false." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getCompressorConfigType", - "returnType": "wpilib.CompressorConfigType", - "tooltip": "Returns the active compressor configuration.\n\n:returns: The active compressor configuration." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getCompressorCurrent", - "returnType": "wpimath.units.amperes", - "tooltip": "Returns the current drawn by the compressor.\n\n:returns: The current drawn by the compressor." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getModuleNumber", - "returnType": "int", - "tooltip": "Get module number for this module.\n\n:returns: module number" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getPressure", - "returnType": "wpimath.units.pounds_per_square_inch", - "tooltip": "If supported by the device, returns the pressure read by an analog\npressure sensor on the specified analog input channel.\n\nThis function is only supported by the REV PH. On CTRE PCM, this will\nreturn 0.\n\n:param channel: The analog input channel to read pressure from.\n\n:returns: The pressure read by an analog pressure sensor on the\n specified analog input channel." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getPressureSwitch", - "returnType": "bool", - "tooltip": "Returns the state of the pressure switch.\n\n:returns: True if pressure switch indicates that the system is full,\n otherwise false." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpiutil.Sendable" + }, + { + "defaultValue": "", + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getSolenoidDisabledList", - "returnType": "int", - "tooltip": "Get a bitmask of disabled solenoids.\n\n:returns: Bitmask indicating disabled solenoids. The LSB represents solenoid\n 0." + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getSolenoids", - "returnType": "int", - "tooltip": "Gets a bitmask of solenoid values.\n\n:returns: Bitmask containing the state of the solenoids. The LSB represents\n solenoid 0." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "makeCompressor", - "returnType": "wpilib.Compressor", - "tooltip": "Create a compressor object.\n\n:returns: Compressor object" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" - }, - { - "defaultValue": "", - "name": "forwardChannel", - "type": "int" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "reverseChannel", - "type": "int" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "makeDoubleSolenoid", - "returnType": "wpilib.DoubleSolenoid", - "tooltip": "Create a double solenoid object for the specified channels.\n\n:param forwardChannel: solenoid channel for forward\n:param reverseChannel: solenoid channel for reverse\n\n:returns: DoubleSolenoid object" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "makeSolenoid", - "returnType": "wpilib.Solenoid", - "tooltip": "Create a solenoid object for the specified channel.\n\n:param channel: solenoid channel\n\n:returns: Solenoid object" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsBase" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "reserveCompressor", - "returnType": "bool", - "tooltip": "Reserve the compressor.\n\n:returns: true if successful; false if compressor already reserved" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" - }, - { - "defaultValue": "", - "name": "index", - "type": "int" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "duration", - "type": "wpimath.units.seconds" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "setOneShotDuration", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", "returnType": "None", - "tooltip": "Set the duration for a single solenoid shot.\n\n:param index: solenoid index\n:param duration: shot duration" + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" - }, - { - "defaultValue": "", - "name": "mask", - "type": "int" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "values", - "type": "int" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "setSolenoids", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", "returnType": "None", - "tooltip": "Sets solenoids on a pneumatics module.\n\n:param mask: Bitmask indicating which solenoids to set. The LSB represents\n solenoid 0.\n:param values: Bitmask indicating the desired states of the solenoids. The\n LSB represents solenoid 0." + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "unreserveCompressor", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", "returnType": "None", - "tooltip": "Unreserve the compressor." + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsBase" - }, - { - "defaultValue": "", - "name": "mask", - "type": "int" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "unreserveSolenoids", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", "returnType": "None", - "tooltip": "Unreserve the solenoids marked in the bitmask.\n\n:param mask: The bitmask of solenoids to unreserve. The LSB represents\n solenoid 0." + "tooltip": "" } ], "instanceVariables": [], "moduleName": "wpilib", "staticMethods": [ { - "args": [ - { - "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" - } - ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getDefaultForType", - "returnType": "int", - "tooltip": "For internal use to get the default for a specific type.\n\n:param moduleType: module type\n\n:returns: module default" - }, - { - "args": [ - { - "defaultValue": "", - "name": "module", - "type": "int" - }, - { - "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" - } - ], - "declaringClassName": "wpilib.PneumaticsBase", - "functionName": "getForType", - "returnType": "wpilib.PneumaticsBase", - "tooltip": "For internal use to get a module for a specific type.\n\n:param module: module number\n:param moduleType: module type\n\n:returns: module" + "args": [], + "declaringClassName": "wpilib.DMC60", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." } ] }, { - "className": "wpilib.PneumaticsControlModule", + "className": "wpilib.DSControlWord", "classVariables": [], "constructors": [ { "args": [], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "__init__", - "returnType": "wpilib.PneumaticsControlModule", - "tooltip": "Constructs a PneumaticsControlModule with the default ID (0)." - }, - { - "args": [ - { - "defaultValue": "", - "name": "module", - "type": "int" - } - ], - "declaringClassName": "wpilib.PneumaticsControlModule", + "declaringClassName": "wpilib.DSControlWord", "functionName": "__init__", - "returnType": "wpilib.PneumaticsControlModule", - "tooltip": "Constructs a PneumaticsControlModule.\n\n:param module: module number to construct" + "returnType": "wpilib.DSControlWord", + "tooltip": "DSControlWord constructor.\n\nUpon construction, the current Driver Station control word is read and\nstored internally." } ], "enums": [], @@ -20521,286 +4171,311 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" - }, - { - "defaultValue": "", - "name": "mask", - "type": "int" + "type": "wpilib.DSControlWord" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "checkAndReserveSolenoids", - "returnType": "int", - "tooltip": "" + "declaringClassName": "wpilib.DSControlWord", + "functionName": "isAutonomous", + "returnType": "bool", + "tooltip": "Check if the DS is commanding autonomous mode.\n\n:returns: True if the robot is being commanded to be in autonomous mode" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" + "type": "wpilib.DSControlWord" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "checkSolenoidChannel", + "declaringClassName": "wpilib.DSControlWord", + "functionName": "isAutonomousEnabled", "returnType": "bool", - "tooltip": "" + "tooltip": "Check if the DS is commanding autonomous mode and if it has enabled the\nrobot.\n\n:returns: True if the robot is being commanded to be in autonomous mode and\n enabled." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DSControlWord" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "clearAllStickyFaults", - "returnType": "None", - "tooltip": "Clears all sticky faults on this device." + "declaringClassName": "wpilib.DSControlWord", + "functionName": "isDSAttached", + "returnType": "bool", + "tooltip": "Check if the DS is attached.\n\n:returns: True if the DS is connected to the robot" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DSControlWord" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "disableCompressor", - "returnType": "None", - "tooltip": "Disables the compressor. The compressor will not turn on until\nEnableCompressorDigital() is called." + "declaringClassName": "wpilib.DSControlWord", + "functionName": "isDisabled", + "returnType": "bool", + "tooltip": "Check if the robot is disabled.\n\n:returns: True if the robot is explicitly disabled or the DS is not connected" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" - }, - { - "defaultValue": "", - "name": "minPressure", - "type": "wpimath.units.pounds_per_square_inch" - }, - { - "defaultValue": "", - "name": "maxPressure", - "type": "wpimath.units.pounds_per_square_inch" + "type": "wpilib.DSControlWord" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "enableCompressorAnalog", - "returnType": "None", - "tooltip": "Enables the compressor in digital mode. Analog mode is unsupported by the\nCTRE PCM.\n\n:param minPressure: Unsupported.\n:param maxPressure: Unsupported.\n @see EnableCompressorDigital()" + "declaringClassName": "wpilib.DSControlWord", + "functionName": "isEStopped", + "returnType": "bool", + "tooltip": "Check if the robot is e-stopped.\n\n:returns: True if the robot is e-stopped" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DSControlWord" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "enableCompressorDigital", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.DSControlWord", + "functionName": "isEnabled", + "returnType": "bool", + "tooltip": "Check if the DS has enabled the robot.\n\n:returns: True if the robot is enabled and the DS is connected" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" - }, - { - "defaultValue": "", - "name": "minPressure", - "type": "wpimath.units.pounds_per_square_inch" - }, - { - "defaultValue": "", - "name": "maxPressure", - "type": "wpimath.units.pounds_per_square_inch" + "type": "wpilib.DSControlWord" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "enableCompressorHybrid", - "returnType": "None", - "tooltip": "Enables the compressor in digital mode. Hybrid mode is unsupported by the\nCTRE PCM.\n\n:param minPressure: Unsupported.\n:param maxPressure: Unsupported.\n @see EnableCompressorDigital()" + "declaringClassName": "wpilib.DSControlWord", + "functionName": "isFMSAttached", + "returnType": "bool", + "tooltip": "Is the driver station attached to a Field Management System?\n\n:returns: True if the robot is competing on a field being controlled by a\n Field Management System" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" - }, - { - "defaultValue": "", - "name": "index", - "type": "int" + "type": "wpilib.DSControlWord" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "fireOneShot", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.DSControlWord", + "functionName": "isTeleop", + "returnType": "bool", + "tooltip": "Check if the DS is commanding teleop mode.\n\n:returns: True if the robot is being commanded to be in teleop mode" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" + "type": "wpilib.DSControlWord" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getAnalogVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Unsupported by the CTRE PCM.\n\n:param channel: Unsupported.\n\n:returns: 0" + "declaringClassName": "wpilib.DSControlWord", + "functionName": "isTeleopEnabled", + "returnType": "bool", + "tooltip": "Check if the DS is commanding teleop mode and if it has enabled the robot.\n\n:returns: True if the robot is being commanded to be in teleop mode and\n enabled." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DSControlWord" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getCompressor", + "declaringClassName": "wpilib.DSControlWord", + "functionName": "isTest", "returnType": "bool", - "tooltip": "" - }, + "tooltip": "Check if the DS is commanding test mode.\n\n:returns: True if the robot is being commanded to be in test mode" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.DataLogManager", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsControlModule" + "name": "args", + "type": "tuple" + }, + { + "defaultValue": "", + "name": "kwargs", + "type": "dict" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getCompressorConfigType", - "returnType": "wpilib.CompressorConfigType", - "tooltip": "" + "declaringClassName": "wpilib.DataLogManager", + "functionName": "__init__", + "returnType": "wpilib.DataLogManager", + "tooltip": "Initialize self. See help(type(self)) for accurate signature." + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.DataLogManager", + "functionName": "getLog", + "returnType": "wpilog._wpilog.DataLog", + "tooltip": "Get the managed data log (for custom logging). Starts the data log manager\nif not already started.\n\n:returns: data log" + }, + { + "args": [], + "declaringClassName": "wpilib.DataLogManager", + "functionName": "getLogDir", + "returnType": "str", + "tooltip": "Get the log directory.\n\n:returns: log directory" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsControlModule" + "name": "message", + "type": "str" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getCompressorCurrent", - "returnType": "wpimath.units.amperes", - "tooltip": "" + "declaringClassName": "wpilib.DataLogManager", + "functionName": "log", + "returnType": "None", + "tooltip": "Log a message to the \"messages\" entry. The message is also printed to\nstandard output (followed by a newline).\n\n:param message: message" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsControlModule" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getCompressorCurrentTooHighFault", - "returnType": "bool", - "tooltip": "Return whether the compressor current is currently too high.\n\n:returns: True if the compressor current is too high, otherwise false.\n @see GetCompressorCurrentTooHighStickyFault()" + "declaringClassName": "wpilib.DataLogManager", + "functionName": "logConsoleOutput", + "returnType": "None", + "tooltip": "Enable or disable logging of the console output. Defaults to enabled.\n\n:param enabled: true to enable, false to disable" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsControlModule" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getCompressorCurrentTooHighStickyFault", - "returnType": "bool", - "tooltip": "Returns whether the compressor current has been too high since sticky\nfaults were last cleared. This fault is persistent and can be cleared by\nClearAllStickyFaults()\n\n:returns: True if the compressor current has been too high since sticky\n faults were last cleared.\n @see GetCompressorCurrentTooHighFault()" + "declaringClassName": "wpilib.DataLogManager", + "functionName": "logNetworkTables", + "returnType": "None", + "tooltip": "Enable or disable logging of NetworkTables data. Note that unlike the\nnetwork interface for NetworkTables, this will capture every value change.\nDefaults to enabled.\n\n:param enabled: true to enable, false to disable" }, { "args": [ { - "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsControlModule" + "defaultValue": "''", + "name": "dir", + "type": "str" + }, + { + "defaultValue": "''", + "name": "filename", + "type": "str" + }, + { + "defaultValue": "0.25", + "name": "period", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getCompressorNotConnectedFault", - "returnType": "bool", - "tooltip": "Returns whether the compressor is currently disconnected.\n\n:returns: True if compressor is currently disconnected, otherwise false.\n @see GetCompressorNotConnectedStickyFault()" + "declaringClassName": "wpilib.DataLogManager", + "functionName": "start", + "returnType": "None", + "tooltip": "Start data log manager. The parameters have no effect if the data log\nmanager was already started (e.g. by calling another static function).\n\n:param dir: if not empty, directory to use for data log storage\n:param filename: filename to use; if none provided, the filename is\n automatically generated\n:param period: time between automatic flushes to disk, in seconds;\n this is a time/storage tradeoff" }, + { + "args": [], + "declaringClassName": "wpilib.DataLogManager", + "functionName": "stop", + "returnType": "None", + "tooltip": "Stop data log manager." + } + ] + }, + { + "className": "wpilib.DigitalInput", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsControlModule" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getCompressorNotConnectedStickyFault", - "returnType": "bool", - "tooltip": "Returns whether the compressor has been disconnected since sticky faults\nwere last cleared. This fault is persistent and can be cleared by\nClearAllStickyFaults()\n\n:returns: True if the compressor has been disconnected since sticky faults\n were last cleared, otherwise false.\n @see GetCompressorNotConnectedFault()" - }, + "declaringClassName": "wpilib.DigitalInput", + "functionName": "__init__", + "returnType": "wpilib.DigitalInput", + "tooltip": "Create an instance of a Digital Input class.\n\nCreates a digital input given a channel.\n\n:param channel: The DIO channel 0-9 are on-board, 10-25 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalInput" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getCompressorShortedFault", + "declaringClassName": "wpilib.DigitalInput", + "functionName": "get", "returnType": "bool", - "tooltip": "Returns whether the compressor is currently shorted.\n\n:returns: True if the compressor is currently shorted, otherwise false.\n @see GetCompressorShortedStickyFault()" + "tooltip": "Get the value from a digital input channel.\n\nRetrieve the value of a single digital input channel from the FPGA." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalInput" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getCompressorShortedStickyFault", - "returnType": "bool", - "tooltip": "Returns whether the compressor has been shorted since sticky faults were\nlast cleared. This fault is persistent and can be cleared by\nClearAllStickyFaults()\n\n:returns: True if the compressor has been shorted since sticky faults were\n last cleared, otherwise false.\n @see GetCompressorShortedFault()" + "declaringClassName": "wpilib.DigitalInput", + "functionName": "getChannel", + "returnType": "int", + "tooltip": ":returns: The GPIO channel number that this object represents." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalInput" + }, + { + "defaultValue": "", + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getModuleNumber", - "returnType": "int", + "declaringClassName": "wpilib.DigitalInput", + "functionName": "initSendable", + "returnType": "None", "tooltip": "" }, { @@ -20808,118 +4483,135 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalInput" }, { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "device", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getPressure", - "returnType": "wpimath.units.pounds_per_square_inch", - "tooltip": "Unsupported by the CTRE PCM.\n\n:param channel: Unsupported.\n\n:returns: 0" - }, + "declaringClassName": "wpilib.DigitalInput", + "functionName": "setSimDevice", + "returnType": "None", + "tooltip": "Indicates this input is used by a simulated device.\n\n:param device: simulated device handle" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.DigitalOutput", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PneumaticsControlModule" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getPressureSwitch", - "returnType": "bool", - "tooltip": "" - }, + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "__init__", + "returnType": "wpilib.DigitalOutput", + "tooltip": "Create an instance of a digital output.\n\nCreate a digital output given a channel.\n\n:param channel: The digital channel 0-9 are on-board, 10-25 are on the MXP\n port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalOutput" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getSolenoidDisabledList", - "returnType": "int", - "tooltip": "" + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "disablePWM", + "returnType": "None", + "tooltip": "Change this line from a PWM output back to a static Digital Output line.\n\nFree up one of the 6 DO PWM generator resources that were in use." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalOutput" + }, + { + "defaultValue": "", + "name": "dutyCycle", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getSolenoidVoltageFault", - "returnType": "bool", - "tooltip": "Returns whether the solenoid is currently reporting a voltage fault.\n\n:returns: True if solenoid is reporting a fault, otherwise false.\n @see GetSolenoidVoltageStickyFault()" + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "enablePPS", + "returnType": "None", + "tooltip": "Enable a PWM PPS (Pulse Per Second) Output on this line.\n\nAllocate one of the 6 DO PWM generator resources from this module.\n\nSupply the duty-cycle to output.\n\nThe resolution of the duty cycle is 8-bit.\n\n:param dutyCycle: The duty-cycle to start generating. [0..1]" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalOutput" + }, + { + "defaultValue": "", + "name": "initialDutyCycle", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getSolenoidVoltageStickyFault", - "returnType": "bool", - "tooltip": "Returns whether the solenoid has reported a voltage fault since sticky\nfaults were last cleared. This fault is persistent and can be cleared by\nClearAllStickyFaults()\n\n:returns: True if solenoid is reporting a fault, otherwise false.\n @see GetSolenoidVoltageFault()" + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "enablePWM", + "returnType": "None", + "tooltip": "Enable a PWM Output on this line.\n\nAllocate one of the 6 DO PWM generator resources from this module.\n\nSupply the initial duty-cycle to output so as to avoid a glitch when first\nstarting.\n\nThe resolution of the duty cycle is 8-bit for low frequencies (1kHz or\nless) but is reduced the higher the frequency of the PWM signal is.\n\n:param initialDutyCycle: The duty-cycle to start generating. [0..1]" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalOutput" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getSolenoids", - "returnType": "int", - "tooltip": "" + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "get", + "returnType": "bool", + "tooltip": "Gets the value being output from the Digital Output.\n\n:returns: the state of the digital output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalOutput" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "makeCompressor", - "returnType": "wpilib.Compressor", - "tooltip": "" + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "getChannel", + "returnType": "int", + "tooltip": ":returns: The GPIO channel number that this object represents." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" - }, - { - "defaultValue": "", - "name": "forwardChannel", - "type": "int" + "type": "wpilib.DigitalOutput" }, { "defaultValue": "", - "name": "reverseChannel", - "type": "int" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "makeDoubleSolenoid", - "returnType": "wpilib.DoubleSolenoid", + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "initSendable", + "returnType": "None", "tooltip": "" }, { @@ -20927,876 +4619,942 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" + "type": "wpilib.DigitalOutput" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "makeSolenoid", - "returnType": "wpilib.Solenoid", - "tooltip": "" + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "isPulsing", + "returnType": "bool", + "tooltip": "Determine if the pulse is still going.\n\nDetermine if a previously started pulse is still going." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalOutput" + }, + { + "defaultValue": "", + "name": "pulseLength", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "reserveCompressor", - "returnType": "bool", - "tooltip": "" + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "pulse", + "returnType": "None", + "tooltip": "Output a single pulse on the digital output line.\n\nSend a single pulse on the digital output line where the pulse duration is\nspecified in seconds. Maximum of 65535 microseconds.\n\n:param pulseLength: The pulse length in seconds" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" - }, - { - "defaultValue": "", - "name": "index", - "type": "int" + "type": "wpilib.DigitalOutput" }, { "defaultValue": "", - "name": "duration", - "type": "wpimath.units.seconds" + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "setOneShotDuration", + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "set", "returnType": "None", - "tooltip": "" + "tooltip": "Set the value of a digital output.\n\nSet the value of a digital output to either one (true) or zero (false).\n\n:param value: 1 (true) for high, 0 (false) for disabled" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" - }, - { - "defaultValue": "", - "name": "mask", - "type": "int" + "type": "wpilib.DigitalOutput" }, { "defaultValue": "", - "name": "values", - "type": "int" + "name": "rate", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "setSolenoids", + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "setPWMRate", "returnType": "None", - "tooltip": "" + "tooltip": "Change the PWM frequency of the PWM output on a Digital Output line.\n\nThe valid range is from 0.6 Hz to 19 kHz. The frequency resolution is\nlogarithmic.\n\nThere is only one PWM frequency for all digital channels.\n\n:param rate: The frequency to output all digital output PWM signals." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalOutput" + }, + { + "defaultValue": "", + "name": "device", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "unreserveCompressor", + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "setSimDevice", "returnType": "None", - "tooltip": "" + "tooltip": "Indicates this output is used by a simulated device.\n\n:param device: simulated device handle" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PneumaticsControlModule" + "type": "wpilib.DigitalOutput" }, { "defaultValue": "", - "name": "mask", - "type": "int" + "name": "dutyCycle", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "unreserveSolenoids", + "declaringClassName": "wpilib.DigitalOutput", + "functionName": "updateDutyCycle", "returnType": "None", - "tooltip": "" + "tooltip": "Change the duty-cycle that is being generated on the line.\n\nThe resolution of the duty cycle is 8-bit for low frequencies (1kHz or\nless) but is reduced the higher the frequency of the PWM signal is.\n\n:param dutyCycle: The duty-cycle to change to. [0..1]" } ], "instanceVariables": [], "moduleName": "wpilib", - "staticMethods": [ + "staticMethods": [] + }, + { + "className": "wpilib.DoubleSolenoid", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" - } - ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getDefaultForType", - "returnType": "int", - "tooltip": "For internal use to get the default for a specific type.\n\n:param moduleType: module type\n\n:returns: module default" - }, - { - "args": [ + "name": "busId", + "type": "typing.SupportsInt" + }, { "defaultValue": "", "name": "module", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "moduleType", "type": "wpilib.PneumaticsModuleType" + }, + { + "defaultValue": "", + "name": "forwardChannel", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "reverseChannel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PneumaticsControlModule", - "functionName": "getForType", - "returnType": "wpilib.PneumaticsBase", - "tooltip": "For internal use to get a module for a specific type.\n\n:param module: module number\n:param moduleType: module type\n\n:returns: module" - } - ] - }, - { - "className": "wpilib.PowerDistribution", - "classVariables": [ - { - "name": "kDefaultModule", - "tooltip": "", - "type": "int", - "writable": false - } - ], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.PowerDistribution", + "declaringClassName": "wpilib.DoubleSolenoid", "functionName": "__init__", - "returnType": "wpilib.PowerDistribution", - "tooltip": "Constructs a PowerDistribution object.\n\nDetects the connected PDP/PDH using the default CAN ID (0 for CTRE and 1\nfor REV)." + "returnType": "wpilib.DoubleSolenoid", + "tooltip": "Constructs a double solenoid for a specified module of a specific module\ntype.\n\n:param busId: The bus ID.\n:param module: The module of the solenoid module to use.\n:param moduleType: The module type to use.\n:param forwardChannel: The forward channel on the module to control.\n:param reverseChannel: The reverse channel on the module to control." }, { "args": [ { "defaultValue": "", - "name": "module", - "type": "int" + "name": "busId", + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "moduleType", - "type": "wpilib.PowerDistribution.ModuleType" + "type": "wpilib.PneumaticsModuleType" + }, + { + "defaultValue": "", + "name": "forwardChannel", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "reverseChannel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution", + "declaringClassName": "wpilib.DoubleSolenoid", "functionName": "__init__", - "returnType": "wpilib.PowerDistribution", - "tooltip": "Constructs a PowerDistribution object.\n\n:param module: The CAN ID of the PDP/PDH\n:param moduleType: The type of module" + "returnType": "wpilib.DoubleSolenoid", + "tooltip": "Constructs a double solenoid for a default module of a specific module\ntype.\n\n:param busId: The bus ID.\n:param moduleType: The module type to use.\n:param forwardChannel: The forward channel on the module to control.\n:param reverseChannel: The reverse channel on the module to control." } ], - "enums": [ + "enums": [], + "instanceMethods": [ { - "enumClassName": "wpilib.PowerDistribution.ModuleType", - "enumValues": [ - "kCTRE", - "kRev" + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.DoubleSolenoid" + } ], - "moduleName": "wpilib", - "tooltip": "Power distribution module type.\n\nMembers:\n\n kCTRE : CTRE (Cross The Road Electronics) CTRE Power Distribution Panel (PDP).\n\n kRev : REV Power Distribution Hub (PDH)." - } - ], - "instanceMethods": [ + "declaringClassName": "wpilib.DoubleSolenoid", + "functionName": "get", + "returnType": "wpilib.DoubleSolenoid.Value", + "tooltip": "Read the current value of the solenoid.\n\n:returns: The current value of the solenoid." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PowerDistribution" + "type": "wpilib.DoubleSolenoid" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "clearStickyFaults", - "returnType": "None", - "tooltip": "Remove all of the fault flags on the PDP/PDH." + "declaringClassName": "wpilib.DoubleSolenoid", + "functionName": "getFwdChannel", + "returnType": "int", + "tooltip": "Get the forward channel.\n\n:returns: the forward channel." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PowerDistribution" + "type": "wpilib.DoubleSolenoid" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getAllCurrents", - "returnType": "list[float]", - "tooltip": "Query all currents of the PDP.\n\n:returns: The current of each channel in Amperes" + "declaringClassName": "wpilib.DoubleSolenoid", + "functionName": "getRevChannel", + "returnType": "int", + "tooltip": "Get the reverse channel.\n\n:returns: the reverse channel." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PowerDistribution" + "type": "wpilib.DoubleSolenoid" }, { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getCurrent", - "returnType": "float", - "tooltip": "Query the current of a single channel of the PDP/PDH.\n\n:param channel: the channel to query (0-15 for PDP, 0-23 for PDH)\n\n:returns: The current of the channel in Amperes" + "declaringClassName": "wpilib.DoubleSolenoid", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PowerDistribution" + "type": "wpilib.DoubleSolenoid" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getFaults", - "returnType": "wpilib.PowerDistribution.Faults", - "tooltip": "Returns the power distribution faults.\n\nOn a CTRE PDP, this will return an object with no faults active.\n\n:returns: The power distribution faults." + "declaringClassName": "wpilib.DoubleSolenoid", + "functionName": "isFwdSolenoidDisabled", + "returnType": "bool", + "tooltip": "Check if the forward solenoid is Disabled.\n\nIf a solenoid is shorted, it is added to the DisabledList and disabled\nuntil power cycle, or until faults are cleared.\n\n@see ClearAllStickyFaults()\n\n:returns: If solenoid is disabled due to short." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PowerDistribution" + "type": "wpilib.DoubleSolenoid" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getModule", - "returnType": "int", - "tooltip": "Gets module number (CAN ID)." + "declaringClassName": "wpilib.DoubleSolenoid", + "functionName": "isRevSolenoidDisabled", + "returnType": "bool", + "tooltip": "Check if the reverse solenoid is Disabled.\n\nIf a solenoid is shorted, it is added to the DisabledList and disabled\nuntil power cycle, or until faults are cleared.\n\n@see ClearAllStickyFaults()\n\n:returns: If solenoid is disabled due to short." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PowerDistribution" + "type": "wpilib.DoubleSolenoid" + }, + { + "defaultValue": "", + "name": "value", + "type": "wpilib.DoubleSolenoid.Value" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getNumChannels", - "returnType": "int", - "tooltip": "Gets the number of channels for this power distribution object.\n\n:returns: Number of output channels (16 for PDP, 24 for PDH)." + "declaringClassName": "wpilib.DoubleSolenoid", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the value of a solenoid.\n\n:param value: The value to set (Off, Forward or Reverse)" + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.DoubleSolenoid" + } + ], + "declaringClassName": "wpilib.DoubleSolenoid", + "functionName": "toggle", + "returnType": "None", + "tooltip": "Toggle the value of the solenoid.\n\nIf the solenoid is set to forward, it'll be set to reverse. If the solenoid\nis set to reverse, it'll be set to forward. If the solenoid is set to off,\nnothing happens." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.DoubleSolenoid.Value", + "classVariables": [ + { + "name": "kForward", + "tooltip": "", + "type": "wpilib.DoubleSolenoid.Value", + "writable": false + }, + { + "name": "kOff", + "tooltip": "", + "type": "wpilib.DoubleSolenoid.Value", + "writable": false + }, + { + "name": "kReverse", + "tooltip": "", + "type": "wpilib.DoubleSolenoid.Value", + "writable": false + } + ], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.DoubleSolenoid.Value", + "functionName": "__init__", + "returnType": "wpilib.DoubleSolenoid.Value", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.DriverStation", + "classVariables": [ + { + "name": "kJoystickPorts", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "args", + "type": "tuple" + }, + { + "defaultValue": "", + "name": "kwargs", + "type": "dict" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getStickyFaults", - "returnType": "wpilib.PowerDistribution.StickyFaults", - "tooltip": "Returns the power distribution sticky faults.\n\nOn a CTRE PDP, this will return an object with no faults active.\n\n:returns: The power distribution sticky faults." - }, + "declaringClassName": "wpilib.DriverStation", + "functionName": "__init__", + "returnType": "wpilib.DriverStation", + "tooltip": "Initialize self. See help(type(self)) for accurate signature." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PowerDistribution" + "type": "wpilib.DriverStation" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getSwitchableChannel", - "returnType": "bool", - "tooltip": "Gets whether the PDH switchable channel is turned on or off. Returns false\nwith the CTRE PDP.\n\n:returns: The output state of the PDH switchable channel" + "declaringClassName": "wpilib.DriverStation", + "functionName": "getControlState", + "returnType": "tuple[bool, bool, bool]", + "tooltip": "More efficient way to determine what state the robot is in.\n\n:returns: booleans representing enabled, isautonomous, istest\n\n.. versionadded:: 2019.2.1\n\n.. note:: This function only exists in RobotPy" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getAlliance", + "returnType": "Optional[wpilib.DriverStation.Alliance]", + "tooltip": "Get the current alliance from the FMS.\n\nIf the FMS is not connected, it is set from the team alliance setting on\nthe driver station.\n\n:returns: The alliance (red or blue) or an empty optional if the alliance is\n invalid" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getTemperature", + "declaringClassName": "wpilib.DriverStation", + "functionName": "getAngle", + "returnType": "Optional[wpimath.geometry.Rotation2d]", + "tooltip": "Gets the angle of a POVDirection.\n\n:param angle: The POVDirection to convert.\n\n:returns: The angle clockwise from straight up, or std::nullopt if the\n POVDirection is kCenter." + }, + { + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getBatteryVoltage", "returnType": "float", - "tooltip": "Query the temperature of the PDP.\n\nNot supported on the Rev PDH and returns 0.\n\n:returns: The temperature in degrees Celsius" + "tooltip": "Read the battery voltage.\n\n:returns: The battery voltage in Volts." + }, + { + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getEventName", + "returnType": "str", + "tooltip": "Returns the name of the competition event provided by the FMS.\n\n:returns: A string containing the event name" + }, + { + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getGameSpecificMessage", + "returnType": "str", + "tooltip": "Returns the game specific message provided by the FMS.\n\nIf the FMS is not connected, it is set from the game data setting on the\ndriver station.\n\n:returns: A string containing the game specific message." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "stick", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getTotalCurrent", - "returnType": "float", - "tooltip": "Query the total current of all monitored PDP/PDH channels.\n\n:returns: The total current drawn from all channels in Amperes" + "declaringClassName": "wpilib.DriverStation", + "functionName": "getJoystickAxisType", + "returnType": "int", + "tooltip": "Returns the types of Axes on a given joystick port.\n\n:param stick: The joystick port number and the target axis\n:param axis: The analog axis value to read from the joystick.\n\n:returns: What type of axis the axis is reporting to be" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "stick", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getTotalEnergy", - "returnType": "float", - "tooltip": "Query the total energy drawn from the monitored PDP channels.\n\nNot supported on the Rev PDH and returns 0.\n\n:returns: The total energy drawn in Joules" + "declaringClassName": "wpilib.DriverStation", + "functionName": "getJoystickIsGamepad", + "returnType": "bool", + "tooltip": "Returns a boolean indicating if the controller is an xbox controller.\n\n:param stick: The joystick port number\n\n:returns: A boolean that is true if the controller is an xbox controller." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "stick", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getTotalPower", - "returnType": "float", - "tooltip": "Query the total power drawn from all monitored PDP channels.\n\nNot supported on the Rev PDH and returns 0.\n\n:returns: The total power drawn in Watts" + "declaringClassName": "wpilib.DriverStation", + "functionName": "getJoystickName", + "returnType": "str", + "tooltip": "Returns the name of the joystick at the given port.\n\n:param stick: The joystick port number\n\n:returns: The name of the joystick at the given port" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "stick", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getType", - "returnType": "wpilib.PowerDistribution.ModuleType", - "tooltip": "Gets module type." + "declaringClassName": "wpilib.DriverStation", + "functionName": "getJoystickType", + "returnType": "int", + "tooltip": "Returns the type of joystick at a given port.\n\n:param stick: The joystick port number\n\n:returns: The HID type of joystick at the given port" + }, + { + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getLocation", + "returnType": "Optional[int]", + "tooltip": "Return the driver station location from the FMS.\n\nIf the FMS is not connected, it is set from the team alliance setting on\nthe driver station.\n\nThis could return 1, 2, or 3.\n\n:returns: The location of the driver station (1-3, 0 for invalid)" + }, + { + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getMatchNumber", + "returnType": "int", + "tooltip": "Returns the match number provided by the FMS.\n\n:returns: The number of the match" + }, + { + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getMatchTime", + "returnType": "wpimath.units.seconds", + "tooltip": "Return the approximate match time. The FMS does not send an official match\ntime to the robots, but does send an approximate match time. The value will\ncount down the time remaining in the current period (auto or teleop).\nWarning: This is not an official time (so it cannot be used to dispute ref\ncalls or guarantee that a function will trigger before the match ends).\n\nWhen connected to the real field, this number only changes in full\ninteger increments, and always counts down.\n\nWhen the DS is in practice mode, this number is a floating point number,\nand counts down.\n\nWhen the DS is in teleop or autonomous mode, this number is a floating\npoint number, and counts up.\n\nSimulation matches DS behavior without an FMS connected.\n\n:returns: Time remaining in current match period (auto or teleop) in seconds" + }, + { + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getMatchType", + "returnType": "wpilib.DriverStation.MatchType", + "tooltip": "Returns the type of match being played provided by the FMS.\n\n:returns: The match type enum (kNone, kPractice, kQualification,\n kElimination)" + }, + { + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getReplayNumber", + "returnType": "int", + "tooltip": "Returns the number of times the current match has been replayed from the\nFMS.\n\n:returns: The number of replays" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "stick", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getVersion", - "returnType": "wpilib.PowerDistribution.Version", - "tooltip": "" + "declaringClassName": "wpilib.DriverStation", + "functionName": "getStickAxis", + "returnType": "float", + "tooltip": "Get the value of the axis on a joystick.\n\nThis depends on the mapping of the joystick connected to the specified\nport.\n\n:param stick: The joystick to read.\n:param axis: The analog axis value to read from the joystick.\n\n:returns: The value of the axis on the joystick." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "stick", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "getVoltage", - "returnType": "float", - "tooltip": "Query the input voltage of the PDP/PDH.\n\n:returns: The input voltage in volts" + "declaringClassName": "wpilib.DriverStation", + "functionName": "getStickAxisCount", + "returnType": "int", + "tooltip": "Returns the number of axes on a given joystick port.\n\n:param stick: The joystick port number\n\n:returns: The number of axes on the indicated joystick" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "stick", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.DriverStation", + "functionName": "getStickButton", + "returnType": "bool", + "tooltip": "The state of one joystick button. %Button indexes begin at 1.\n\n:param stick: The joystick to read.\n:param button: The button index, beginning at 1.\n\n:returns: The state of the joystick button." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "stick", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "resetTotalEnergy", - "returnType": "None", - "tooltip": "Reset the total energy drawn from the PDP.\n\nNot supported on the Rev PDH and does nothing.\n\n@see PowerDistribution#GetTotalEnergy" + "declaringClassName": "wpilib.DriverStation", + "functionName": "getStickButtonCount", + "returnType": "int", + "tooltip": "Returns the number of buttons on a given joystick port.\n\n:param stick: The joystick port number\n\n:returns: The number of buttons on the indicated joystick" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution" + "name": "stick", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "enabled", - "type": "bool" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution", - "functionName": "setSwitchableChannel", - "returnType": "None", - "tooltip": "Sets the PDH switchable channel on or off. Does nothing with the CTRE PDP.\n\n:param enabled: Whether to turn the PDH switchable channel on or off" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.PowerDistribution.Faults", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.PowerDistribution.Faults", - "functionName": "__init__", - "returnType": "wpilib.PowerDistribution.Faults", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.DriverStation", + "functionName": "getStickButtonPressed", + "returnType": "bool", + "tooltip": "Whether one joystick button was pressed since the last check. %Button\nindexes begin at 1.\n\n:param stick: The joystick to read.\n:param button: The button index, beginning at 1.\n\n:returns: Whether the joystick button was pressed since the last check." + }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution.Faults" + "name": "stick", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution.Faults", - "functionName": "getBreakerFault", + "declaringClassName": "wpilib.DriverStation", + "functionName": "getStickButtonReleased", "returnType": "bool", - "tooltip": "Gets whether there is a breaker fault at a specified channel.\n\n:param channel: Channel to check for faults.\n\n:returns: If there is a breaker fault.\n @throws A ChannelIndexOutOfRange error if the given int is outside of the\n range supported by the hardware." - } - ], - "instanceVariables": [ - { - "name": "Brownout", - "tooltip": "The input voltage is below the minimum voltage.", - "type": "int", - "writable": true - }, - { - "name": "CanWarning", - "tooltip": "A warning was raised by the device's CAN controller.", - "type": "int", - "writable": true - }, - { - "name": "Channel0BreakerFault", - "tooltip": "Breaker fault on channel 0.", - "type": "int", - "writable": true - }, - { - "name": "Channel10BreakerFault", - "tooltip": "Breaker fault on channel 10.", - "type": "int", - "writable": true - }, - { - "name": "Channel11BreakerFault", - "tooltip": "Breaker fault on channel 12.", - "type": "int", - "writable": true - }, - { - "name": "Channel12BreakerFault", - "tooltip": "Breaker fault on channel 13.", - "type": "int", - "writable": true - }, - { - "name": "Channel13BreakerFault", - "tooltip": "Breaker fault on channel 14.", - "type": "int", - "writable": true - }, - { - "name": "Channel14BreakerFault", - "tooltip": "Breaker fault on channel 15.", - "type": "int", - "writable": true - }, - { - "name": "Channel15BreakerFault", - "tooltip": "Breaker fault on channel 16.", - "type": "int", - "writable": true - }, - { - "name": "Channel16BreakerFault", - "tooltip": "Breaker fault on channel 17.", - "type": "int", - "writable": true - }, - { - "name": "Channel17BreakerFault", - "tooltip": "Breaker fault on channel 18.", - "type": "int", - "writable": true - }, - { - "name": "Channel18BreakerFault", - "tooltip": "Breaker fault on channel 19.", - "type": "int", - "writable": true - }, - { - "name": "Channel19BreakerFault", - "tooltip": "Breaker fault on channel 20.", - "type": "int", - "writable": true - }, - { - "name": "Channel1BreakerFault", - "tooltip": "Breaker fault on channel 1.", - "type": "int", - "writable": true - }, - { - "name": "Channel20BreakerFault", - "tooltip": "Breaker fault on channel 21.", - "type": "int", - "writable": true - }, - { - "name": "Channel21BreakerFault", - "tooltip": "Breaker fault on channel 22.", - "type": "int", - "writable": true - }, - { - "name": "Channel22BreakerFault", - "tooltip": "Breaker fault on channel 23.", - "type": "int", - "writable": true - }, - { - "name": "Channel23BreakerFault", - "tooltip": "Breaker fault on channel 24.", - "type": "int", - "writable": true - }, - { - "name": "Channel2BreakerFault", - "tooltip": "Breaker fault on channel 2.", - "type": "int", - "writable": true - }, - { - "name": "Channel3BreakerFault", - "tooltip": "Breaker fault on channel 3.", - "type": "int", - "writable": true - }, - { - "name": "Channel4BreakerFault", - "tooltip": "Breaker fault on channel 4.", - "type": "int", - "writable": true - }, - { - "name": "Channel5BreakerFault", - "tooltip": "Breaker fault on channel 5.", - "type": "int", - "writable": true - }, - { - "name": "Channel6BreakerFault", - "tooltip": "Breaker fault on channel 6.", - "type": "int", - "writable": true - }, - { - "name": "Channel7BreakerFault", - "tooltip": "Breaker fault on channel 7.", - "type": "int", - "writable": true - }, - { - "name": "Channel8BreakerFault", - "tooltip": "Breaker fault on channel 8.", - "type": "int", - "writable": true + "tooltip": "Whether one joystick button was released since the last check. %Button\nindexes begin at 1.\n\n:param stick: The joystick to read.\n:param button: The button index, beginning at 1.\n\n:returns: Whether the joystick button was released since the last check." }, { - "name": "Channel9BreakerFault", - "tooltip": "Breaker fault on channel 9.", - "type": "int", - "writable": true + "args": [ + { + "defaultValue": "", + "name": "stick", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getStickButtons", + "returnType": "int", + "tooltip": "The state of the buttons on the joystick.\n\n:param stick: The joystick to read.\n\n:returns: The state of the buttons on the joystick." }, - { - "name": "HardwareFault", - "tooltip": "The hardware on the device has malfunctioned.", - "type": "int", - "writable": true - } - ], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.PowerDistribution.StickyFaults", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.PowerDistribution.StickyFaults", - "functionName": "__init__", - "returnType": "wpilib.PowerDistribution.StickyFaults", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PowerDistribution.StickyFaults" + "name": "stick", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "pov", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PowerDistribution.StickyFaults", - "functionName": "getBreakerFault", - "returnType": "bool", - "tooltip": "Gets whether there is a sticky breaker fault at the specified channel.\n\n:param channel: Index to check for sticky faults.\n\n:returns: True if there is a sticky breaker fault at the channel, otherwise\n false.\n @throws A ChannelIndexOutOfRange error if the provided channel is outside\n of the range supported by the hardware." - } - ], - "instanceVariables": [ - { - "name": "Brownout", - "tooltip": "The input voltage is below the minimum voltage.", - "type": "int", - "writable": true - }, - { - "name": "CanBusOff", - "tooltip": "The device's CAN controller experienced a \"Bus Off\" event.", - "type": "int", - "writable": true - }, - { - "name": "CanWarning", - "tooltip": "A warning was raised by the device's CAN controller.", - "type": "int", - "writable": true - }, - { - "name": "Channel0BreakerFault", - "tooltip": "Breaker fault on channel 0.", - "type": "int", - "writable": true - }, - { - "name": "Channel10BreakerFault", - "tooltip": "Breaker fault on channel 10.", - "type": "int", - "writable": true - }, - { - "name": "Channel11BreakerFault", - "tooltip": "Breaker fault on channel 12.", - "type": "int", - "writable": true - }, - { - "name": "Channel12BreakerFault", - "tooltip": "Breaker fault on channel 13.", - "type": "int", - "writable": true - }, - { - "name": "Channel13BreakerFault", - "tooltip": "Breaker fault on channel 14.", - "type": "int", - "writable": true + "declaringClassName": "wpilib.DriverStation", + "functionName": "getStickPOV", + "returnType": "wpilib.DriverStation.POVDirection", + "tooltip": "Get the state of a POV on the joystick.\n\n:returns: the angle of the POV." }, { - "name": "Channel14BreakerFault", - "tooltip": "Breaker fault on channel 15.", - "type": "int", - "writable": true + "args": [ + { + "defaultValue": "", + "name": "stick", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.DriverStation", + "functionName": "getStickPOVCount", + "returnType": "int", + "tooltip": "Returns the number of POVs on a given joystick port.\n\n:param stick: The joystick port number\n\n:returns: The number of POVs on the indicated joystick" }, { - "name": "Channel15BreakerFault", - "tooltip": "Breaker fault on channel 16.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isAutonomous", + "returnType": "bool", + "tooltip": "Check if the DS is commanding autonomous mode.\n\n:returns: True if the robot is being commanded to be in autonomous mode" }, { - "name": "Channel16BreakerFault", - "tooltip": "Breaker fault on channel 17.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isAutonomousEnabled", + "returnType": "bool", + "tooltip": "Check if the DS is commanding autonomous mode and if it has enabled the\nrobot.\n\n:returns: True if the robot is being commanded to be in autonomous mode and\n enabled." }, { - "name": "Channel17BreakerFault", - "tooltip": "Breaker fault on channel 18.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isDSAttached", + "returnType": "bool", + "tooltip": "Check if the DS is attached.\n\n:returns: True if the DS is connected to the robot" }, { - "name": "Channel18BreakerFault", - "tooltip": "Breaker fault on channel 19.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isDisabled", + "returnType": "bool", + "tooltip": "Check if the robot is disabled.\n\n:returns: True if the robot is explicitly disabled or the DS is not connected" }, { - "name": "Channel19BreakerFault", - "tooltip": "Breaker fault on channel 20.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isEStopped", + "returnType": "bool", + "tooltip": "Check if the robot is e-stopped.\n\n:returns: True if the robot is e-stopped" }, { - "name": "Channel1BreakerFault", - "tooltip": "Breaker fault on channel 1.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isEnabled", + "returnType": "bool", + "tooltip": "Check if the DS has enabled the robot.\n\n:returns: True if the robot is enabled and the DS is connected" }, { - "name": "Channel20BreakerFault", - "tooltip": "Breaker fault on channel 21.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isFMSAttached", + "returnType": "bool", + "tooltip": "Is the driver station attached to a Field Management System?\n\n:returns: True if the robot is competing on a field being controlled by a\n Field Management System" }, { - "name": "Channel21BreakerFault", - "tooltip": "Breaker fault on channel 22.", - "type": "int", - "writable": true + "args": [ + { + "defaultValue": "", + "name": "stick", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isJoystickConnected", + "returnType": "bool", + "tooltip": "Returns if a joystick is connected to the Driver Station.\n\nThis makes a best effort guess by looking at the reported number of axis,\nbuttons, and POVs attached.\n\n:param stick: The joystick port number\n\n:returns: true if a joystick is connected" }, { - "name": "Channel22BreakerFault", - "tooltip": "Breaker fault on channel 23.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isJoystickConnectionWarningSilenced", + "returnType": "bool", + "tooltip": "Returns whether joystick connection warnings are silenced. This will\nalways return false when connected to the FMS.\n\n:returns: Whether joystick connection warnings are silenced." }, { - "name": "Channel23BreakerFault", - "tooltip": "Breaker fault on channel 24.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isTeleop", + "returnType": "bool", + "tooltip": "Check if the DS is commanding teleop mode.\n\n:returns: True if the robot is being commanded to be in teleop mode" }, { - "name": "Channel2BreakerFault", - "tooltip": "Breaker fault on channel 2.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isTeleopEnabled", + "returnType": "bool", + "tooltip": "Check if the DS is commanding teleop mode and if it has enabled the robot.\n\n:returns: True if the robot is being commanded to be in teleop mode and\n enabled." }, { - "name": "Channel3BreakerFault", - "tooltip": "Breaker fault on channel 3.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isTest", + "returnType": "bool", + "tooltip": "Check if the DS is commanding test mode.\n\n:returns: True if the robot is being commanded to be in test mode" }, { - "name": "Channel4BreakerFault", - "tooltip": "Breaker fault on channel 4.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "isTestEnabled", + "returnType": "bool", + "tooltip": "Check if the DS is commanding Test mode and if it has enabled the robot.\n\n:returns: True if the robot is being commanded to be in Test mode and\n enabled." }, { - "name": "Channel5BreakerFault", - "tooltip": "Breaker fault on channel 5.", - "type": "int", - "writable": true + "args": [ + { + "defaultValue": "", + "name": "handle", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.DriverStation", + "functionName": "provideRefreshedDataEventHandle", + "returnType": "None", + "tooltip": "Registers the given handle for DS data refresh notifications.\n\n:param handle: The event handle." }, { - "name": "Channel6BreakerFault", - "tooltip": "Breaker fault on channel 6.", - "type": "int", - "writable": true + "args": [], + "declaringClassName": "wpilib.DriverStation", + "functionName": "refreshData", + "returnType": "None", + "tooltip": "Copy data from the DS task for the user. If no new data exists, it will\njust be returned, otherwise the data will be copied from the DS polling\nloop." }, { - "name": "Channel7BreakerFault", - "tooltip": "Breaker fault on channel 7.", - "type": "int", - "writable": true + "args": [ + { + "defaultValue": "", + "name": "handle", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.DriverStation", + "functionName": "removeRefreshedDataEventHandle", + "returnType": "None", + "tooltip": "Unregisters the given handle from DS data refresh notifications.\n\n:param handle: The event handle." }, { - "name": "Channel8BreakerFault", - "tooltip": "Breaker fault on channel 8.", - "type": "int", - "writable": true + "args": [ + { + "defaultValue": "", + "name": "silence", + "type": "bool" + } + ], + "declaringClassName": "wpilib.DriverStation", + "functionName": "silenceJoystickConnectionWarning", + "returnType": "None", + "tooltip": "Allows the user to specify whether they want joystick connection warnings\nto be printed to the console. This setting is ignored when the FMS is\nconnected -- warnings will always be on in that scenario.\n\n:param silence: Whether warning messages should be silenced." }, { - "name": "Channel9BreakerFault", - "tooltip": "Breaker fault on channel 9.", - "type": "int", - "writable": true + "args": [ + { + "defaultValue": "", + "name": "log", + "type": "wpilog._wpilog.DataLog" + }, + { + "defaultValue": "True", + "name": "logJoysticks", + "type": "bool" + } + ], + "declaringClassName": "wpilib.DriverStation", + "functionName": "startDataLog", + "returnType": "None", + "tooltip": "Starts logging DriverStation data to data log. Repeated calls are ignored.\n\n:param log: data log\n:param logJoysticks: if true, log joystick data" }, { - "name": "FirmwareFault", - "tooltip": "The firmware on the device has malfunctioned.", - "type": "int", - "writable": true + "args": [ + { + "defaultValue": "", + "name": "timeout", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpilib.DriverStation", + "functionName": "waitForDsConnection", + "returnType": "bool", + "tooltip": "Wait for a DS connection.\n\n:param timeout: timeout in seconds. 0 for infinite.\n\n:returns: true if connected, false if timeout" + } + ] + }, + { + "className": "wpilib.DriverStation.Alliance", + "classVariables": [ + { + "name": "kBlue", + "tooltip": "", + "type": "wpilib.DriverStation.Alliance", + "writable": false }, { - "name": "HardwareFault", - "tooltip": "The hardware on the device has malfunctioned.", - "type": "int", - "writable": true + "name": "kRed", + "tooltip": "", + "type": "wpilib.DriverStation.Alliance", + "writable": false + } + ], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.DriverStation.Alliance", + "functionName": "__init__", + "returnType": "wpilib.DriverStation.Alliance", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, { - "name": "HasReset", - "tooltip": "The device has rebooted.", + "name": "value", + "tooltip": "", "type": "int", - "writable": true + "writable": false } ], "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.PowerDistribution.Version", - "classVariables": [], + "className": "wpilib.DriverStation.MatchType", + "classVariables": [ + { + "name": "kElimination", + "tooltip": "", + "type": "wpilib.DriverStation.MatchType", + "writable": false + }, + { + "name": "kNone", + "tooltip": "", + "type": "wpilib.DriverStation.MatchType", + "writable": false + }, + { + "name": "kPractice", + "tooltip": "", + "type": "wpilib.DriverStation.MatchType", + "writable": false + }, + { + "name": "kQualification", + "tooltip": "", + "type": "wpilib.DriverStation.MatchType", + "writable": false + } + ], "constructors": [ { - "args": [], - "declaringClassName": "wpilib.PowerDistribution.Version", + "args": [ + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.DriverStation.MatchType", "functionName": "__init__", - "returnType": "wpilib.PowerDistribution.Version", + "returnType": "wpilib.DriverStation.MatchType", "tooltip": "" } ], @@ -21804,549 +5562,550 @@ "instanceMethods": [], "instanceVariables": [ { - "name": "FirmwareFix", - "tooltip": "Firmware fix version number.", - "type": "int", - "writable": true + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, { - "name": "FirmwareMajor", - "tooltip": "Firmware major version number.", + "name": "value", + "tooltip": "", "type": "int", - "writable": true + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.DriverStation.POVDirection", + "classVariables": [ + { + "name": "kCenter", + "tooltip": "", + "type": "wpilib.DriverStation.POVDirection", + "writable": false }, { - "name": "FirmwareMinor", - "tooltip": "Firmware minor version number.", - "type": "int", - "writable": true + "name": "kDown", + "tooltip": "", + "type": "wpilib.DriverStation.POVDirection", + "writable": false }, { - "name": "HardwareMajor", - "tooltip": "Hardware major version number.", - "type": "int", - "writable": true + "name": "kDownLeft", + "tooltip": "", + "type": "wpilib.DriverStation.POVDirection", + "writable": false }, { - "name": "HardwareMinor", - "tooltip": "Hardware minor version number.", - "type": "int", - "writable": true + "name": "kDownRight", + "tooltip": "", + "type": "wpilib.DriverStation.POVDirection", + "writable": false }, { - "name": "UniqueId", - "tooltip": "Unique ID.", - "type": "int", - "writable": true + "name": "kLeft", + "tooltip": "", + "type": "wpilib.DriverStation.POVDirection", + "writable": false + }, + { + "name": "kRight", + "tooltip": "", + "type": "wpilib.DriverStation.POVDirection", + "writable": false + }, + { + "name": "kUp", + "tooltip": "", + "type": "wpilib.DriverStation.POVDirection", + "writable": false + }, + { + "name": "kUpLeft", + "tooltip": "", + "type": "wpilib.DriverStation.POVDirection", + "writable": false + }, + { + "name": "kUpRight", + "tooltip": "", + "type": "wpilib.DriverStation.POVDirection", + "writable": false } ], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.Preferences", - "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.Preferences", + "declaringClassName": "wpilib.DriverStation.POVDirection", "functionName": "__init__", - "returnType": "wpilib.Preferences", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.DriverStation.POVDirection", + "tooltip": "" } ], "enums": [], "instanceMethods": [], - "instanceVariables": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], "moduleName": "wpilib", - "staticMethods": [ + "staticMethods": [] + }, + { + "className": "wpilib.DutyCycle", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "source", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "containsKey", - "returnType": "bool", - "tooltip": "Returns whether or not there is a key with the given name.\n\n:param key: the key\n\n:returns: if there is a value at the given key" - }, + "declaringClassName": "wpilib.DutyCycle", + "functionName": "__init__", + "returnType": "wpilib.DutyCycle", + "tooltip": "Constructs a DutyCycle input from a smartio channel.\n\n:param source: The channel to use." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "False", - "name": "defaultValue", - "type": "bool" + "name": "self", + "type": "wpilib.DutyCycle" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "getBoolean", - "returnType": "bool", - "tooltip": "Returns the boolean at the given key. If this table does not have a value\nfor that position, then the given defaultValue value will be returned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" + "declaringClassName": "wpilib.DutyCycle", + "functionName": "getFrequency", + "returnType": "wpimath.units.hertz", + "tooltip": "Get the frequency of the duty cycle signal.\n\n:returns: frequency" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "0.0", - "name": "defaultValue", - "type": "float" + "name": "self", + "type": "wpilib.DutyCycle" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "getDouble", - "returnType": "float", - "tooltip": "Returns the double at the given key. If this table does not have a value\nfor that position, then the given defaultValue value will be returned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" + "declaringClassName": "wpilib.DutyCycle", + "functionName": "getHighTime", + "returnType": "wpimath.units.seconds", + "tooltip": "Get the raw high time of the duty cycle signal.\n\n:returns: high time of last pulse" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "0.0", - "name": "defaultValue", - "type": "float" + "name": "self", + "type": "wpilib.DutyCycle" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "getFloat", + "declaringClassName": "wpilib.DutyCycle", + "functionName": "getOutput", "returnType": "float", - "tooltip": "Returns the float at the given key. If this table does not have a value\nfor that position, then the given defaultValue value will be returned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" + "tooltip": "Get the output ratio of the duty cycle signal.\n\n0 means always low, 1 means always high.\n\n:returns: output ratio between 0 and 1" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "0", - "name": "defaultValue", - "type": "int" + "name": "self", + "type": "wpilib.DutyCycle" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "getInt", + "declaringClassName": "wpilib.DutyCycle", + "functionName": "getSourceChannel", "returnType": "int", - "tooltip": "Returns the int at the given key. If this table does not have a value for\nthat position, then the given defaultValue value will be returned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" - }, - { - "args": [], - "declaringClassName": "wpilib.Preferences", - "functionName": "getKeys", - "returnType": "list[str]", - "tooltip": "Returns a vector of all the keys.\n\n:returns: a vector of the keys" + "tooltip": "Get the channel of the source.\n\n:returns: the source channel" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpiutil.Sendable" }, - { - "defaultValue": "0", - "name": "defaultValue", - "type": "int" - } - ], - "declaringClassName": "wpilib.Preferences", - "functionName": "getLong", - "returnType": "int", - "tooltip": "Returns the long (int64_t) at the given key. If this table does not have a\nvalue for that position, then the given defaultValue value will be\nreturned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" - }, - { - "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "''", - "name": "defaultValue", - "type": "str" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "getString", - "returnType": "str", - "tooltip": "Returns the string at the given key. If this table does not have a value\nfor that position, then the given defaultValue will be returned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" - }, + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.DutyCycleEncoder", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "bool" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "initBoolean", - "returnType": "None", - "tooltip": "Puts the given boolean into the preferences table if it doesn't\nalready exist." + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "__init__", + "returnType": "wpilib.DutyCycleEncoder", + "tooltip": "Construct a new DutyCycleEncoder on a specific channel.\n\nThis has a fullRange of 1 and an expectedZero of 0.\n\n:param channel: the channel to attach to" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" + "name": "dutyCycle", + "type": "wpilib.DutyCycle" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "initDouble", - "returnType": "None", - "tooltip": "Puts the given double into the preferences table if it doesn't\nalready exist." + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "__init__", + "returnType": "wpilib.DutyCycleEncoder", + "tooltip": "Construct a new DutyCycleEncoder attached to an existing DutyCycle object.\n\nThis has a fullRange of 1 and an expectedZero of 0.\n\n:param dutyCycle: the duty cycle to attach to" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "channel", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "fullRange", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "expectedZero", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "initFloat", - "returnType": "None", - "tooltip": "Puts the given float into the preferences table if it doesn't\nalready exist." + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "__init__", + "returnType": "wpilib.DutyCycleEncoder", + "tooltip": "Construct a new DutyCycleEncoder on a specific channel.\n\n:param channel: the channel to attach to\n:param fullRange: the value to report at maximum travel\n:param expectedZero: the reading where you would expect a 0 from get()" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "dutyCycle", + "type": "wpilib.DutyCycle" }, { "defaultValue": "", - "name": "value", - "type": "int" + "name": "fullRange", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "expectedZero", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "initInt", - "returnType": "None", - "tooltip": "Puts the given int into the preferences table if it doesn't\nalready exist." - }, + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "__init__", + "returnType": "wpilib.DutyCycleEncoder", + "tooltip": "Construct a new DutyCycleEncoder attached to an existing DutyCycle object.\n\n:param dutyCycle: the duty cycle to attach to\n:param fullRange: the value to report at maximum travel\n:param expectedZero: the reading where you would expect a 0 from get()" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "int" + "name": "self", + "type": "wpilib.DutyCycleEncoder" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "initLong", - "returnType": "None", - "tooltip": "Puts the given long into the preferences table if it doesn't\nalready exist." + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the encoder value.\n\n:returns: the encoder value scaled by the full range input" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "str" + "name": "self", + "type": "wpilib.DutyCycleEncoder" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "initString", - "returnType": "None", - "tooltip": "Puts the given string into the preferences table if it doesn't\nalready exist." + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "getFrequency", + "returnType": "wpimath.units.hertz", + "tooltip": "Get the frequency of the duty cycle signal from the encoder.\n\n:returns: duty cycle frequency" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.DutyCycleEncoder" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "remove", - "returnType": "None", - "tooltip": "Remove a preference.\n\n:param key: the key" - }, - { - "args": [], - "declaringClassName": "wpilib.Preferences", - "functionName": "removeAll", - "returnType": "None", - "tooltip": "Remove all preferences." + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "getSourceChannel", + "returnType": "int", + "tooltip": "Get the channel of the source.\n\n:returns: the source channel" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.DutyCycleEncoder" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "setBoolean", + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "initSendable", "returnType": "None", - "tooltip": "Puts the given boolean into the preferences table.\n\nThe key may not have any whitespace nor an equals sign.\n\n:param key: the key\n:param value: the value" + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" + "name": "self", + "type": "wpilib.DutyCycleEncoder" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "setDouble", - "returnType": "None", - "tooltip": "Puts the given double into the preferences table.\n\nThe key may not have any whitespace nor an equals sign.\n\n:param key: the key\n:param value: the value" + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "isConnected", + "returnType": "bool", + "tooltip": "Get if the sensor is connected\n\nThis uses the duty cycle frequency to determine if the sensor is connected.\nBy default, a value of 100 Hz is used as the threshold, and this value can\nbe changed with SetConnectedFrequencyThreshold.\n\n:returns: true if the sensor is connected" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.DutyCycleEncoder" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "frequency", + "type": "wpimath.units.hertz" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "setFloat", + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "setAssumedFrequency", "returnType": "None", - "tooltip": "Puts the given float into the preferences table.\n\nThe key may not have any whitespace nor an equals sign.\n\n:param key: the key\n:param value: the value" + "tooltip": "Sets the assumed frequency of the connected device.\n\nBy default, the DutyCycle engine has to compute the frequency of the\ninput signal. This can result in both delayed readings and jumpy readings.\nTo solve this, you can pass the expected frequency of the sensor to this\nfunction. This will use that frequency to compute the DutyCycle percentage,\nrather than the computed frequency.\n\n:param frequency: the assumed frequency of the sensor" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.DutyCycleEncoder" }, { "defaultValue": "", - "name": "value", - "type": "int" + "name": "frequency", + "type": "wpimath.units.hertz" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "setInt", + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "setConnectedFrequencyThreshold", "returnType": "None", - "tooltip": "Puts the given int into the preferences table.\n\nThe key may not have any whitespace nor an equals sign.\n\n:param key: the key\n:param value: the value" + "tooltip": "Change the frequency threshold for detecting connection used by\nIsConnected.\n\n:param frequency: the minimum frequency." }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.DutyCycleEncoder" }, { "defaultValue": "", - "name": "value", - "type": "int" + "name": "min", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "max", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "setLong", + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "setDutyCycleRange", "returnType": "None", - "tooltip": "Puts the given long (int64_t) into the preferences table.\n\nThe key may not have any whitespace nor an equals sign.\n\n:param key: the key\n:param value: the value" + "tooltip": "Set the encoder duty cycle range. As the encoder needs to maintain a duty\ncycle, the duty cycle cannot go all the way to 0% or all the way to 100%.\nFor example, an encoder with a 4096 us period might have a minimum duty\ncycle of 1 us / 4096 us and a maximum duty cycle of 4095 / 4096 us. Setting\nthe range will result in an encoder duty cycle less than or equal to the\nminimum being output as 0 rotation, the duty cycle greater than or equal to\nthe maximum being output as 1 rotation, and values in between linearly\nscaled from 0 to 1.\n\n:param min: minimum duty cycle (0-1 range)\n:param max: maximum duty cycle (0-1 range)" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.DutyCycleEncoder" }, { "defaultValue": "", - "name": "value", - "type": "str" + "name": "inverted", + "type": "bool" } ], - "declaringClassName": "wpilib.Preferences", - "functionName": "setString", + "declaringClassName": "wpilib.DutyCycleEncoder", + "functionName": "setInverted", "returnType": "None", - "tooltip": "Puts the given string into the preferences table.\n\nThe value may not have quotation marks, nor may the key have any whitespace\nnor an equals sign.\n\n:param key: the key\n:param value: the value" + "tooltip": "Set if this encoder is inverted.\n\n:param inverted: true to invert the encoder, false otherwise" } - ] + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] }, { - "className": "wpilib.Relay", + "className": "wpilib.Encoder", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "aChannel", + "type": "typing.SupportsInt" }, { - "defaultValue": "", - "name": "direction", - "type": "wpilib.Relay.Direction" + "defaultValue": "", + "name": "bChannel", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "False", + "name": "reverseDirection", + "type": "bool" + }, + { + "defaultValue": "", + "name": "encodingType", + "type": "wpilib.interfaces.CounterBase.EncodingType" } ], - "declaringClassName": "wpilib.Relay", + "declaringClassName": "wpilib.Encoder", "functionName": "__init__", - "returnType": "wpilib.Relay", - "tooltip": "Relay constructor given a channel.\n\nThis code initializes the relay and reserves all resources that need to be\nlocked. Initially the relay is set to both lines at 0v.\n\n:param channel: The channel number (0-3).\n:param direction: The direction that the Relay object will control." + "returnType": "wpilib.Encoder", + "tooltip": "Encoder constructor.\n\nConstruct a Encoder given a and b channels.\n\nThe counter will start counting immediately.\n\n:param aChannel: The a channel DIO channel. 0-9 are on-board, 10-25\n are on the MXP port\n:param bChannel: The b channel DIO channel. 0-9 are on-board, 10-25\n are on the MXP port\n:param reverseDirection: represents the orientation of the encoder and\n inverts the output values if necessary so forward\n represents positive values.\n:param encodingType: either k1X, k2X, or k4X to indicate 1X, 2X or 4X\n decoding. If 4X is selected, then an encoder FPGA\n object is used and the returned counts will be 4x\n the encoder spec'd value since all rising and\n falling edges are counted. If 1X or 2X are selected\n then a counter object will be used and the returned\n value will either exactly match the spec'd count or\n be double (2x) the spec'd count." } ], - "enums": [ + "enums": [], + "instanceMethods": [ { - "enumClassName": "wpilib.Relay.Direction", - "enumValues": [ - "kBothDirections", - "kForwardOnly", - "kReverseOnly" + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.Encoder" + } ], - "moduleName": "wpilib", - "tooltip": "The Direction(s) that a relay is configured to operate in.\n\nMembers:\n\n kBothDirections : Both directions are valid.\n\n kForwardOnly : Only forward is valid.\n\n kReverseOnly : Only reverse is valid." + "declaringClassName": "wpilib.Encoder", + "functionName": "get", + "returnType": "int", + "tooltip": "Gets the current count.\n\nReturns the current count on the Encoder. This method compensates for the\ndecoding type.\n\n:returns: Current count from the Encoder adjusted for the 1x, 2x, or 4x scale\n factor." }, - { - "enumClassName": "wpilib.Relay.Value", - "enumValues": [ - "kForward", - "kOff", - "kOn", - "kReverse" - ], - "moduleName": "wpilib", - "tooltip": "The state to drive a Relay to.\n\nMembers:\n\n kOff : Off.\n\n kOn : On.\n\n kForward : Forward.\n\n kReverse : Reverse." - } - ], - "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.Encoder" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + "declaringClassName": "wpilib.Encoder", + "functionName": "getDirection", + "returnType": "bool", + "tooltip": "The last direction the encoder value changed.\n\n:returns: The last direction the encoder value changed." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.Encoder" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." + "declaringClassName": "wpilib.Encoder", + "functionName": "getDistance", + "returnType": "float", + "tooltip": "Get the distance the robot has driven since the last reset.\n\n:returns: The distance driven since the last reset as scaled by the value\n from SetDistancePerPulse()." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Relay" + "type": "wpilib.Encoder" } ], - "declaringClassName": "wpilib.Relay", - "functionName": "get", - "returnType": "wpilib.Relay.Value", - "tooltip": "Get the Relay State\n\nGets the current state of the relay.\n\nWhen set to kForwardOnly or kReverseOnly, value is returned as kOn/kOff not\nkForward/kReverse (per the recommendation in Set).\n\n:returns: The current state of the relay as a Relay::Value" + "declaringClassName": "wpilib.Encoder", + "functionName": "getDistancePerPulse", + "returnType": "float", + "tooltip": "Get the distance per pulse for this encoder.\n\n:returns: The scale factor that will be used to convert pulses to useful\n units." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Relay" + "type": "wpilib.Encoder" } ], - "declaringClassName": "wpilib.Relay", - "functionName": "getChannel", + "declaringClassName": "wpilib.Encoder", + "functionName": "getEncodingScale", "returnType": "int", - "tooltip": "" + "tooltip": "The encoding scale factor 1x, 2x, or 4x, per the requested encodingType.\n\nUsed to divide raw edge counts down to spec'd counts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Relay" + "type": "wpilib.Encoder" } ], - "declaringClassName": "wpilib.Relay", - "functionName": "getDescription", - "returnType": "str", + "declaringClassName": "wpilib.Encoder", + "functionName": "getFPGAIndex", + "returnType": "int", "tooltip": "" }, { @@ -22354,337 +6113,339 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.Encoder" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", + "declaringClassName": "wpilib.Encoder", + "functionName": "getPeriod", "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "tooltip": "Returns the period of the most recent pulse.\n\nReturns the period of the most recent Encoder pulse in seconds. This method\ncompensates for the decoding type.\n\nWarning: This returns unscaled periods. Use GetRate() for rates that are\nscaled using the value from SetDistancePerPulse().\n\n:deprecated: Use getRate() in favor of this method.\n\n:returns: Period in seconds of the most recent pulse." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Relay" - }, + "type": "wpilib.Encoder" + } + ], + "declaringClassName": "wpilib.Encoder", + "functionName": "getRate", + "returnType": "float", + "tooltip": "Get the current rate of the encoder.\n\nUnits are distance per second as scaled by the value from\nSetDistancePerPulse().\n\n:returns: The current rate of the encoder." + }, + { + "args": [ { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "self", + "type": "wpilib.Encoder" } ], - "declaringClassName": "wpilib.Relay", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Encoder", + "functionName": "getRaw", + "returnType": "int", + "tooltip": "Gets the raw value from the encoder.\n\nThe raw value is the actual count unscaled by the 1x, 2x, or 4x scale\nfactor.\n\n:returns: Current raw count from the encoder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.Encoder" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "declaringClassName": "wpilib.Encoder", + "functionName": "getSamplesToAverage", + "returnType": "int", + "tooltip": "Get the Samples to Average which specifies the number of samples of the\ntimer to average when calculating the period.\n\nPerform averaging to account for mechanical imperfections or as\noversampling to increase resolution.\n\n:returns: The number of samples being averaged (from 1 to 127)" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.Encoder" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", + "declaringClassName": "wpilib.Encoder", + "functionName": "getStopped", "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "tooltip": "Determine if the encoder is stopped.\n\nUsing the MaxPeriod value, a boolean is returned that is true if the\nencoder is considered stopped and false if it is still moving. A stopped\nencoder is one where the most recent pulse width exceeds the MaxPeriod.\n\n:returns: True if the encoder is considered stopped." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Relay" + "type": "wpilib.Encoder" }, { "defaultValue": "", - "name": "value", - "type": "wpilib.Relay.Value" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.Relay", - "functionName": "set", + "declaringClassName": "wpilib.Encoder", + "functionName": "initSendable", "returnType": "None", - "tooltip": "Set the relay state.\n\nValid values depend on which directions of the relay are controlled by the\nobject.\n\nWhen set to kBothDirections, the relay can be any of the four states:\n0v-0v, 0v-12v, 12v-0v, 12v-12v\n\nWhen set to kForwardOnly or kReverseOnly, you can specify the constant for\nthe direction or you can simply specify kOff and kOn. Using only kOff and\nkOn is recommended.\n\n:param value: The state to set the relay." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" + "type": "wpilib.Encoder" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", + "declaringClassName": "wpilib.Encoder", + "functionName": "reset", "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "tooltip": "Reset the Encoder distance to zero.\n\nResets the current count to zero on the encoder." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.Encoder" }, { "defaultValue": "", - "name": "enabled", - "type": "bool" + "name": "distancePerPulse", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", + "declaringClassName": "wpilib.Encoder", + "functionName": "setDistancePerPulse", "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "tooltip": "Set the distance per pulse for this encoder.\n\nThis sets the multiplier used to determine the distance driven based on the\ncount value from the encoder.\n\nDo not include the decoding type in this scale. The library already\ncompensates for the decoding type.\n\nSet this value based on the encoder's rated Pulses per Revolution and\nfactor in gearing reductions following the encoder shaft.\n\nThis distance can be in any units you like, linear or angular.\n\n:param distancePerPulse: The scale factor that will be used to convert\n pulses to useful units." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Relay" - } - ], - "declaringClassName": "wpilib.Relay", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.Relay", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.RobotBase", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.RobotBase", - "functionName": "__init__", - "returnType": "wpilib.RobotBase", - "tooltip": "Constructor for a generic robot program.\n\nUser code can be placed in the constructor that runs before the\nAutonomous or Operator Control period starts. The constructor will run to\ncompletion before Autonomous is entered.\n\nThis must be used to ensure that the communications code starts. In the\nfuture it would be nice to put this code into it's own task that loads on\nboot so ensure that it runs." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ + "type": "wpilib.Encoder" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" + "name": "maxPeriod", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "endCompetition", + "declaringClassName": "wpilib.Encoder", + "functionName": "setMaxPeriod", "returnType": "None", - "tooltip": "Ends the main loop in StartCompetition()." + "tooltip": "Sets the maximum period for stopped detection.\n\nSets the value that represents the maximum period of the Encoder before it\nwill assume that the attached device is stopped. This timeout allows users\nto determine if the wheels or other shaft has stopped rotating.\nThis method compensates for the decoding type.\n\n:deprecated: Use SetMinRate() in favor of this method. This takes unscaled\n periods and SetMinRate() scales using value from\n SetDistancePerPulse().\n\n:param maxPeriod: The maximum time between rising and falling edges before\n the FPGA will report the device stopped. This is expressed\n in seconds." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" - } - ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "getControlState", - "returnType": "tuple[bool, bool, bool]", - "tooltip": "More efficient way to determine what state the robot is in.\n\n:returns: booleans representing enabled, isautonomous, istest\n\n.. versionadded:: 2019.2.1\n\n.. note:: This function only exists in RobotPy" - }, - { - "args": [ + "type": "wpilib.Encoder" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.RobotBase" + "name": "minRate", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isAutonomous", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Autonomous mode.\n\n:returns: True if the robot is currently operating Autonomously as determined\n by the Driver Station." + "declaringClassName": "wpilib.Encoder", + "functionName": "setMinRate", + "returnType": "None", + "tooltip": "Set the minimum rate of the device before the hardware reports it stopped.\n\n:param minRate: The minimum rate. The units are in distance per second as\n scaled by the value from SetDistancePerPulse()." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.Encoder" + }, + { + "defaultValue": "", + "name": "reverseDirection", + "type": "bool" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isAutonomousEnabled", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Autonomous mode and enabled.\n\n:returns: True if the robot us currently operating Autonomously while enabled\n as determined by the Driver Station." + "declaringClassName": "wpilib.Encoder", + "functionName": "setReverseDirection", + "returnType": "None", + "tooltip": "Set the direction sensing for this encoder.\n\nThis sets the direction sensing on the encoder so that it could count in\nthe correct software direction regardless of the mounting.\n\n:param reverseDirection: true if the encoder direction should be reversed" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.Encoder" + }, + { + "defaultValue": "", + "name": "samplesToAverage", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isDisabled", - "returnType": "bool", - "tooltip": "Determine if the Robot is currently disabled.\n\n:returns: True if the Robot is currently disabled by the Driver Station." + "declaringClassName": "wpilib.Encoder", + "functionName": "setSamplesToAverage", + "returnType": "None", + "tooltip": "Set the Samples to Average which specifies the number of samples of the\ntimer to average when calculating the period.\n\nPerform averaging to account for mechanical imperfections or as\noversampling to increase resolution.\n\n:param samplesToAverage: The number of samples to average from 1 to 127." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.Encoder" + }, + { + "defaultValue": "", + "name": "device", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isEnabled", - "returnType": "bool", - "tooltip": "Determine if the Robot is currently enabled.\n\n:returns: True if the Robot is currently enabled by the Driver Station." - }, + "declaringClassName": "wpilib.Encoder", + "functionName": "setSimDevice", + "returnType": "None", + "tooltip": "Indicates this encoder is used by a simulated device.\n\n:param device: simulated device handle" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.Field2d", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.Field2d", + "functionName": "__init__", + "returnType": "wpilib.Field2d", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.Field2d" + }, + { + "defaultValue": "", + "name": "name", + "type": "str" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTeleop", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Operator Control mode.\n\n:returns: True if the robot is currently operating in Tele-Op mode as\n determined by the Driver Station." + "declaringClassName": "wpilib.Field2d", + "functionName": "getObject", + "returnType": "wpilib.FieldObject2d", + "tooltip": "Get or create a field object.\n\n:returns: Field object" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.Field2d" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTeleopEnabled", - "returnType": "bool", - "tooltip": "Determine if the robot is current in Operator Control mode and enabled.\n\n:returns: True if the robot is currently operating in Tele-Op mode while\n enabled as determined by the Driver Station." + "declaringClassName": "wpilib.Field2d", + "functionName": "getRobotObject", + "returnType": "wpilib.FieldObject2d", + "tooltip": "Get the robot object.\n\n:returns: Field object for robot" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.Field2d" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTest", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Test mode.\n\n:returns: True if the robot is currently running in Test mode as determined\n by the Driver Station." + "declaringClassName": "wpilib.Field2d", + "functionName": "getRobotPose", + "returnType": "wpimath.geometry.Pose2d", + "tooltip": "Get the robot pose.\n\n:returns: 2D pose" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.Field2d" + }, + { + "defaultValue": "", + "name": "builder", + "type": "ntcore.NTSendableBuilder" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTestEnabled", - "returnType": "bool", - "tooltip": "Determine if the robot is current in Test mode and enabled.\n\n:returns: True if the robot is currently operating in Test mode while\n enabled as determined by the Driver Station." + "declaringClassName": "wpilib.Field2d", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.Field2d" + }, + { + "defaultValue": "", + "name": "pose", + "type": "wpimath.geometry.Pose2d" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "startCompetition", + "declaringClassName": "wpilib.Field2d", + "functionName": "setRobotPose", "returnType": "None", - "tooltip": "Start the main robot code. This function will be called once and should not\nexit until signalled by EndCompetition()" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.RobotBase", - "functionName": "getRuntimeType", - "returnType": "wpilib.RuntimeType", - "tooltip": "Get the current runtime type.\n\n:returns: Current runtime type." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isReal", - "returnType": "bool", - "tooltip": "Get if the robot is real.\n\n:returns: If the robot is running in the real world." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isSimulation", - "returnType": "bool", - "tooltip": "Get if the robot is a simulation.\n\n:returns: If the robot is running in simulation." + "tooltip": "Set the robot pose from a Pose object.\n\n:param pose: 2D pose" }, { "args": [ { "defaultValue": "", - "name": "robot_cls", - "type": "object" + "name": "self", + "type": "wpilib.Field2d" + }, + { + "defaultValue": "", + "name": "x", + "type": "wpimath.units.meters" + }, + { + "defaultValue": "", + "name": "y", + "type": "wpimath.units.meters" + }, + { + "defaultValue": "", + "name": "rotation", + "type": "wpimath.geometry.Rotation2d" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "main", - "returnType": "object", - "tooltip": "Starting point for the application" + "declaringClassName": "wpilib.Field2d", + "functionName": "setRobotPose", + "returnType": "None", + "tooltip": "Set the robot pose from x, y, and rotation.\n\n:param x: X location\n:param y: Y location\n:param rotation: rotation" } - ] + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] }, { - "className": "wpilib.RobotController", + "className": "wpilib.FieldObject2d", "classVariables": [], "constructors": [ { @@ -22700,1412 +6461,1084 @@ "type": "dict" } ], - "declaringClassName": "wpilib.RobotController", + "declaringClassName": "wpilib.FieldObject2d", "functionName": "__init__", - "returnType": "wpilib.RobotController", + "returnType": "wpilib.FieldObject2d", "tooltip": "Initialize self. See help(type(self)) for accurate signature." } ], "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getBatteryVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Read the battery voltage.\n\n:returns: The battery voltage in Volts." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getBrownoutVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Get the current brownout voltage setting.\n\n:returns: The brownout voltage" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getCANStatus", - "returnType": "wpilib.CANStatus", - "tooltip": "Get the current status of the CAN bus.\n\n:returns: The status of the CAN bus" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getCPUTemp", - "returnType": "wpimath.units.celsius", - "tooltip": "Get the current CPU temperature.\n\n:returns: current CPU temperature" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getComments", - "returnType": "str", - "tooltip": "Return the comments from the roboRIO web interface.\n\nThe comments string is cached after the first call to this function on the\nRoboRIO - restart the robot code to reload the comments string after\nchanging it in the web interface.\n\n:returns: The comments from the roboRIO web interface." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getCommsDisableCount", - "returnType": "int", - "tooltip": "Gets the number of times the system has been disabled due to communication\nerrors with the Driver Station.\n\n:returns: number of disables due to communication errors." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getCurrent3V3", - "returnType": "float", - "tooltip": "Get the current output of the 3.3V rail.\n\n:returns: The controller 3.3V rail output current value in Amps" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getCurrent5V", - "returnType": "float", - "tooltip": "Get the current output of the 5V rail.\n\n:returns: The controller 5V rail output current value in Amps" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getCurrent6V", - "returnType": "float", - "tooltip": "Get the current output of the 6V rail.\n\n:returns: The controller 6V rail output current value in Amps" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getEnabled3V3", - "returnType": "bool", - "tooltip": "Get the enabled state of the 3.3V rail. The rail may be disabled due to\ncalling SetEnabled3V3(), a controller brownout, a short circuit on the\nrail, or controller over-voltage.\n\n:returns: The controller 3.3V rail enabled value. True for enabled." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getEnabled5V", - "returnType": "bool", - "tooltip": "Get the enabled state of the 5V rail. The rail may be disabled due to\ncalling SetEnabled5V(), a controller brownout, a short circuit on the rail,\nor controller over-voltage.\n\n:returns: The controller 5V rail enabled value. True for enabled." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getEnabled6V", - "returnType": "bool", - "tooltip": "Get the enabled state of the 6V rail. The rail may be disabled due to\ncalling SetEnabled6V(), a controller brownout, a short circuit on the rail,\nor controller over-voltage.\n\n:returns: The controller 6V rail enabled value. True for enabled." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getFPGARevision", - "returnType": "int", - "tooltip": "Return the FPGA Revision number.\n\nThe format of the revision is 3 numbers. The 12 most significant bits are\nthe Major Revision. The next 8 bits are the Minor Revision. The 12 least\nsignificant bits are the Build Number.\n\n:returns: FPGA Revision number." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getFPGATime", - "returnType": "int", - "tooltip": "Read the microsecond-resolution timer on the FPGA.\n\n:returns: The current time in microseconds according to the FPGA (since FPGA\n reset)." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getFPGAVersion", - "returnType": "int", - "tooltip": "Return the FPGA Version number.\n\nFor now, expect this to be competition year.\n\n:returns: FPGA Version number." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getFaultCount3V3", - "returnType": "int", - "tooltip": "Get the count of the total current faults on the 3.3V rail since the\ncode started.\n\n:returns: The number of faults" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getFaultCount5V", - "returnType": "int", - "tooltip": "Get the count of the total current faults on the 5V rail since the\ncode started.\n\n:returns: The number of faults" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getFaultCount6V", - "returnType": "int", - "tooltip": "Get the count of the total current faults on the 6V rail since the\ncode started.\n\n:returns: The number of faults." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getInputCurrent", - "returnType": "float", - "tooltip": "Get the input current to the robot controller.\n\n:returns: The controller input current value in Amps" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getInputVoltage", - "returnType": "float", - "tooltip": "Get the input voltage to the robot controller.\n\n:returns: The controller input voltage value in Volts" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getRSLState", - "returnType": "bool", - "tooltip": "Gets the current state of the Robot Signal Light (RSL)\n\n:returns: The current state of the RSL- true if on, false if off" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getRadioLEDState", - "returnType": "wpilib.RadioLEDState", - "tooltip": "Get the state of the \"Radio\" LED. On the RoboRIO, this reads from sysfs, so\nthis function should not be called multiple times per loop cycle to avoid\noverruns.\n\n:returns: The state of the LED." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getSerialNumber", - "returnType": "str", - "tooltip": "Return the serial number of the roboRIO.\n\n:returns: The serial number of the roboRIO." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getTeamNumber", - "returnType": "int", - "tooltip": "Returns the team number configured for the robot controller.\n\n:returns: team number, or 0 if not found." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getTime", - "returnType": "int", - "tooltip": "Read the microsecond timestamp. By default, the time is based on the FPGA\nhardware clock in microseconds since the FPGA started. However, the return\nvalue of this method may be modified to use any time base, including\nnon-monotonic and non-continuous time bases.\n\n:returns: The current time in microseconds." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getUserButton", - "returnType": "bool", - "tooltip": "Get the state of the \"USER\" button on the roboRIO.\n\n@warning the User Button is used to stop user programs from automatically\nloading if it is held for more then 5 seconds. Because of this, it's not\nrecommended to be used by teams for any other purpose.\n\n:returns: True if the button is currently pressed down" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getVoltage3V3", - "returnType": "float", - "tooltip": "Get the voltage of the 3.3V rail.\n\n:returns: The controller 3.3V rail voltage value in Volts" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getVoltage5V", - "returnType": "float", - "tooltip": "Get the voltage of the 5V rail.\n\n:returns: The controller 5V rail voltage value in Volts" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "getVoltage6V", - "returnType": "float", - "tooltip": "Get the voltage of the 6V rail.\n\n:returns: The controller 6V rail voltage value in Volts" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "isBrownedOut", - "returnType": "bool", - "tooltip": "Check if the system is browned out.\n\n:returns: True if the system is browned out" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "isSysActive", - "returnType": "bool", - "tooltip": "Check if the FPGA outputs are enabled.\n\nThe outputs may be disabled if the robot is disabled or e-stopped, the\nwatchdog has expired, or if the roboRIO browns out.\n\n:returns: True if the FPGA outputs are enabled." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "isSystemTimeValid", - "returnType": "bool", - "tooltip": "Gets if the system time is valid.\n\n:returns: True if the system time is valid, false otherwise" - }, - { - "args": [], - "declaringClassName": "wpilib.RobotController", - "functionName": "resetRailFaultCounts", - "returnType": "None", - "tooltip": "Reset the overcurrent fault counters for all user rails to 0." - }, + "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "brownoutVoltage", - "type": "wpimath.units.volts" + "name": "self", + "type": "wpilib.FieldObject2d" } ], - "declaringClassName": "wpilib.RobotController", - "functionName": "setBrownoutVoltage", - "returnType": "None", - "tooltip": "Set the voltage the roboRIO will brownout and disable all outputs.\n\nNote that this only does anything on the roboRIO 2.\nOn the roboRIO it is a no-op.\n\n:param brownoutVoltage: The brownout voltage" + "declaringClassName": "wpilib.FieldObject2d", + "functionName": "getPose", + "returnType": "wpimath.geometry.Pose2d", + "tooltip": "Get the pose.\n\n:returns: 2D pose, or 0,0,0 if unknown / does not exist" }, { "args": [ { "defaultValue": "", - "name": "enabled", - "type": "bool" + "name": "self", + "type": "wpilib.FieldObject2d" } ], - "declaringClassName": "wpilib.RobotController", - "functionName": "setEnabled3V3", - "returnType": "None", - "tooltip": "Enables or disables the 3.3V rail.\n\n:param enabled: whether to enable the 3.3V rail." + "declaringClassName": "wpilib.FieldObject2d", + "functionName": "getPoses", + "returnType": "list[wpimath.geometry.Pose2d]", + "tooltip": "Get multiple poses.\n\n:returns: vector of 2D poses" }, { "args": [ { "defaultValue": "", - "name": "enabled", - "type": "bool" + "name": "self", + "type": "wpilib.FieldObject2d" + }, + { + "defaultValue": "", + "name": "pose", + "type": "wpimath.geometry.Pose2d" } ], - "declaringClassName": "wpilib.RobotController", - "functionName": "setEnabled5V", + "declaringClassName": "wpilib.FieldObject2d", + "functionName": "setPose", "returnType": "None", - "tooltip": "Enables or disables the 5V rail.\n\n:param enabled: whether to enable the 5V rail." + "tooltip": "Set the pose from a Pose object.\n\n:param pose: 2D pose" }, { "args": [ { "defaultValue": "", - "name": "enabled", - "type": "bool" + "name": "self", + "type": "wpilib.FieldObject2d" + }, + { + "defaultValue": "", + "name": "x", + "type": "wpimath.units.meters" + }, + { + "defaultValue": "", + "name": "y", + "type": "wpimath.units.meters" + }, + { + "defaultValue": "", + "name": "rotation", + "type": "wpimath.geometry.Rotation2d" } ], - "declaringClassName": "wpilib.RobotController", - "functionName": "setEnabled6V", + "declaringClassName": "wpilib.FieldObject2d", + "functionName": "setPose", "returnType": "None", - "tooltip": "Enables or disables the 6V rail.\n\n:param enabled: whether to enable the 6V rail." + "tooltip": "Set the pose from x, y, and rotation.\n\n:param x: X location\n:param y: Y location\n:param rotation: rotation" }, { "args": [ { "defaultValue": "", - "name": "state", - "type": "wpilib.RadioLEDState" + "name": "self", + "type": "wpilib.FieldObject2d" + }, + { + "defaultValue": "", + "name": "poses", + "type": "List[wpimath.geometry.Pose2d]" } ], - "declaringClassName": "wpilib.RobotController", - "functionName": "setRadioLEDState", + "declaringClassName": "wpilib.FieldObject2d", + "functionName": "setPoses", "returnType": "None", - "tooltip": "Set the state of the \"Radio\" LED. On the RoboRIO, this writes to sysfs, so\nthis function should not be called multiple times per loop cycle to avoid\noverruns.\n\n:param state: The state to set the LED to." + "tooltip": "Set multiple poses from an array of Pose objects.\nThe total number of poses is limited to 85.\n\n:param poses: array of 2D poses" }, { "args": [ { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], int]" + "name": "self", + "type": "wpilib.FieldObject2d" + }, + { + "defaultValue": "", + "name": "trajectory", + "type": "wpimath.trajectory.Trajectory" } ], - "declaringClassName": "wpilib.RobotController", - "functionName": "setTimeSource", + "declaringClassName": "wpilib.FieldObject2d", + "functionName": "setTrajectory", "returnType": "None", - "tooltip": "Sets a new source to provide the clock time in microseconds. Changing this\naffects the return value of ``GetTime``.\n\n:param supplier: Function to return the time in microseconds." + "tooltip": "Sets poses from a trajectory.\n\n:param trajectory: The trajectory from which poses should be added." } - ] + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] }, { - "className": "wpilib.RobotState", + "className": "wpilib.I2C", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "port", + "type": "wpilib.I2C.Port" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "deviceAddress", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.RobotState", + "declaringClassName": "wpilib.I2C", "functionName": "__init__", - "returnType": "wpilib.RobotState", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.I2C", + "tooltip": "Constructor.\n\n:param port: The I2C port to which the device is connected.\n:param deviceAddress: The address of the device on the I2C bus." } ], "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.RobotState", - "functionName": "isAutonomous", - "returnType": "bool", - "tooltip": "Returns true if the robot is in autonomous mode.\n\n:returns: True if the robot is in autonomous mode." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotState", - "functionName": "isDisabled", - "returnType": "bool", - "tooltip": "Returns true if the robot is disabled.\n\n:returns: True if the robot is disabled." - }, - { - "args": [], - "declaringClassName": "wpilib.RobotState", - "functionName": "isEStopped", - "returnType": "bool", - "tooltip": "Returns true if the robot is E-stopped.\n\n:returns: True if the robot is E-stopped." - }, + "instanceMethods": [ { - "args": [], - "declaringClassName": "wpilib.RobotState", - "functionName": "isEnabled", + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.I2C" + } + ], + "declaringClassName": "wpilib.I2C", + "functionName": "addressOnly", "returnType": "bool", - "tooltip": "Returns true if the robot is enabled.\n\n:returns: True if the robot is enabled." + "tooltip": "Attempt to address a device on the I2C bus.\n\nThis allows you to figure out if there is a device on the I2C bus that\nresponds to the address specified in the constructor.\n\n:returns: Transfer Aborted... false for success, true for aborted." }, { - "args": [], - "declaringClassName": "wpilib.RobotState", - "functionName": "isTeleop", - "returnType": "bool", - "tooltip": "Returns true if the robot is in teleop mode.\n\n:returns: True if the robot is in teleop mode." + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.I2C" + } + ], + "declaringClassName": "wpilib.I2C", + "functionName": "getDeviceAddress", + "returnType": "int", + "tooltip": "Returns I2C device address.\n\n:returns: I2C device address." }, - { - "args": [], - "declaringClassName": "wpilib.RobotState", - "functionName": "isTest", - "returnType": "bool", - "tooltip": "Returns true if the robot is in test mode.\n\n:returns: True if the robot is in test mode." - } - ] - }, - { - "className": "wpilib.SD540", - "classVariables": [], - "constructors": [ { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "self", + "type": "wpilib.I2C" } ], - "declaringClassName": "wpilib.SD540", - "functionName": "__init__", - "returnType": "wpilib.SD540", - "tooltip": "Constructor for a SD540 connected via PWM.\n\n:param channel: The PWM channel that the SD540 is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.I2C", + "functionName": "getPort", + "returnType": "wpilib.I2C.Port", + "tooltip": "Returns I2C port.\n\n:returns: I2C port." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.I2C" }, { "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" + "name": "registerAddress", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "data", + "type": "Buffer" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." + "declaringClassName": "wpilib.I2C", + "functionName": "read", + "returnType": "bool", + "tooltip": "Execute a read transaction with the device.\n\nRead bytes from a device.\nMost I2C devices will auto-increment the register pointer internally\nallowing you to read consecutive registers on a device in a single\ntransaction.\n\n:param registerAddress: The register to read first in the transaction.\n:param count: The number of bytes to read in the transaction.\n:param data: A pointer to the array of bytes to store the data\n read from the device.\n\n:returns: Transfer Aborted... false for success, true for aborted." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.I2C" + }, + { + "defaultValue": "", + "name": "buffer", + "type": "Buffer" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + "declaringClassName": "wpilib.I2C", + "functionName": "readOnly", + "returnType": "bool", + "tooltip": "Execute a read only transaction with the device.\n\nRead bytes from a device. This method does not write any data to prompt the\ndevice.\n\n:param buffer: A pointer to the array of bytes to store the data read from\n the device.\n:param count: The number of bytes to read in the transaction.\n\n:returns: Transfer Aborted... false for success, true for aborted." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.I2C" + }, + { + "defaultValue": "", + "name": "dataToSend", + "type": "Buffer" + }, + { + "defaultValue": "", + "name": "dataReceived", + "type": "Buffer" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.I2C", + "functionName": "transaction", + "returnType": "bool", + "tooltip": "Generic transaction.\n\nThis is a lower-level interface to the I2C hardware giving you more control\nover each transaction. If you intend to write multiple bytes in the same\ntransaction and do not plan to receive anything back, use writeBulk()\ninstead. Calling this with a receiveSize of 0 will result in an error.\n\n:param dataToSend: Buffer of data to send as part of the transaction.\n:param sendSize: Number of bytes to send as part of the transaction.\n:param dataReceived: Buffer to read data into.\n:param receiveSize: Number of bytes to read from the device.\n\n:returns: Transfer Aborted... false for success, true for aborted." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.I2C" }, { "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" + "name": "registerAddress", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "expected", + "type": "Buffer" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." + "declaringClassName": "wpilib.I2C", + "functionName": "verifySensor", + "returnType": "bool", + "tooltip": "Verify that a device's registers contain expected values.\n\nMost devices will have a set of registers that contain a known value that\ncan be used to identify them. This allows an I2C device driver to easily\nverify that the device contains the expected value.\n\n@pre The device must support and be configured to use register\nauto-increment.\n\n:param registerAddress: The base register to start reading from the device.\n:param count: The size of the field to be verified.\n:param expected: A buffer containing the values expected from the\n device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.I2C" + }, + { + "defaultValue": "", + "name": "registerAddress", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "data", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." + "declaringClassName": "wpilib.I2C", + "functionName": "write", + "returnType": "bool", + "tooltip": "Execute a write transaction with the device.\n\nWrite a single byte to a register on a device and wait until the\ntransaction is complete.\n\n:param registerAddress: The address of the register on the device to be\n written.\n:param data: The byte to write to the register on the device.\n\n:returns: Transfer Aborted... false for success, true for aborted." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.I2C" + }, + { + "defaultValue": "", + "name": "data", + "type": "Buffer" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." + "declaringClassName": "wpilib.I2C", + "functionName": "writeBulk", + "returnType": "bool", + "tooltip": "Execute a bulk write transaction with the device.\n\nWrite multiple bytes to a device and wait until the\ntransaction is complete.\n\n:param data: The data to write to the register on the device.\n:param count: The number of bytes to be written.\n\n:returns: Transfer Aborted... false for success, true for aborted." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.I2C.Port", + "classVariables": [ + { + "name": "kPort0", + "tooltip": "", + "type": "wpilib.I2C.Port", + "writable": false }, + { + "name": "kPort1", + "tooltip": "", + "type": "wpilib.I2C.Port", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", + "declaringClassName": "wpilib.I2C.Port", + "functionName": "__init__", + "returnType": "wpilib.I2C.Port", "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.IterativeRobotBase", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" + "name": "period", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" - }, + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "__init__", + "returnType": "wpilib.IterativeRobotBase", + "tooltip": "Constructor for IterativeRobotBase.\n\n:param period: Period." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "autonomousExit", + "returnType": "None", + "tooltip": "Exit code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits autonomous mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "autonomousInit", + "returnType": "None", + "tooltip": "Initialization code for autonomous mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters autonomous mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "autonomousPeriodic", + "returnType": "None", + "tooltip": "Periodic code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in\nautonomous mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "disabledExit", "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "tooltip": "Exit code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits disabled mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "disabledInit", + "returnType": "None", + "tooltip": "Initialization code for disabled mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time\nthe robot enters disabled mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "disabledPeriodic", + "returnType": "None", + "tooltip": "Periodic code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in disabled\nmode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "driverStationConnected", "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + "tooltip": "Code that needs to know the DS state should go here.\n\nUsers should override this method for initialization that needs to occur\nafter the DS is connected, such as needing the alliance information." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", + "declaringClassName": "wpilib.RobotBase", + "functionName": "endCompetition", "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "tooltip": "Ends the main loop in StartCompetition()." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.RobotBase", + "functionName": "getControlState", + "returnType": "tuple[bool, bool, bool]", + "tooltip": "More efficient way to determine what state the robot is in.\n\n:returns: booleans representing enabled, isautonomous, istest\n\n.. versionadded:: 2019.2.1\n\n.. note:: This function only exists in RobotPy" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "getPeriod", + "returnType": "wpimath.units.seconds", + "tooltip": "Gets time period between calls to Periodic() functions." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + "declaringClassName": "wpilib.RobotBase", + "functionName": "isAutonomous", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Autonomous mode.\n\n:returns: True if the robot is currently operating Autonomously as determined\n by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.SD540", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.SPI", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.RobotBase", + "functionName": "isAutonomousEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Autonomous mode and enabled.\n\n:returns: True if the robot us currently operating Autonomously while enabled\n as determined by the Driver Station." + }, { "args": [ { "defaultValue": "", - "name": "port", - "type": "wpilib.SPI.Port" + "name": "self", + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "__init__", - "returnType": "wpilib.SPI", - "tooltip": "Constructor\n\n:param port: the physical SPI port" - } - ], - "enums": [ - { - "enumClassName": "wpilib.SPI.Mode", - "enumValues": [ - "kMode0", - "kMode1", - "kMode2", - "kMode3" - ], - "moduleName": "wpilib", - "tooltip": "SPI mode.\n\nMembers:\n\n kMode0 : Clock idle low, data sampled on rising edge.\n\n kMode1 : Clock idle low, data sampled on falling edge.\n\n kMode2 : Clock idle high, data sampled on falling edge.\n\n kMode3 : Clock idle high, data sampled on rising edge." + "declaringClassName": "wpilib.RobotBase", + "functionName": "isDisabled", + "returnType": "bool", + "tooltip": "Determine if the Robot is currently disabled.\n\n:returns: True if the Robot is currently disabled by the Driver Station." }, - { - "enumClassName": "wpilib.SPI.Port", - "enumValues": [ - "kMXP", - "kOnboardCS0", - "kOnboardCS1", - "kOnboardCS2", - "kOnboardCS3" - ], - "moduleName": "wpilib", - "tooltip": "SPI port.\n\nMembers:\n\n kOnboardCS0 : Onboard SPI bus port CS0.\n\n kOnboardCS1 : Onboard SPI bus port CS1.\n\n kOnboardCS2 : Onboard SPI bus port CS2.\n\n kOnboardCS3 : Onboard SPI bus port CS3.\n\n kMXP : MXP (roboRIO MXP) SPI bus port." - } - ], - "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "port", - "type": "hal.SPIPort" - }, - { - "defaultValue": "", - "name": "csToSclkTicks", - "type": "int" - }, + "type": "wpilib.RobotBase" + } + ], + "declaringClassName": "wpilib.RobotBase", + "functionName": "isEnabled", + "returnType": "bool", + "tooltip": "Determine if the Robot is currently enabled.\n\n:returns: True if the Robot is currently enabled by the Driver Station." + }, + { + "args": [ { "defaultValue": "", - "name": "stallTicks", - "type": "int" - }, + "name": "self", + "type": "wpilib.RobotBase" + } + ], + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTeleop", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Operator Control mode.\n\n:returns: True if the robot is currently operating in Tele-Op mode as\n determined by the Driver Station." + }, + { + "args": [ { "defaultValue": "", - "name": "pow2BytesPerRead", - "type": "int" + "name": "self", + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "configureAutoStall", - "returnType": "None", - "tooltip": "Configure the Auto SPI Stall time between reads.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP.\n:param csToSclkTicks: the number of ticks to wait before asserting the cs\n pin\n:param stallTicks: the number of ticks to stall for\n:param pow2BytesPerRead: the number of bytes to read before stalling" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTeleopEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is current in Operator Control mode and enabled.\n\n:returns: True if the robot is currently operating in Tele-Op mode while\n enabled as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "forceAutoRead", - "returnType": "None", - "tooltip": "Force the engine to make a single transfer." + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTest", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Test mode.\n\n:returns: True if the robot is currently running in Test mode as determined\n by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "freeAccumulator", - "returnType": "None", - "tooltip": "Frees the accumulator." + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTestEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is current in Test mode and enabled.\n\n:returns: True if the robot is currently operating in Test mode while\n enabled as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "freeAuto", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "printWatchdogEpochs", "returnType": "None", - "tooltip": "Frees the automatic SPI transfer engine." + "tooltip": "Prints list of epochs added so far and their times." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "getAccumulatorAverage", - "returnType": "float", - "tooltip": "Read the average of the accumulated value.\n\n:returns: The accumulated average value (value / count)." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "robotInit", + "returnType": "None", + "tooltip": "Robot-wide initialization code should go here.\n\nUsers should override this method for default Robot-wide initialization\nwhich will be called when the robot is first powered on. It will be called\nexactly one time.\n\nNote: This method is functionally identical to the class constructor so\nthat should be used instead." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "getAccumulatorCount", - "returnType": "int", - "tooltip": "Read the number of accumulated values.\n\nRead the count of the accumulated values since the accumulator was last\nReset().\n\n:returns: The number of times samples from the channel were accumulated." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "robotPeriodic", + "returnType": "None", + "tooltip": "Periodic code for all modes should go here.\n\nThis function is called each time a new packet is received from the driver\nstation." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.IterativeRobotBase" + }, + { + "defaultValue": "", + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "getAccumulatorIntegratedAverage", - "returnType": "float", - "tooltip": "Read the average of the integrated value. This is the sum of (each value\ntimes the time between values), divided by the count.\n\n:returns: The average of the integrated value accumulated since the last\n Reset()." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "setNetworkTablesFlushEnabled", + "returnType": "None", + "tooltip": "Enables or disables flushing NetworkTables every loop iteration.\nBy default, this is enabled.\n\n:deprecated: Deprecated without replacement.\n\n:param enabled: True to enable, false to disable" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "getAccumulatorIntegratedValue", - "returnType": "float", - "tooltip": "Read the integrated value. This is the sum of (each value * time between\nvalues).\n\n:returns: The integrated value accumulated since the last Reset()." + "declaringClassName": "wpilib.RobotBase", + "functionName": "startCompetition", + "returnType": "None", + "tooltip": "Start the main robot code. This function will be called once and should not\nexit until signalled by EndCompetition()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "getAccumulatorLastValue", - "returnType": "int", - "tooltip": "Read the last value read by the accumulator engine." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "teleopExit", + "returnType": "None", + "tooltip": "Exit code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits teleop mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "getAccumulatorOutput", - "returnType": "tuple[int, int]", - "tooltip": "Read the accumulated value and the number of accumulated values atomically.\n\nThis function reads the value and count atomically.\nThis can be used for averaging.\n\n:param value: Pointer to the 64-bit accumulated output.\n:param count: Pointer to the number of accumulation cycles." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "teleopInit", + "returnType": "None", + "tooltip": "Initialization code for teleop mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters teleop mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "getAccumulatorValue", - "returnType": "int", - "tooltip": "Read the accumulated value.\n\n:returns: The 64-bit value accumulated since the last Reset()." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "teleopPeriodic", + "returnType": "None", + "tooltip": "Periodic code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in teleop\nmode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "getAutoDroppedCount", - "returnType": "int", - "tooltip": "Get the number of bytes dropped by the automatic SPI transfer engine due\nto the receive buffer being full.\n\n:returns: Number of bytes dropped" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "testExit", + "returnType": "None", + "tooltip": "Exit code for test mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits test mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "getPort", - "returnType": "wpilib.SPI.Port", - "tooltip": "Returns the SPI port.\n\n:returns: The SPI port." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "testInit", + "returnType": "None", + "tooltip": "Initialization code for test mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters test mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "period", - "type": "wpimath.units.seconds" - }, - { - "defaultValue": "", - "name": "cmd", - "type": "int" - }, - { - "defaultValue": "", - "name": "xferSize", - "type": "int" - }, - { - "defaultValue": "", - "name": "validMask", - "type": "int" - }, - { - "defaultValue": "", - "name": "validValue", - "type": "int" - }, - { - "defaultValue": "", - "name": "dataShift", - "type": "int" - }, - { - "defaultValue": "", - "name": "dataSize", - "type": "int" - }, - { - "defaultValue": "", - "name": "isSigned", - "type": "bool" - }, - { - "defaultValue": "", - "name": "bigEndian", - "type": "bool" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "initAccumulator", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "testPeriodic", "returnType": "None", - "tooltip": "Initialize the accumulator.\n\n:param period: Time between reads\n:param cmd: SPI command to send to request data\n:param xferSize: SPI transfer size, in bytes\n:param validMask: Mask to apply to received data for validity checking\n:param validValue: After valid_mask is applied, required matching value for\n validity checking\n:param dataShift: Bit shift to apply to received data to get actual data\n value\n:param dataSize: Size (in bits) of data field\n:param isSigned: Is data field signed?\n:param bigEndian: Is device big endian?" + "tooltip": "Periodic code for test mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in test\nmode." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "getRuntimeType", + "returnType": "wpilib.RuntimeType", + "tooltip": "Get the current runtime type.\n\n:returns: Current runtime type." + }, + { + "args": [], + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "isReal", + "returnType": "bool", + "tooltip": "Get if the robot is real.\n\n:returns: If the robot is running in the real world." + }, + { + "args": [], + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "isSimulation", + "returnType": "bool", + "tooltip": "Get if the robot is a simulation.\n\n:returns: If the robot is running in simulation." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "bufferSize", - "type": "int" + "name": "robot_cls", + "type": "object" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "initAuto", - "returnType": "None", - "tooltip": "Initialize automatic SPI transfer engine.\n\nOnly a single engine is available, and use of it blocks use of all other\nchip select usage on the same physical SPI port while it is running.\n\n:param bufferSize: buffer size in bytes" - }, + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "main", + "returnType": "object", + "tooltip": "Starting point for the application" + } + ] + }, + { + "className": "wpilib.Jaguar", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "initiate", - "type": "bool" - }, - { - "defaultValue": "", - "name": "dataReceived", - "type": "Buffer" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "read", - "returnType": "int", - "tooltip": "Read a word from the receive FIFO.\n\nWaits for the current transfer to complete if the receive FIFO is empty.\n\nIf the receive FIFO is empty, there is no active transfer, and initiate\nis false, errors.\n\n:param initiate: If true, this function pushes \"0\" into the transmit\n buffer and initiates a transfer. If false, this\n function assumes that data is already in the receive\n FIFO from a previous write.\n:param dataReceived: Buffer to receive data from the device\n:param size: The length of the transaction, in bytes" - }, + "declaringClassName": "wpilib.Jaguar", + "functionName": "__init__", + "returnType": "wpilib.Jaguar", + "tooltip": "Constructor for a Jaguar connected via PWM.\n\n:param channel: The PWM channel that the Jaguar is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "buffer", - "type": "Buffer" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "timeout", - "type": "wpimath.units.seconds" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "readAutoReceivedData", - "returnType": "int", - "tooltip": "Read data that has been transferred by the automatic SPI transfer engine.\n\nTransfers may be made a byte at a time, so it's necessary for the caller\nto handle cases where an entire transfer has not been completed.\n\nEach received data sequence consists of a timestamp followed by the\nreceived data bytes, one byte per word (in the least significant byte).\nThe length of each received data sequence is the same as the combined\nsize of the data and zeroSize set in SetAutoTransmitData().\n\nBlocks until numToRead words have been read or timeout expires.\nMay be called with numToRead=0 to retrieve how many words are available.\n\n:param buffer: buffer where read words are stored\n:param numToRead: number of words to read\n:param timeout: timeout (ms resolution)\n\n:returns: Number of words remaining to be read" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "resetAccumulator", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", "returnType": "None", - "tooltip": "Resets the accumulator to zero." + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "center", - "type": "int" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "setAccumulatorCenter", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", "returnType": "None", - "tooltip": "Set the center value of the accumulator.\n\nThe center value is subtracted from each value before it is added to the\naccumulator. This is used for the center value of devices like gyros and\naccelerometers to make integration work and to take the device offset into\naccount when integrating." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "deadband", - "type": "int" + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "setAccumulatorDeadband", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", "returnType": "None", - "tooltip": "Set the accumulator's deadband." + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "center", - "type": "float" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "setAccumulatorIntegratedCenter", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", "returnType": "None", - "tooltip": "Set the center value of the accumulator integrator.\n\nThe center value is subtracted from each value*dt before it is added to the\nintegrated value. This is used for the center value of devices like gyros\nand accelerometers to take the device offset into account when integrating." + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "dataToSend", - "type": "Buffer" - }, - { - "defaultValue": "", - "name": "zeroSize", - "type": "int" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "setAutoTransmitData", - "returnType": "None", - "tooltip": "Set the data to be transmitted by the engine.\n\nUp to 16 bytes are configurable, and may be followed by up to 127 zero\nbytes.\n\n:param dataToSend: data to send (maximum 16 bytes)\n:param zeroSize: number of zeros to send after the data" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "setChipSelectActiveHigh", - "returnType": "None", - "tooltip": "Configure the chip select line to be active high." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "setChipSelectActiveLow", - "returnType": "None", - "tooltip": "Configure the chip select line to be active low." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "hz", - "type": "int" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "setClockRate", - "returnType": "None", - "tooltip": "Configure the rate of the generated clock signal.\n\nThe default value is 500,000Hz.\nThe maximum value is 4,000,000Hz.\n\n:param hz: The clock rate in Hertz." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "mode", - "type": "wpilib.SPI.Mode" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "setMode", - "returnType": "None", - "tooltip": "Sets the mode for the SPI device.\n\nMode 0 is Clock idle low, data sampled on rising edge\n\nMode 1 is Clock idle low, data sampled on falling edge\n\nMode 2 is Clock idle high, data sampled on falling edge\n\nMode 3 is Clock idle high, data sampled on rising edge\n\n:param mode: The mode to set." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "period", - "type": "wpimath.units.seconds" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "startAutoRate", - "returnType": "None", - "tooltip": "Start running the automatic SPI transfer engine at a periodic rate.\n\nInitAuto() and SetAutoTransmitData() must be called before calling this\nfunction.\n\n:param period: period between transfers (us resolution)" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" - }, - { - "defaultValue": "", - "name": "rising", - "type": "bool" + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "falling", - "type": "bool" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "startAutoTrigger", + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", "returnType": "None", - "tooltip": "Start running the automatic SPI transfer engine when a trigger occurs.\n\nInitAuto() and SetAutoTransmitData() must be called before calling this\nfunction.\n\n:param source: digital source for the trigger (may be an analog trigger)\n:param rising: trigger on the rising edge\n:param falling: trigger on the falling edge" + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "stopAuto", - "returnType": "None", - "tooltip": "Stop running the automatic SPI transfer engine." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" - }, - { - "defaultValue": "", - "name": "dataToSend", - "type": "Buffer" - }, - { - "defaultValue": "", - "name": "dataReceived", - "type": "Buffer" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "transaction", - "returnType": "int", - "tooltip": "Perform a simultaneous read/write transaction with the device\n\n:param dataToSend: The data to be written out to the device\n:param dataReceived: Buffer to receive data from the device\n:param size: The length of the transaction, in bytes" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SPI" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "data", - "type": "Buffer" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.SPI", - "functionName": "write", - "returnType": "int", - "tooltip": "Write data to the peripheral device. Blocks until there is space in the\noutput FIFO.\n\nIf not running in output only mode, also saves the data received\non the CIPO input during the transfer into the receive FIFO." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.SendableBuilderImpl", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "__init__", - "returnType": "wpilib.SendableBuilderImpl", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "getter", - "type": "Callable[[], list[int]]" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[List[int]], None]" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addBooleanArrayProperty", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", "returnType": "None", - "tooltip": "" + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "getter", - "type": "Callable[[], bool]" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[bool], None]" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addBooleanProperty", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", "returnType": "None", "tooltip": "" }, @@ -24114,457 +7547,461 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "getter", - "type": "Callable[[], list[float]]" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[List[float]], None]" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addDoubleArrayProperty", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", "returnType": "None", - "tooltip": "" + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "getter", - "type": "Callable[[], float]" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[float], None]" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addDoubleProperty", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", "returnType": "None", - "tooltip": "" + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "getter", - "type": "Callable[[], list[float]]" - }, - { - "defaultValue": "", - "name": "setter", - "type": "Callable[[List[float]], None]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addFloatArrayProperty", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", "returnType": "None", "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.Jaguar", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] + }, + { + "className": "wpilib.Joystick", + "classVariables": [ + { + "name": "kDefaultThrottleChannel", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kDefaultTwistChannel", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kDefaultXChannel", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kDefaultYChannel", + "tooltip": "", + "type": "int", + "writable": false }, + { + "name": "kDefaultZChannel", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, + "name": "port", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.Joystick", + "functionName": "__init__", + "returnType": "wpilib.Joystick", + "tooltip": "Construct an instance of a joystick.\n\nThe joystick index is the USB port on the Driver Station.\n\n:param port: The port on the Driver Station that the joystick is plugged\n into (0-5)." + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "getter", - "type": "Callable[[], float]" + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[float], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addFloatProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POV", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "key", - "type": "str" + "name": "pov", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "getter", - "type": "Callable[[], list[int]]" + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[List[int]], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addIntegerArrayProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POV", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "getter", - "type": "Callable[[], int]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[int], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addIntegerProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVCenter", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the center (not pressed) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the center of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "typeString", - "type": "str" - }, - { - "defaultValue": "", - "name": "getter", - "type": "Callable[[], list[int]]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[Buffer], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addRawProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDown", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "getter", - "type": "Callable[[List[int]], List[int]]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[List[int]], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addSmallBooleanArrayProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDownLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down left direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "getter", - "type": "Callable[[List[float]], List[float]]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[List[float]], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } - ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addSmallDoubleArrayProperty", - "returnType": "None", - "tooltip": "" + ], + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDownRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "getter", - "type": "Callable[[List[float]], List[float]]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[List[float]], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addSmallFloatArrayProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the left direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "key", - "type": "str" - }, + "name": "loop", + "type": "wpilib.event.EventLoop" + } + ], + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the right direction of a POV\n on the HID." + }, + { + "args": [ { "defaultValue": "", - "name": "getter", - "type": "Callable[[List[int]], List[int]]" + "name": "self", + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[List[int]], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addSmallIntegerArrayProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUp", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up direction of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up direction of a POV on\n the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "typeString", - "type": "str" - }, + "name": "loop", + "type": "wpilib.event.EventLoop" + } + ], + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUpLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up left direction of a POV\n on the HID." + }, + { + "args": [ { "defaultValue": "", - "name": "getter", - "type": "Callable[[List[int]], Buffer]" + "name": "self", + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[Buffer], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addSmallRawProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUpRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "key", - "type": "str" + "name": "axis", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "getter", - "type": "Callable[[List[str]], List[str]]" + "name": "threshold", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[List[str]], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addSmallStringArrayProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "axisGreaterThan", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance that is true when the axis value is greater\nthan threshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value above which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is greater than\n the provided threshold." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "key", - "type": "str" + "name": "axis", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "getter", - "type": "Callable[[List[str]], str]" + "name": "threshold", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "setter", - "type": "Callable[[str], None]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addSmallStringProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "axisLessThan", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance that is true when the axis value is less than\nthreshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value below which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is less than the\n provided threshold." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "key", - "type": "str" + "name": "button", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "getter", - "type": "Callable[[], list[str]]" - }, + "name": "loop", + "type": "wpilib.event.EventLoop" + } + ], + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "button", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around this button's digital signal.\n\n:param button: the button index\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the button's digital signal attached\n to the given loop." + }, + { + "args": [ { "defaultValue": "", - "name": "setter", - "type": "Callable[[List[str]], None]" + "name": "self", + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addStringArrayProperty", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getAxisCount", + "returnType": "int", + "tooltip": "Get the number of axes for the HID.\n\n:returns: the number of axis for the current HID" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "key", - "type": "str" - }, + "name": "axis", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getAxisType", + "returnType": "int", + "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." + }, + { + "args": [ { "defaultValue": "", - "name": "getter", - "type": "Callable[[], str]" - }, + "name": "self", + "type": "wpilib.interfaces.GenericHID" + } + ], + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getButtonCount", + "returnType": "int", + "tooltip": "Get the number of buttons for the HID.\n\n:returns: the number of buttons on the current HID" + }, + { + "args": [ { "defaultValue": "", - "name": "setter", - "type": "Callable[[str], None]" + "name": "self", + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "addStringProperty", - "returnType": "None", + "declaringClassName": "wpilib.Joystick", + "functionName": "getDirectionDegrees", + "returnType": "wpimath.units.degrees", "tooltip": "" }, { @@ -24572,658 +8009,579 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "clearProperties", - "returnType": "None", - "tooltip": "Clear properties." + "declaringClassName": "wpilib.Joystick", + "functionName": "getDirectionRadians", + "returnType": "wpimath.units.radians", + "tooltip": "Get the direction of the vector formed by the joystick and its origin. 0 is\nforward and clockwise is positive. (Straight right is \u03c0/2 radians or 90\ndegrees.)\n\n:returns: The direction of the vector." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "ntcore.NTSendableBuilder" + "type": "wpilib.Joystick" } ], - "declaringClassName": "ntcore.NTSendableBuilder", - "functionName": "getBackendKind", - "returnType": "wpiutil.SendableBuilder.BackendKind", - "tooltip": "Gets the kind of backend being used.\n\n:returns: Backend kind" + "declaringClassName": "wpilib.Joystick", + "functionName": "getMagnitude", + "returnType": "float", + "tooltip": "Get the magnitude of the vector formed by the joystick's\ncurrent position relative to its origin.\n\n:returns: The magnitude of the direction vector" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "getTable", - "returnType": "ntcore.NetworkTable", - "tooltip": "Get the network table.\n\n:returns: The network table" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getName", + "returnType": "str", + "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" }, { - "defaultValue": "", - "name": "key", - "type": "str" + "defaultValue": "0", + "name": "pov", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "getTopic", - "returnType": "ntcore.Topic", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPOV", + "returnType": "wpilib.DriverStation.POVDirection", + "tooltip": "Get the angle of a POV on the HID.\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "isActuator", - "returnType": "bool", - "tooltip": "Return whether this sendable should be treated as an actuator.\n\n:returns: True if actuator, false if not." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPOVCount", + "returnType": "int", + "tooltip": "Get the number of POVs for the HID.\n\n:returns: the number of POVs for the current HID" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "isPublished", - "returnType": "bool", - "tooltip": "Return whether this sendable has an associated table.\n\n:returns: True if it has a table, false if not." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPort", + "returnType": "int", + "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstBoolean", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawAxis", + "returnType": "float", + "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "value", - "type": "List[int]" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstBooleanArray", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButton", + "returnType": "bool", + "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstDouble", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonPressed", + "returnType": "bool", + "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "value", - "type": "List[float]" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstDoubleArray", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonReleased", + "returnType": "bool", + "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstFloat", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Joystick", + "functionName": "getThrottle", + "returnType": "float", + "tooltip": "Get the throttle value of the current joystick.\n\nThis depends on the mapping of the joystick connected to the current port." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "List[float]" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstFloatArray", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Joystick", + "functionName": "getThrottleChannel", + "returnType": "int", + "tooltip": "Get the channel currently associated with the throttle axis.\n\n:returns: The channel for the axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "int" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstInteger", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Joystick", + "functionName": "getTop", + "returnType": "bool", + "tooltip": "Read the state of the top button on the joystick.\n\nLook up which button has been assigned to the top and read its state.\n\n:returns: The state of the top button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "List[int]" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstIntegerArray", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Joystick", + "functionName": "getTopPressed", + "returnType": "bool", + "tooltip": "Whether the top button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "typeString", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "Buffer" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstRaw", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Joystick", + "functionName": "getTopReleased", + "returnType": "bool", + "tooltip": "Whether the top button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "str" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstString", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Joystick", + "functionName": "getTrigger", + "returnType": "bool", + "tooltip": "Read the state of the trigger on the joystick.\n\nLook up which button has been assigned to the trigger and read its state.\n\n:returns: The state of the trigger." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, + "type": "wpilib.Joystick" + } + ], + "declaringClassName": "wpilib.Joystick", + "functionName": "getTriggerPressed", + "returnType": "bool", + "tooltip": "Whether the trigger was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + }, + { + "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, + "name": "self", + "type": "wpilib.Joystick" + } + ], + "declaringClassName": "wpilib.Joystick", + "functionName": "getTriggerReleased", + "returnType": "bool", + "tooltip": "Whether the trigger was released since the last check.\n\n:returns: Whether the button was released since the last check." + }, + { + "args": [ { "defaultValue": "", - "name": "value", - "type": "List[str]" + "name": "self", + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "publishConstStringArray", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Joystick", + "functionName": "getTwist", + "returnType": "float", + "tooltip": "Get the twist value of the current joystick.\n\nThis depends on the mapping of the joystick connected to the current port." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, + "type": "wpilib.Joystick" + } + ], + "declaringClassName": "wpilib.Joystick", + "functionName": "getTwistChannel", + "returnType": "int", + "tooltip": "Get the channel currently associated with the twist axis.\n\n:returns: The channel for the axis." + }, + { + "args": [ { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "self", + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "setActuator", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getType", + "returnType": "wpilib.interfaces.GenericHID.HIDType", + "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "func", - "type": "Callable[[], None]" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "setSafeState", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Joystick", + "functionName": "getX", + "returnType": "float", + "tooltip": "Get the X value of the current joystick.\n\nThis depends on the mapping of the joystick connected to the current port.\nOn most joysticks, positive is to the right." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "setSmartDashboardType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Joystick", + "functionName": "getXChannel", + "returnType": "int", + "tooltip": "Get the channel currently associated with the X axis.\n\n:returns: The channel for the axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "table", - "type": "ntcore.NetworkTable" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "setTable", - "returnType": "None", - "tooltip": "Set the network table. Must be called prior to any Add* functions being\ncalled.\n\n:param table: Network table" + "declaringClassName": "wpilib.Joystick", + "functionName": "getY", + "returnType": "float", + "tooltip": "Get the Y value of the current joystick.\n\nThis depends on the mapping of the joystick connected to the current port.\nOn most joysticks, positive is to the back." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" - }, - { - "defaultValue": "", - "name": "func", - "type": "Callable[[], None]" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "setUpdateTable", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Joystick", + "functionName": "getYChannel", + "returnType": "int", + "tooltip": "Get the channel currently associated with the Y axis.\n\n:returns: The channel for the axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "startListeners", - "returnType": "None", - "tooltip": "Hook setters for all properties." + "declaringClassName": "wpilib.Joystick", + "functionName": "getZ", + "returnType": "float", + "tooltip": "Get the Z value of the current joystick.\n\nThis depends on the mapping of the joystick connected to the current port." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "startLiveWindowMode", - "returnType": "None", - "tooltip": "Start LiveWindow mode by hooking the setters for all properties. Also\ncalls the SafeState function if one was provided." + "declaringClassName": "wpilib.Joystick", + "functionName": "getZChannel", + "returnType": "int", + "tooltip": "Get the channel currently associated with the Z axis.\n\n:returns: The channel for the axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "stopListeners", - "returnType": "None", - "tooltip": "Unhook setters for all properties." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "isConnected", + "returnType": "bool", + "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "outputNumber", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "stopLiveWindowMode", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setOutput", "returnType": "None", - "tooltip": "Stop LiveWindow mode by unhooking the setters for all properties. Also\ncalls the SafeState function if one was provided." + "tooltip": "Set a single HID output value for the HID.\n\n:param outputNumber: The index of the output to set (1-32)\n:param value: The value to set the output to" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableBuilderImpl" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SendableBuilderImpl", - "functionName": "update", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setOutputs", "returnType": "None", - "tooltip": "Synchronize with network table values by calling the getters for all\nproperties and setters when the network table value has changed." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.SendableChooser", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.SendableChooser", - "functionName": "__init__", - "returnType": "wpilib.SendableChooser", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ + "tooltip": "Set all output values for the HID.\n\n:param value: The 32 bit output value (1 bit for each output)" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableChooser" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "name", - "type": "str" + "name": "type", + "type": "wpilib.interfaces.GenericHID.RumbleType" }, { "defaultValue": "", - "name": "object", - "type": "object" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.SendableChooser", - "functionName": "addOption", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setRumble", "returnType": "None", - "tooltip": "Adds the given object to the list of options.\n\nOn the SmartDashboard on the desktop, the object will appear as the given\nname.\n\n:param name: the name of the option\n:param object: the option" + "tooltip": "Set the rumble output for the HID.\n\nThe DS currently supports 2 rumble values, left rumble and right rumble.\n\n:param type: Which rumble value to set\n:param value: The normalized value (0 to 1) to set the rumble to" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableChooser" + "type": "wpilib.Joystick" + }, + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SendableChooser", - "functionName": "getSelected", - "returnType": "object", - "tooltip": "Returns a copy of the selected option (a std::weak_ptr if T =\nstd::shared_ptr).\n\nIf there is none selected, it will return the default. If there is none\nselected and no default, then it will return a value-initialized instance.\nFor integer types, this is 0. For container types like std::string, this is\nan empty string.\n\n:returns: The option selected" + "declaringClassName": "wpilib.Joystick", + "functionName": "setThrottleChannel", + "returnType": "None", + "tooltip": "Set the channel associated with the throttle axis.\n\n:param channel: The channel to set the axis to." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableChooser" + "type": "wpilib.Joystick" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SendableChooser", - "functionName": "initSendable", + "declaringClassName": "wpilib.Joystick", + "functionName": "setTwistChannel", "returnType": "None", - "tooltip": "" + "tooltip": "Set the channel associated with the twist axis.\n\n:param channel: The channel to set the axis to." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableChooser" + "type": "wpilib.Joystick" }, { "defaultValue": "", - "name": "listener", - "type": "Callable[[object], None]" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SendableChooser", - "functionName": "onChange", + "declaringClassName": "wpilib.Joystick", + "functionName": "setXChannel", "returnType": "None", - "tooltip": "Bind a listener that's called when the selected value changes.\nOnly one listener can be bound. Calling this function will replace the\nprevious listener.\n\n:param listener: The function to call that accepts the new value" + "tooltip": "Set the channel associated with the X axis.\n\n:param channel: The channel to set the axis to." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SendableChooser" + "type": "wpilib.Joystick" }, { "defaultValue": "", - "name": "name", - "type": "str" + "name": "channel", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.Joystick", + "functionName": "setYChannel", + "returnType": "None", + "tooltip": "Set the channel associated with the Y axis.\n\n:param channel: The channel to set the axis to." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.Joystick" }, { "defaultValue": "", - "name": "object", - "type": "object" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SendableChooser", - "functionName": "setDefaultOption", + "declaringClassName": "wpilib.Joystick", + "functionName": "setZChannel", "returnType": "None", - "tooltip": "Add the given object to the list of options and marks it as the default.\n\nFunctionally, this is very close to AddOption() except that it will use\nthis as the default option if none other is explicitly selected.\n\n:param name: the name of the option\n:param object: the option" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.SendableChooserBase", - "classVariables": [], - "constructors": [ + "tooltip": "Set the channel associated with the Z axis.\n\n:param channel: The channel to set the axis to." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "self", + "type": "wpilib.Joystick" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.SendableChooserBase", - "functionName": "__init__", - "returnType": "wpilib.SendableChooserBase", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.Joystick", + "functionName": "top", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the top button's digital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the top button's digital signal\n attached to the given loop." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpiutil.Sendable" + "type": "wpilib.Joystick" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "declaringClassName": "wpilib.Joystick", + "functionName": "trigger", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the trigger button's digital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the trigger button's digital signal\n attached to the given loop." } ], "instanceVariables": [], @@ -25231,499 +8589,472 @@ "staticMethods": [] }, { - "className": "wpilib.SensorUtil", - "classVariables": [], + "className": "wpilib.Joystick.AxisType", + "classVariables": [ + { + "name": "kThrottleAxis", + "tooltip": "", + "type": "wpilib.Joystick.AxisType", + "writable": false + }, + { + "name": "kTwistAxis", + "tooltip": "", + "type": "wpilib.Joystick.AxisType", + "writable": false + }, + { + "name": "kXAxis", + "tooltip": "", + "type": "wpilib.Joystick.AxisType", + "writable": false + }, + { + "name": "kYAxis", + "tooltip": "", + "type": "wpilib.Joystick.AxisType", + "writable": false + }, + { + "name": "kZAxis", + "tooltip": "", + "type": "wpilib.Joystick.AxisType", + "writable": false + } + ], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SensorUtil", + "declaringClassName": "wpilib.Joystick.AxisType", "functionName": "__init__", - "returnType": "wpilib.SensorUtil", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.Joystick.AxisType", + "tooltip": "" } ], "enums": [], "instanceMethods": [], - "instanceVariables": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], "moduleName": "wpilib", - "staticMethods": [ + "staticMethods": [] + }, + { + "className": "wpilib.Joystick.ButtonType", + "classVariables": [ + { + "name": "kTopButton", + "tooltip": "", + "type": "wpilib.Joystick.ButtonType", + "writable": false + }, + { + "name": "kTriggerButton", + "tooltip": "", + "type": "wpilib.Joystick.ButtonType", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "checkAnalogInputChannel", - "returnType": "bool", - "tooltip": "Check that the analog input number is value.\n\nVerify that the analog input number is one of the legal channel numbers.\nChannel numbers are 0-based.\n\n:returns: Analog channel is valid" + "declaringClassName": "wpilib.Joystick.ButtonType", + "functionName": "__init__", + "returnType": "wpilib.Joystick.ButtonType", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.Koors40", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "checkAnalogOutputChannel", - "returnType": "bool", - "tooltip": "Check that the analog output number is valid.\n\nVerify that the analog output number is one of the legal channel numbers.\nChannel numbers are 0-based.\n\n:returns: Analog channel is valid" - }, + "declaringClassName": "wpilib.Koors40", + "functionName": "__init__", + "returnType": "wpilib.Koors40", + "tooltip": "Constructor for a Koors40 connected via PWM.\n\n:param channel: The PWM channel that the Koors40 is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "self", + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "checkDigitalChannel", - "returnType": "bool", - "tooltip": "Check that the digital channel number is valid.\n\nVerify that the channel number is one of the legal channel numbers. Channel\nnumbers are 0-based.\n\n:returns: Digital channel is valid" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "self", + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "checkPWMChannel", - "returnType": "bool", - "tooltip": "Check that the digital channel number is valid.\n\nVerify that the channel number is one of the legal channel numbers. Channel\nnumbers are 0-based.\n\n:returns: PWM channel is valid" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "checkRelayChannel", - "returnType": "bool", - "tooltip": "Check that the relay channel number is valid.\n\nVerify that the channel number is one of the legal channel numbers. Channel\nnumbers are 0-based.\n\n:returns: Relay channel is valid" - }, - { - "args": [], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "getDefaultCTREPCMModule", - "returnType": "int", - "tooltip": "Get the number of the default solenoid module.\n\n:returns: The number of the default solenoid module." - }, - { - "args": [], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "getDefaultREVPHModule", - "returnType": "int", - "tooltip": "Get the number of the default solenoid module.\n\n:returns: The number of the default solenoid module." - }, - { - "args": [], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "getNumAnalogInputs", - "returnType": "int", - "tooltip": "" - }, - { - "args": [], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "getNumAnalogOuputs", - "returnType": "int", - "tooltip": "" - }, - { - "args": [], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "getNumDigitalChannels", - "returnType": "int", - "tooltip": "" - }, - { - "args": [], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "getNumPwmChannels", - "returnType": "int", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", + "returnType": "None", "tooltip": "" }, - { - "args": [], - "declaringClassName": "wpilib.SensorUtil", - "functionName": "getNumRelayChannels", - "returnType": "int", - "tooltip": "" - } - ] - }, - { - "className": "wpilib.SerialPort", - "classVariables": [], - "constructors": [ { "args": [ { "defaultValue": "", - "name": "baudRate", - "type": "int" - }, - { - "defaultValue": "", - "name": "port", - "type": "wpilib.SerialPort.Port" - }, - { - "defaultValue": "8", - "name": "dataBits", - "type": "int" - }, - { - "defaultValue": "", - "name": "parity", - "type": "wpilib.SerialPort.Parity" + "name": "self", + "type": "wpilib.PWMMotorController" }, { - "defaultValue": "", - "name": "stopBits", - "type": "wpilib.SerialPort.StopBits" + "defaultValue": "", + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "__init__", - "returnType": "wpilib.SerialPort", - "tooltip": "Create an instance of a Serial Port class.\n\n:param baudRate: The baud rate to configure the serial port.\n:param port: The physical port to use\n:param dataBits: The number of data bits per transfer. Valid values are\n between 5 and 8 bits.\n:param parity: Select the type of parity checking to use.\n:param stopBits: The number of stop bits to use as defined by the enum\n StopBits." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", + "returnType": "None", + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", - "name": "baudRate", - "type": "int" - }, - { - "defaultValue": "", - "name": "portName", - "type": "str" - }, - { - "defaultValue": "", - "name": "port", - "type": "wpilib.SerialPort.Port" - }, - { - "defaultValue": "8", - "name": "dataBits", - "type": "int" - }, - { - "defaultValue": "", - "name": "parity", - "type": "wpilib.SerialPort.Parity" - }, - { - "defaultValue": "", - "name": "stopBits", - "type": "wpilib.SerialPort.StopBits" - } - ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "__init__", - "returnType": "wpilib.SerialPort", - "tooltip": "Create an instance of a Serial Port class.\n\nPrefer to use the constructor that doesn't take a port name, but in some\ncases the automatic detection might not work correctly.\n\n:param baudRate: The baud rate to configure the serial port.\n:param port: The physical port to use\n:param portName: The direct port name to use\n:param dataBits: The number of data bits per transfer. Valid values are\n between 5 and 8 bits.\n:param parity: Select the type of parity checking to use.\n:param stopBits: The number of stop bits to use as defined by the enum\n StopBits." - } - ], - "enums": [ - { - "enumClassName": "wpilib.SerialPort.FlowControl", - "enumValues": [ - "kFlowControl_DtrDsr", - "kFlowControl_None", - "kFlowControl_RtsCts", - "kFlowControl_XonXoff" - ], - "moduleName": "wpilib", - "tooltip": "Represents what type of flow control to use for serial communication.\n\nMembers:\n\n kFlowControl_None : No flow control.\n\n kFlowControl_XonXoff : XON/XOFF flow control.\n\n kFlowControl_RtsCts : RTS/CTS flow control.\n\n kFlowControl_DtrDsr : DTS/DSR flow control." - }, - { - "enumClassName": "wpilib.SerialPort.Parity", - "enumValues": [ - "kParity_Even", - "kParity_Mark", - "kParity_None", - "kParity_Odd", - "kParity_Space" + "name": "self", + "type": "wpilib.MotorSafety" + } ], - "moduleName": "wpilib", - "tooltip": "Represents the parity to use for serial communications.\n\nMembers:\n\n kParity_None : No parity.\n\n kParity_Odd : Odd parity.\n\n kParity_Even : Even parity.\n\n kParity_Mark : Parity bit always on.\n\n kParity_Space : Parity bit always off." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { - "enumClassName": "wpilib.SerialPort.Port", - "enumValues": [ - "kMXP", - "kOnboard", - "kUSB", - "kUSB1", - "kUSB2" + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PWMMotorController" + } ], - "moduleName": "wpilib", - "tooltip": "Serial port.\n\nMembers:\n\n kOnboard : Onboard serial port on the roboRIO.\n\n kMXP : MXP (roboRIO MXP) serial port.\n\n kUSB : USB serial port (same as kUSB1).\n\n kUSB1 : USB serial port 1.\n\n kUSB2 : USB serial port 2." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { - "enumClassName": "wpilib.SerialPort.StopBits", - "enumValues": [ - "kStopBits_One", - "kStopBits_OnePointFive", - "kStopBits_Two" + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PWMMotorController" + } ], - "moduleName": "wpilib", - "tooltip": "Represents the number of stop bits to use for Serial Communication.\n\nMembers:\n\n kStopBits_One : One stop bit.\n\n kStopBits_OnePointFive : One and a half stop bits.\n\n kStopBits_Two : Two stop bits." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, - { - "enumClassName": "wpilib.SerialPort.WriteBufferMode", - "enumValues": [ - "kFlushOnAccess", - "kFlushWhenFull" - ], - "moduleName": "wpilib", - "tooltip": "Represents which type of buffer mode to use when writing to a serial port.\n\nMembers:\n\n kFlushOnAccess : Flush the buffer on each access.\n\n kFlushWhenFull : Flush the buffer when it is full." - } - ], - "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "disableTermination", - "returnType": "None", - "tooltip": "Disable termination behavior." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" - }, - { - "defaultValue": "'\\n'", - "name": "terminator", - "type": "str" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "enableTermination", - "returnType": "None", - "tooltip": "Enable termination and specify the termination character.\n\nTermination is currently only implemented for receive.\nWhen the the terminator is received, the Read() or Scanf() will return\nfewer bytes than requested, stopping after the terminator.\n\n:param terminator: The character to use for termination." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "flush", - "returnType": "None", - "tooltip": "Force the output buffer to be written to the port.\n\nThis is used when SetWriteBufferMode() is set to kFlushWhenFull to force a\nflush before the buffer is full." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "getBytesReceived", - "returnType": "int", - "tooltip": "Get the number of bytes currently available to read from the serial port.\n\n:returns: The number of bytes available to read" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "buffer", - "type": "Buffer" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "read", - "returnType": "int", - "tooltip": "Read raw bytes out of the buffer.\n\n:param buffer: Pointer to the buffer to store the bytes in.\n:param count: The maximum number of bytes to read.\n\n:returns: The number of bytes actually read into the buffer." + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "reset", - "returnType": "None", - "tooltip": "Reset the serial port driver to a known state.\n\nEmpty the transmit and receive buffers in the device and formatted I/O." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" - }, - { - "defaultValue": "", - "name": "flowControl", - "type": "wpilib.SerialPort.FlowControl" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "setFlowControl", - "returnType": "None", - "tooltip": "Set the type of flow control to enable on this port.\n\nBy default, flow control is disabled." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "size", - "type": "int" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "setReadBufferSize", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", "returnType": "None", - "tooltip": "Specify the size of the input buffer.\n\nSpecify the amount of data that can be stored before data\nfrom the device is returned to Read or Scanf. If you want\ndata that is received to be returned immediately, set this to 1.\n\nIt the buffer is not filled before the read timeout expires, all\ndata that has been received so far will be returned.\n\n:param size: The read buffer size." + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "timeout", + "name": "expirationTime", "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "setTimeout", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", "returnType": "None", - "tooltip": "Configure the timeout of the serial port.\n\nThis defines the timeout for transactions with the hardware.\nIt will affect reads and very large writes.\n\n:param timeout: The time to wait for I/O." + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "mode", - "type": "wpilib.SerialPort.WriteBufferMode" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "setWriteBufferMode", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", "returnType": "None", - "tooltip": "Specify the flushing behavior of the output buffer.\n\nWhen set to kFlushOnAccess, data is synchronously written to the serial\nport after each call to either Printf() or Write().\n\nWhen set to kFlushWhenFull, data will only be written to the serial port\nwhen the buffer is full or when Flush() is called.\n\n:param mode: The write buffer mode." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "size", - "type": "int" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "setWriteBufferSize", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", "returnType": "None", - "tooltip": "Specify the size of the output buffer.\n\nSpecify the amount of data that can be stored before being\ntransmitted to the device.\n\n:param size: The write buffer size." + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SerialPort" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "buffer", - "type": "Buffer" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.SerialPort", - "functionName": "write", - "returnType": "int", - "tooltip": "Write raw bytes to the buffer.\n\n:param buffer: Pointer to the buffer to read the bytes from.\n:param count: The maximum number of bytes to write.\n\n:returns: The number of bytes actually written into the port." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PWMMotorController" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "" } ], "instanceVariables": [], "moduleName": "wpilib", - "staticMethods": [] + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.Koors40", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] }, { - "className": "wpilib.Servo", + "className": "wpilib.LEDPattern", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "impl", + "type": "Callable[[wpilib.LEDPattern.LEDReader, Callable[[typing.SupportsInt, wpilib.Color], None]], None]" } ], - "declaringClassName": "wpilib.Servo", + "declaringClassName": "wpilib.LEDPattern", "functionName": "__init__", - "returnType": "wpilib.Servo", - "tooltip": "Constructor.\n\nBy default, 2.4 ms is used as the max PWM value and 0.6 ms is used as the\nmin PWM value.\n\n:param channel: The PWM channel to which the servo is attached. 0-9 are\n on-board, 10-19 are on the MXP port" + "returnType": "wpilib.LEDPattern", + "tooltip": "" } ], "enums": [], @@ -25733,376 +9064,479 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.PWM" + "type": "wpilib.LEDPattern" }, { "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" + "name": "reader", + "type": "wpilib.LEDPattern.LEDReader" + }, + { + "defaultValue": "", + "name": "writer", + "type": "Callable[[typing.SupportsInt, wpilib.Color], None]" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "enableDeadbandElimination", + "declaringClassName": "wpilib.LEDPattern", + "functionName": "applyTo", "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Servo" + "type": "wpilib.LEDPattern" + }, + { + "defaultValue": "", + "name": "data", + "type": "List[wpilib.AddressableLED.LEDData]" + }, + { + "defaultValue": "", + "name": "writer", + "type": "Callable[[typing.SupportsInt, wpilib.Color], None]" } ], - "declaringClassName": "wpilib.Servo", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the servo position.\n\nServo values range from 0.0 to 1.0 corresponding to the range of full left\nto full right. This returns the commanded position, not the position that\nthe servo is actually at, as the servo does not report its own position.\n\n:returns: Position from 0.0 to 1.0." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "applyTo", + "returnType": "None", + "tooltip": "Writes the pattern to an LED buffer. Dynamic animations should be called\nperiodically (such as with a command or with a periodic method) to refresh\nthe buffer over time.\n\nThis method is intentionally designed to use separate objects for reading\nand writing data. By splitting them up, we can easily modify the behavior\nof some base pattern to make it scroll, blink, or breathe by intercepting\nthe data writes to transform their behavior to whatever we like.\n\n:param data: the current data of the LED strip\n:param writer: data writer for setting new LED colors on the LED strip" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Servo" + "type": "wpilib.LEDPattern" + }, + { + "defaultValue": "", + "name": "data", + "type": "List[wpilib.AddressableLED.LEDData]" } ], - "declaringClassName": "wpilib.Servo", - "functionName": "getAngle", - "returnType": "float", - "tooltip": "Get the servo angle.\n\nThis returns the commanded angle, not the angle that the servo is actually\nat, as the servo does not report its own angle.\n\n:returns: The angle in degrees to which the servo is set." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "applyTo", + "returnType": "None", + "tooltip": "Writes the pattern to an LED buffer. Dynamic animations should be called\nperiodically (such as with a command or with a periodic method) to refresh\nthe buffer over time.\n\nThis method is intentionally designed to use separate objects for reading\nand writing data. By splitting them up, we can easily modify the behavior\nof some base pattern to make it scroll, blink, or breathe by intercepting\nthe data writes to transform their behavior to whatever we like.\n\n:param data: the current data of the LED strip" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "max", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "deadbandMax", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "center", - "type": "wpimath.units.microseconds" - }, - { - "defaultValue": "", - "name": "deadbandMin", - "type": "wpimath.units.microseconds" + "type": "wpilib.LEDPattern" }, { "defaultValue": "", - "name": "min", - "type": "wpimath.units.microseconds" + "name": "relativeBrightness", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "getBounds", - "returnType": "None", - "tooltip": "Get the bounds on the PWM values.\n\nThis gets the bounds on the PWM values for a particular each type of\ncontroller. The values determine the upper and lower speeds as well as the\ndeadband bracket.\n\n:param max: The maximum pwm value\n:param deadbandMax: The high end of the deadband range\n:param center: The center speed (off)\n:param deadbandMin: The low end of the deadband range\n:param min: The minimum pwm value" + "declaringClassName": "wpilib.LEDPattern", + "functionName": "atBrightness", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that plays this one, but at a different brightness.\nBrightness multipliers are applied per-channel in the RGB space; no HSL or\nHSV conversions are applied. Multipliers are also uncapped, which may\nresult in the original colors washing out and appearing less saturated or\neven just a bright white.\n\nThis method is predominantly intended for dimming LEDs to avoid\npainfully bright or distracting patterns from playing (apologies to the\n2024 NE Greater Boston field staff).\n\nFor example, dimming can be done simply by adding a call to\n`atBrightness` at the end of a pattern:\n\n::\n\n // Solid red, but at 50% brightness\n frc::LEDPattern::Solid(frc::Color::kRed).AtBrightness(0.5);\n \n // Solid white, but at only 10% (i.e. ~0.5V)\n frc::LEDPattern::Solid(frc:Color::kWhite).AtBrightness(0.1);\n\n:param relativeBrightness: the multiplier to apply to all channels to modify\n brightness\n\n:returns: the input pattern, displayed at" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWM" + "type": "wpilib.LEDPattern" + }, + { + "defaultValue": "", + "name": "other", + "type": "wpilib.LEDPattern" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" + "declaringClassName": "wpilib.LEDPattern", + "functionName": "blend", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that displays outputs as a combination of this pattern\nand another. Color values are calculated as the average color of both\npatterns; if both patterns set the same LED to the same color, then it is\nset to that color, but if one pattern sets to one color and the other\npattern sets it to off, then it will show the color of the first pattern\nbut at approximately half brightness. This is different from {@link\nLEDPattern::OverlayOn(const LEDPattern&)}, which will show the base pattern\nat full brightness if the overlay is set to off at that position.\n\n:param other: the pattern to blend with\n\n:returns: the blended pattern" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Servo" + "type": "wpilib.LEDPattern" + }, + { + "defaultValue": "", + "name": "onTime", + "type": "wpimath.units.seconds" + }, + { + "defaultValue": "", + "name": "offTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.Servo", - "functionName": "getMaxAngle", - "returnType": "float", - "tooltip": "Get the maximum angle of the servo.\n\n:returns: The maximum angle of the servo in degrees." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "blink", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that switches between playing this pattern and turning\nthe entire LED strip off.\n\n:param onTime: how long the pattern should play for, per cycle\n:param offTime: how long the pattern should be turned off for, per cycle\n\n:returns: the blinking pattern" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Servo" + "type": "wpilib.LEDPattern" + }, + { + "defaultValue": "", + "name": "onTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.Servo", - "functionName": "getMinAngle", - "returnType": "float", - "tooltip": "Get the minimum angle of the servo.\n\n:returns: The minimum angle of the servo in degrees." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "blink", + "returnType": "wpilib.LEDPattern", + "tooltip": "Like {@link LEDPattern::Blink(units::second_t)}, but where the\n\"off\" time is exactly equal to the \"on\" time.\n\n:param onTime: how long the pattern should play for (and be turned off for),\n per cycle\n\n:returns: the blinking pattern" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWM" + "type": "wpilib.LEDPattern" + }, + { + "defaultValue": "", + "name": "period", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "getPosition", - "returnType": "float", - "tooltip": "Get the PWM value in terms of a position.\n\nThis is intended to be used by servos.\n\n@pre SetBounds() called.\n\n:returns: The position the servo is set to between 0.0 and 1.0." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "breathe", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that brightens and dims this one over time. Brightness\nfollows a sinusoidal pattern.\n\n:param period: how fast the breathing pattern should complete a single cycle\n\n:returns: the breathing pattern" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWM" + "type": "wpilib.LEDPattern" + }, + { + "defaultValue": "", + "name": "indexMapper", + "type": "Callable[[typing.SupportsInt, typing.SupportsInt], int]" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "getPulseTime", - "returnType": "wpimath.units.microseconds", - "tooltip": "Get the PWM pulse time directly from the hardware.\n\nRead a microsecond value from a PWM channel.\n\n:returns: Microsecond PWM control value." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "mapIndex", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern with remapped indices.\n\n:param indexMapper: the index mapper\n\n:returns: the mapped pattern" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWM" + "type": "wpilib.LEDPattern" + }, + { + "defaultValue": "", + "name": "mask", + "type": "wpilib.LEDPattern" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "getSpeed", - "returnType": "float", - "tooltip": "Get the PWM value in terms of speed.\n\nThis is intended to be used by motor controllers.\n\n@pre SetBounds() called.\n\n:returns: The most recently set speed between -1.0 and 1.0." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "mask", + "returnType": "wpilib.LEDPattern", + "tooltip": "Similar to {@link LEDPattern::Blend(const LEDPattern&)}, but performs a\nbitwise mask on each color channel rather than averaging the colors for\neach LED. This can be helpful for displaying only a portion of the base\npattern by applying a mask that sets the desired area to white, and all\nother areas to black. However, it can also be used to display only certain\ncolor channels or hues; for example, masking with {@code\nLEDPattern.color(Color.kRed)} will turn off the green and blue channels on\nthe output pattern, leaving only the red LEDs to be illuminated.\n\n:param mask: the mask to apply\n\n:returns: the masked pattern" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Servo" + "type": "wpilib.LEDPattern" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "offset", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.Servo", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.LEDPattern", + "functionName": "offsetBy", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that displays this one, but offset by a certain number of\nLEDs. The offset pattern will wrap around, if necessary.\n\n:param offset: how many LEDs to offset by\n\n:returns: the offset pattern" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Servo" + "type": "wpilib.LEDPattern" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "base", + "type": "wpilib.LEDPattern" } ], - "declaringClassName": "wpilib.Servo", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the servo position.\n\nServo values range from 0.0 to 1.0 corresponding to the range of full left\nto full right.\n\n:param value: Position from 0.0 to 1.0." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "overlayOn", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that plays this pattern overlaid on another. Anywhere\nthis pattern sets an LED to off (or {@link frc::Color::kBlack}), the base\npattern will be displayed instead.\n\n:param base: the base pattern to overlay on top of\n\n:returns: the combined overlay pattern" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWM" + "type": "wpilib.LEDPattern" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "setAlwaysHighMode", - "returnType": "None", - "tooltip": "Sets the PWM output to be a continuous high signal while enabled." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "reversed", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that displays this one in reverse. Scrolling patterns\nwill scroll in the opposite direction (but at the same speed). It will\ntreat the end of an LED strip as the start, and the start of the strip as\nthe end. This can be useful for making ping-pong patterns that travel from\none end of an LED strip to the other, then reverse direction and move back\nto the start. This can also be useful when working with LED strips\nconnected in a serpentine pattern (where the start of one strip is\nconnected to the end of the previous one).\n\n:returns: the reverse pattern" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Servo" + "type": "wpilib.LEDPattern" }, { "defaultValue": "", - "name": "angle", - "type": "float" + "name": "velocity", + "type": "wpimath.units.meters_per_second" + }, + { + "defaultValue": "", + "name": "ledSpacing", + "type": "wpimath.units.meters" } ], - "declaringClassName": "wpilib.Servo", - "functionName": "setAngle", - "returnType": "None", - "tooltip": "Set the servo angle.\n\nThe angles are based on the HS-322HD Servo, and have a range of 0 to 180\ndegrees.\n\nServo angles that are out of the supported range of the servo simply\n\"saturate\" in that direction. In other words, if the servo has a range of\n(X degrees to Y degrees) than angles of less than X result in an angle of\nX being set and angles of more than Y degrees result in an angle of Y being\nset.\n\n:param angle: The angle in degrees to set the servo." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "scrollAtAbsoluteSpeed", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that plays this one scrolling up an LED strip. A negative\nvelocity makes the pattern play in reverse.\n\nFor example, scrolling a pattern at 4 inches per second along an LED\nstrip with 60 LEDs per meter:\n\n::\n\n // LEDs per meter, a known value taken from the spec sheet of our\n particular LED strip units::meter_t LED_SPACING = units::meter_t{1 /60.0};\n \n frc::LEDPattern rainbow = frc::LEDPattern::Rainbow();\n frc::LEDPattern scrollingRainbow =\n rainbow.ScrollAtAbsoluteSpeed(units::feet_per_second_t{1 / 3.0},\n LED_SPACING);\n\nNote that this pattern will scroll *faster* if applied to a less\ndense LED strip (such as 30 LEDs per meter), or *slower* if applied to\na denser LED strip (such as 120 or 144 LEDs per meter).\n\n:param velocity: how fast the pattern should move along a physical LED strip\n:param ledSpacing: the distance between adjacent LEDs on the physical LED\n strip\n\n:returns: the scrolling pattern" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWM" + "type": "wpilib.LEDPattern" }, { "defaultValue": "", - "name": "max", - "type": "wpimath.units.microseconds" - }, + "name": "velocity", + "type": "wpimath.units.hertz" + } + ], + "declaringClassName": "wpilib.LEDPattern", + "functionName": "scrollAtRelativeSpeed", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that plays this one scrolling up the buffer. The velocity\ncontrols how fast the pattern returns back to its original position, and is\nin terms of the length of the LED strip; scrolling across a segment that is\n10 LEDs long will travel twice as fast as on a segment that's only 5 LEDs\nlong (assuming equal LED density on both segments)." + }, + { + "args": [ { "defaultValue": "", - "name": "deadbandMax", - "type": "wpimath.units.microseconds" + "name": "self", + "type": "wpilib.LEDPattern" }, { "defaultValue": "", - "name": "center", - "type": "wpimath.units.microseconds" - }, + "name": "signal", + "type": "Callable[[], bool]" + } + ], + "declaringClassName": "wpilib.LEDPattern", + "functionName": "synchronizedBlink", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that blinks this one on and off in sync with a true/false\nsignal. The pattern will play while the signal outputs ``true``, and\nwill turn off while the signal outputs\n``false``.\n\n:param signal: the signal to synchronize with\n\n:returns: the blinking pattern" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [ { "defaultValue": "", - "name": "deadbandMin", - "type": "wpimath.units.microseconds" + "name": "type", + "type": "wpilib.LEDPattern.GradientType" }, { "defaultValue": "", - "name": "min", - "type": "wpimath.units.microseconds" + "name": "colors", + "type": "List[wpilib.Color]" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "setBounds", - "returnType": "None", - "tooltip": "Set the bounds on the PWM pulse widths.\n\nThis sets the bounds on the PWM values for a particular type of controller.\nThe values determine the upper and lower speeds as well as the deadband\nbracket.\n\n:param max: The max PWM pulse width in us\n:param deadbandMax: The high end of the deadband range pulse width in us\n:param center: The center (off) pulse width in us\n:param deadbandMin: The low end of the deadband pulse width in us\n:param min: The minimum pulse width in us" + "declaringClassName": "wpilib.LEDPattern", + "functionName": "gradient", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that displays a non-animated gradient of colors across\nthe entire length of the LED strip. Colors are evenly distributed along the\nfull length of the LED strip. The gradient type is configured with the\n``type`` parameter, allowing the gradient to be either continuous (no\nseams, good for scrolling effects) or discontinuous (a clear seam is\nvisible, but the gradient applies to the full length of the LED strip\nwithout needing to use some space for wrapping).\n\n:param type: the type of gradient (continuous or discontinuous)\n:param colors: the colors to display in the gradient\n\n:returns: a motionless gradient pattern" + }, + { + "args": [], + "declaringClassName": "wpilib.LEDPattern", + "functionName": "off", + "returnType": "wpilib.LEDPattern", + "tooltip": "A pattern that turns off all LEDs." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" + "name": "progressFunction", + "type": "Callable[[], float]" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "setDisabled", - "returnType": "None", - "tooltip": "Temporarily disables the PWM output. The next set call will re-enable\nthe output." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "progressMaskLayer", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that works as a mask layer for {@link\nLEDPattern::Mask(const LEDPattern&)} that illuminates only the portion of\nthe LED strip corresponding with some progress. The mask pattern will start\nfrom the base and set LEDs to white at a proportion equal to the progress\nreturned by the function. Some usages for this could be for displaying\nprogress of a flywheel to its target velocity, progress of a complex\nautonomous sequence, or the height of an elevator.\n\nFor example, creating a mask for displaying a red-to-blue gradient,\nstarting from the red end, based on where an elevator is in its range of\ntravel.\n\n::\n\n frc::LEDPattern basePattern =\n frc::LEDPattern::Gradient(frc::Color::kRed, frc::Color::kBlue);\n frc::LEDPattern progressPattern =\n basePattern.Mask(frc::LEDPattern::ProgressMaskLayer([&]() {\n return elevator.GetHeight() / elevator.MaxHeight();\n });\n\n:param progressFunction: the function to call to determine the progress.\n This should return values in the range [0, 1]; any values outside that\n range will be clamped.\n\n:returns: the mask pattern" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.Servo" + "name": "saturation", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.Servo", - "functionName": "setOffline", - "returnType": "None", - "tooltip": "Set the servo to offline.\n\nSet the servo raw value to 0 (undriven)" + "declaringClassName": "wpilib.LEDPattern", + "functionName": "rainbow", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates an LED pattern that displays a rainbow across the color wheel. The\nrainbow pattern will stretch across the entire length of the LED strip.\n\n:param saturation: the saturation of the HSV colors, in [0, 255]\n:param value: the value of the HSV colors, in [0, 255]\n\n:returns: the rainbow pattern" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "mult", - "type": "wpilib.PWM.PeriodMultiplier" + "name": "color", + "type": "wpilib.Color" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "setPeriodMultiplier", - "returnType": "None", - "tooltip": "Slow down the PWM signal for old devices.\n\n:param mult: The period multiplier to apply to this channel" + "declaringClassName": "wpilib.LEDPattern", + "functionName": "solid", + "returnType": "wpilib.LEDPattern", + "tooltip": "Creates a pattern that displays a single static color along the entire\nlength of the LED strip.\n\n:param color: the color to display\n\n:returns: the pattern" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "pos", - "type": "float" + "name": "steps", + "type": "List[tuple[typing.SupportsFloat, wpilib.Color]]" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "setPosition", - "returnType": "None", - "tooltip": "Set the PWM value based on a position.\n\nThis is intended to be used by servos.\n\n@pre SetBounds() called.\n\n:param pos: The position to set the servo between 0.0 and 1.0." + "declaringClassName": "wpilib.LEDPattern", + "functionName": "steps", + "returnType": "wpilib.LEDPattern", + "tooltip": "Display a set of colors in steps across the length of the LED strip. No\ninterpolation is done between colors. Colors are specified by the first LED\non the strip to show that color. The last color in the map will be\ndisplayed all the way to the end of the strip. LEDs positioned before the\nfirst specified step will be turned off (you can think of this as if\nthere's a 0 -> black step by default).\n\n:param steps: a map of progress to the color to start displaying at that\n position along the LED strip\n\n:returns: a motionless step pattern" + } + ] + }, + { + "className": "wpilib.LEDPattern.GradientType", + "classVariables": [ + { + "name": "kContinuous", + "tooltip": "", + "type": "wpilib.LEDPattern.GradientType", + "writable": false }, + { + "name": "kDiscontinuous", + "tooltip": "", + "type": "wpilib.LEDPattern.GradientType", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" - }, - { - "defaultValue": "", - "name": "time", - "type": "wpimath.units.microseconds" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "setPulseTime", - "returnType": "None", - "tooltip": "Set the PWM pulse time directly to the hardware.\n\nWrite a microsecond value to a PWM channel.\n\n:param time: Microsecond PWM value." + "declaringClassName": "wpilib.LEDPattern.GradientType", + "functionName": "__init__", + "returnType": "wpilib.LEDPattern.GradientType", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.LEDPattern.LEDReader", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWM" + "name": "impl", + "type": "Callable[[typing.SupportsInt], wpilib.AddressableLED.LEDData]" }, { "defaultValue": "", - "name": "speed", - "type": "float" + "name": "size", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "setSpeed", - "returnType": "None", - "tooltip": "Set the PWM value based on a speed.\n\nThis is intended to be used by motor controllers.\n\n@pre SetBounds() called.\n\n:param speed: The speed to set the motor controller between -1.0 and 1.0." - }, + "declaringClassName": "wpilib.LEDPattern.LEDReader", + "functionName": "__init__", + "returnType": "wpilib.LEDPattern.LEDReader", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWM" + "type": "wpilib.LEDPattern.LEDReader" } ], - "declaringClassName": "wpilib.PWM", - "functionName": "setZeroLatch", - "returnType": "None", - "tooltip": "Latches PWM to zero." + "declaringClassName": "wpilib.LEDPattern.LEDReader", + "functionName": "size", + "returnType": "int", + "tooltip": "" } ], "instanceVariables": [], @@ -26110,41 +9544,31 @@ "staticMethods": [] }, { - "className": "wpilib.SharpIR", + "className": "wpilib.Mechanism2d", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" - }, - { - "defaultValue": "", - "name": "a", - "type": "float" - }, - { - "defaultValue": "", - "name": "b", - "type": "float" + "name": "width", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "minCM", - "type": "float" + "name": "height", + "type": "typing.SupportsFloat" }, { - "defaultValue": "", - "name": "maxCM", - "type": "float" + "defaultValue": "Color8Bit(red=0, green=0, blue=32)", + "name": "backgroundColor", + "type": "wpilib.Color8Bit" } ], - "declaringClassName": "wpilib.SharpIR", + "declaringClassName": "wpilib.Mechanism2d", "functionName": "__init__", - "returnType": "wpilib.SharpIR", - "tooltip": "Manually construct a SharpIR object. The distance is computed using this\nformula: A*v ^ B. Prefer to use one of the static factories to create this\ndevice instead.\n\n:param channel: Analog input channel the sensor is connected to\n:param a: Constant A\n:param b: Constant B\n:param minCM: Minimum distance to report in centimeters\n:param maxCM: Maximum distance to report in centimeters" + "returnType": "wpilib.Mechanism2d", + "tooltip": "Create a new Mechanism2d with the given dimensions and background color.\n\nThe dimensions represent the canvas that all the nodes are drawn on. The\ndefault color is dark blue.\n\n:param width: the width\n:param height: the height\n:param backgroundColor: the background color" } ], "enums": [], @@ -26154,105 +9578,72 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.SharpIR" - } - ], - "declaringClassName": "wpilib.SharpIR", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "Get the analog input channel number.\n\n:returns: analog input channel" - }, - { - "args": [ + "type": "wpilib.Mechanism2d" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.SharpIR" + "name": "name", + "type": "str" + }, + { + "defaultValue": "", + "name": "x", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "y", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.SharpIR", - "functionName": "getRange", - "returnType": "wpimath.units.centimeters", - "tooltip": "Get the range from the distance sensor.\n\n:returns: range of the target returned by the sensor" + "declaringClassName": "wpilib.Mechanism2d", + "functionName": "getRoot", + "returnType": "wpilib.MechanismRoot2d", + "tooltip": "Get or create a root in this Mechanism2d with the given name and\nposition.\n\nIf a root with the given name already exists, the given x and y\ncoordinates are not used.\n\n:param name: the root name\n:param x: the root x coordinate\n:param y: the root y coordinate\n\n:returns: a new root object, or the existing one with the given name." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.SharpIR" + "type": "wpilib.Mechanism2d" }, { "defaultValue": "", "name": "builder", - "type": "wpiutil.SendableBuilder" + "type": "ntcore.NTSendableBuilder" } ], - "declaringClassName": "wpilib.SharpIR", + "declaringClassName": "wpilib.Mechanism2d", "functionName": "initSendable", "returnType": "None", "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.SharpIR", - "functionName": "GP2Y0A02YK0F", - "returnType": "wpilib.SharpIR", - "tooltip": "Sharp GP2Y0A02YK0F is an analog IR sensor capable of measuring\ndistances from 20cm to 150cm.\n\n:param channel: Analog input channel the sensor is connected to\n\n:returns: sensor object" - }, - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.SharpIR", - "functionName": "GP2Y0A21YK0F", - "returnType": "wpilib.SharpIR", - "tooltip": "Sharp GP2Y0A21YK0F is an analog IR sensor capable of measuring\ndistances from 10cm to 80cm.\n\n:param channel: Analog input channel the sensor is connected to\n\n:returns: sensor object" }, { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.SharpIR", - "functionName": "GP2Y0A41SK0F", - "returnType": "wpilib.SharpIR", - "tooltip": "Sharp GP2Y0A41SK0F is an analog IR sensor capable of measuring\ndistances from 4cm to 30cm.\n\n:param channel: Analog input channel the sensor is connected to\n\n:returns: sensor object" - }, - { - "args": [ + "name": "self", + "type": "wpilib.Mechanism2d" + }, { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "color", + "type": "wpilib.Color8Bit" } ], - "declaringClassName": "wpilib.SharpIR", - "functionName": "GP2Y0A51SK0F", - "returnType": "wpilib.SharpIR", - "tooltip": "Sharp GP2Y0A51SK0F is an analog IR sensor capable of measuring\ndistances from 2cm to 15cm.\n\n:param channel: Analog input channel the sensor is connected to\n\n:returns: sensor object" + "declaringClassName": "wpilib.Mechanism2d", + "functionName": "setBackgroundColor", + "returnType": "None", + "tooltip": "Set the Mechanism2d background color.\n\n:param color: the new background color" } - ] + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] }, { - "className": "wpilib.SmartDashboard", + "className": "wpilib.MechanismLigament2d", "classVariables": [], "constructors": [ { @@ -26268,639 +9659,538 @@ "type": "dict" } ], - "declaringClassName": "wpilib.SmartDashboard", + "declaringClassName": "wpilib.MechanismLigament2d", "functionName": "__init__", - "returnType": "wpilib.SmartDashboard", + "returnType": "wpilib.MechanismLigament2d", "tooltip": "Initialize self. See help(type(self)) for accurate signature." } ], "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "key", - "type": "str" - } - ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "clearPersistent", - "returnType": "None", - "tooltip": "Stop making a key's value persistent through program restarts.\nThe key cannot be null.\n\n:param key: the key name" - }, + "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - } - ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "containsKey", - "returnType": "bool", - "tooltip": "Determines whether the given key is in this table.\n\n:param key: the key to search for\n\n:returns: true if the table as a value assigned to the given key" - }, - { - "args": [ + "name": "self", + "type": "wpilib.MechanismObject2d" + }, { "defaultValue": "", - "name": "keyName", + "name": "name", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "object" - } - ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getBoolean", - "returnType": "object", - "tooltip": "Returns the value at the specified key.\n\nIf the key is not found, returns the default value.\n\n:param keyName: the key\n:param defaultValue: the default value to return if key doesn't exist\n\n:returns: the value" - }, - { - "args": [ + "name": "length", + "type": "typing.SupportsFloat" + }, { "defaultValue": "", - "name": "key", - "type": "str" + "name": "angle", + "type": "wpimath.units.degrees" }, { - "defaultValue": "", - "name": "defaultValue", - "type": "object" - } - ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getBooleanArray", - "returnType": "object", - "tooltip": "Returns the boolean array the key maps to.\n\nIf the key does not exist or is of different type, it will return the\ndefault value.\n\n:param key: The key to look up.\n:param defaultValue: The value to be returned if no value is found.\n\n:returns: the value associated with the given key or the given default value\n if there is no value associated with the key\n \n .. note:: This makes a copy of the array. If the overhead of this is a concern,\n use GetValue() instead.\n \n .. note:: The returned array is std::vector instead of std::vector\n because std::vector is special-cased in C++. 0 is false, any\n non-zero value is true." - }, - { - "args": [ + "defaultValue": "6", + "name": "lineWidth", + "type": "typing.SupportsFloat" + }, { - "defaultValue": "", - "name": "keyName", - "type": "str" + "defaultValue": "Color8Bit(red=235, green=137, blue=52)", + "name": "color", + "type": "wpilib.Color8Bit" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getData", - "returnType": "wpiutil.Sendable", - "tooltip": "Returns the value at the specified key.\n\n:param keyName: the key\n\n:returns: the value" + "declaringClassName": "wpilib.MechanismObject2d", + "functionName": "appendLigament", + "returnType": "wpilib.MechanismLigament2d", + "tooltip": "Append a ligament node" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - } - ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getEntry", - "returnType": "ntcore.NetworkTableEntry", - "tooltip": "Returns an NT Entry mapping to the specified key\n\nThis is useful if an entry is used often, or is read and then modified.\n\n:param key: the key\n\n:returns: the entry for the key" - }, - { - "args": [ - { - "defaultValue": "0", - "name": "types", - "type": "int" + "name": "self", + "type": "wpilib.MechanismLigament2d" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getKeys", - "returnType": "list[str]", - "tooltip": ":param types: bitmask of types; 0 is treated as a \"don't care\".\n\n:returns: keys currently in the table" + "declaringClassName": "wpilib.MechanismLigament2d", + "functionName": "getAngle", + "returnType": "float", + "tooltip": "Get the ligament's angle relative to its parent.\n\n:returns: the angle" }, { "args": [ { "defaultValue": "", - "name": "keyName", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "object" + "name": "self", + "type": "wpilib.MechanismLigament2d" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getNumber", - "returnType": "object", - "tooltip": "Returns the value at the specified key.\n\nIf the key is not found, returns the default value.\n\n:param keyName: the key\n:param defaultValue: the default value to return if the key doesn't exist\n\n:returns: the value" + "declaringClassName": "wpilib.MechanismLigament2d", + "functionName": "getColor", + "returnType": "wpilib.Color8Bit", + "tooltip": "Get the ligament color.\n\n:returns: the color of the line" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "object" + "name": "self", + "type": "wpilib.MechanismLigament2d" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getNumberArray", - "returnType": "object", - "tooltip": "Returns the number array the key maps to.\n\nIf the key does not exist or is of different type, it will return the\ndefault value.\n\n:param key: The key to look up.\n:param defaultValue: The value to be returned if no value is found.\n\n:returns: the value associated with the given key or the given default value\n if there is no value associated with the key\n \n .. note:: This makes a copy of the array. If the overhead of this is a concern,\n use GetValue() instead." + "declaringClassName": "wpilib.MechanismLigament2d", + "functionName": "getLength", + "returnType": "float", + "tooltip": "Get the ligament length.\n\n:returns: the line length" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "object" + "name": "self", + "type": "wpilib.MechanismLigament2d" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getRaw", - "returnType": "object", - "tooltip": "Returns the raw value (byte array) the key maps to.\n\nIf the key does not exist or is of different type, it will return the\ndefault value.\n\n:param key: The key to look up.\n:param defaultValue: The value to be returned if no value is found.\n\n:returns: the value associated with the given key or the given default value\n if there is no value associated with the key\n \n .. note:: This makes a copy of the raw contents. If the overhead of this is a\n concern, use GetValue() instead." + "declaringClassName": "wpilib.MechanismLigament2d", + "functionName": "getLineWeight", + "returnType": "float", + "tooltip": "Get the line thickness.\n\n:returns: the line thickness" }, { "args": [ { "defaultValue": "", - "name": "keyName", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "object" + "name": "self", + "type": "wpilib.MechanismObject2d" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getString", - "returnType": "object", - "tooltip": "Returns the value at the specified key.\n\nIf the key is not found, returns the default value.\n\n:param keyName: the key\n:param defaultValue: the default value to return if the key doesn't exist\n\n:returns: the value" + "declaringClassName": "wpilib.MechanismObject2d", + "functionName": "getName", + "returnType": "str", + "tooltip": "Retrieve the object's name.\n\n:returns: the object's name relative to its parent." }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.MechanismLigament2d" }, { "defaultValue": "", - "name": "defaultValue", - "type": "object" - } - ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getStringArray", - "returnType": "object", - "tooltip": "Returns the string array the key maps to.\n\nIf the key does not exist or is of different type, it will return the\ndefault value.\n\n:param key: The key to look up.\n:param defaultValue: The value to be returned if no value is found.\n\n:returns: the value associated with the given key or the given default value\n if there is no value associated with the key\n \n .. note:: This makes a copy of the array. If the overhead of this is a concern,\n use GetValue() instead." - }, - { - "args": [ - { - "defaultValue": "", - "name": "keyName", - "type": "str" + "name": "angle", + "type": "wpimath.units.degrees" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "getValue", - "returnType": "ntcore.Value", - "tooltip": "Retrieves the complex value (such as an array) in this table into the\ncomplex data object.\n\n:param keyName: the key" - }, - { - "args": [], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "init", + "declaringClassName": "wpilib.MechanismLigament2d", + "functionName": "setAngle", "returnType": "None", - "tooltip": "" + "tooltip": "Set the ligament's angle relative to its parent.\n\n:param angle: the angle" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - } - ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "isPersistent", - "returnType": "bool", - "tooltip": "Returns whether the value is persistent through program restarts.\nThe key cannot be null.\n\n:param key: the key name" - }, - { - "args": [ + "name": "self", + "type": "wpilib.MechanismLigament2d" + }, { "defaultValue": "", - "name": "task", - "type": "Callable[[], None]" + "name": "color", + "type": "wpilib.Color8Bit" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "postListenerTask", + "declaringClassName": "wpilib.MechanismLigament2d", + "functionName": "setColor", "returnType": "None", - "tooltip": "Posts a task from a listener to the ListenerExecutor, so that it can be run\nsynchronously from the main loop on the next call to updateValues().\n\n:param task: The task to run synchronously from the main thread." + "tooltip": "Set the ligament color.\n\n:param color: the color of the line" }, { "args": [ { "defaultValue": "", - "name": "keyName", - "type": "str" + "name": "self", + "type": "wpilib.MechanismLigament2d" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "length", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "putBoolean", - "returnType": "bool", - "tooltip": "Maps the specified key to the specified value in this table.\n\nThe value can be retrieved by calling the get method with a key that is\nequal to the original key.\n\n:param keyName: the key\n:param value: the value\n\n:returns: False if the table key already exists with a different type" + "declaringClassName": "wpilib.MechanismLigament2d", + "functionName": "setLength", + "returnType": "None", + "tooltip": "Set the ligament's length.\n\n:param length: the line length" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.MechanismLigament2d" }, { "defaultValue": "", - "name": "value", - "type": "List[int]" + "name": "lineWidth", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "putBooleanArray", - "returnType": "bool", - "tooltip": "Put a boolean array in the table.\n\n:param key: the key to be assigned to\n:param value: the value that will be assigned\n\n:returns: False if the table key already exists with a different type\n \n .. note:: The array must be of int's rather than of bool's because\n std::vector is special-cased in C++. 0 is false, any\n non-zero value is true." - }, + "declaringClassName": "wpilib.MechanismLigament2d", + "functionName": "setLineWeight", + "returnType": "None", + "tooltip": "Set the line thickness.\n\n:param lineWidth: the line thickness" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.MechanismObject2d", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "args", + "type": "tuple" }, { "defaultValue": "", - "name": "data", - "type": "wpiutil.Sendable" + "name": "kwargs", + "type": "dict" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "putData", - "returnType": "None", - "tooltip": "Maps the specified key to the specified value in this table.\n\nThe value can be retrieved by calling the get method with a key that is\nequal to the original key.\n\nIn order for the value to appear in the dashboard, it must be registered\nwith SendableRegistry. WPILib components do this automatically.\n\n:param key: the key\n:param data: the value" - }, + "declaringClassName": "wpilib.MechanismObject2d", + "functionName": "__init__", + "returnType": "wpilib.MechanismObject2d", + "tooltip": "Initialize self. See help(type(self)) for accurate signature." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "value", - "type": "wpiutil.Sendable" - } - ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "putData", - "returnType": "None", - "tooltip": "Maps the specified key (where the key is the name of the Sendable)\nto the specified value in this table.\n\nThe value can be retrieved by calling the get method with a key that is\nequal to the original key.\n\nIn order for the value to appear in the dashboard, it must be registered\nwith SendableRegistry. WPILib components do this automatically.\n\n:param value: the value" - }, - { - "args": [ + "name": "self", + "type": "wpilib.MechanismObject2d" + }, { "defaultValue": "", - "name": "keyName", + "name": "name", "type": "str" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "length", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "angle", + "type": "wpimath.units.degrees" + }, + { + "defaultValue": "6", + "name": "lineWidth", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "Color8Bit(red=235, green=137, blue=52)", + "name": "color", + "type": "wpilib.Color8Bit" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "putNumber", - "returnType": "bool", - "tooltip": "Maps the specified key to the specified value in this table.\n\nThe value can be retrieved by calling the get method with a key that is\nequal to the original key.\n\n:param keyName: the key\n:param value: the value\n\n:returns: False if the table key already exists with a different type" + "declaringClassName": "wpilib.MechanismObject2d", + "functionName": "appendLigament", + "returnType": "wpilib.MechanismLigament2d", + "tooltip": "Append a ligament node" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "List[float]" + "name": "self", + "type": "wpilib.MechanismObject2d" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "putNumberArray", - "returnType": "bool", - "tooltip": "Put a number array in the table.\n\n:param key: The key to be assigned to.\n:param value: The value that will be assigned.\n\n:returns: False if the table key already exists with a different type" - }, + "declaringClassName": "wpilib.MechanismObject2d", + "functionName": "getName", + "returnType": "str", + "tooltip": "Retrieve the object's name.\n\n:returns: the object's name relative to its parent." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.MechanismRoot2d", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "args", + "type": "tuple" }, { "defaultValue": "", - "name": "value", - "type": "Buffer" + "name": "kwargs", + "type": "dict" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "putRaw", - "returnType": "bool", - "tooltip": "Put a raw value (byte array) in the table.\n\n:param key: The key to be assigned to.\n:param value: The value that will be assigned.\n\n:returns: False if the table key already exists with a different type" - }, + "declaringClassName": "wpilib.MechanismRoot2d", + "functionName": "__init__", + "returnType": "wpilib.MechanismRoot2d", + "tooltip": "Initialize self. See help(type(self)) for accurate signature." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "keyName", - "type": "str" + "name": "self", + "type": "wpilib.MechanismRoot2d" }, { "defaultValue": "", - "name": "value", + "name": "name", "type": "str" - } - ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "putString", - "returnType": "bool", - "tooltip": "Maps the specified key to the specified value in this table.\n\nThe value can be retrieved by calling the get method with a key that is\nequal to the original key.\n\n:param keyName: the key\n:param value: the value\n\n:returns: False if the table key already exists with a different type" - }, - { - "args": [ + }, { "defaultValue": "", - "name": "key", - "type": "str" + "name": "length", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "value", - "type": "List[str]" + "name": "angle", + "type": "wpimath.units.degrees" + }, + { + "defaultValue": "6", + "name": "lineWidth", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "Color8Bit(red=235, green=137, blue=52)", + "name": "color", + "type": "wpilib.Color8Bit" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "putStringArray", - "returnType": "bool", - "tooltip": "Put a string array in the table.\n\n:param key: The key to be assigned to.\n:param value: The value that will be assigned.\n\n:returns: False if the table key already exists with a different type" + "declaringClassName": "wpilib.MechanismRoot2d", + "functionName": "appendLigament", + "returnType": "wpilib.MechanismLigament2d", + "tooltip": "Append a ligament node" }, { "args": [ { "defaultValue": "", - "name": "keyName", - "type": "str" - }, - { - "defaultValue": "", - "name": "value", - "type": "ntcore.Value" + "name": "self", + "type": "wpilib.MechanismRoot2d" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "putValue", - "returnType": "bool", - "tooltip": "Maps the specified key to the specified complex value (such as an array) in\nthis table.\n\nThe value can be retrieved by calling the RetrieveValue method with a key\nthat is equal to the original key.\n\n:param keyName: the key\n:param value: the value\n\n:returns: False if the table key already exists with a different type" + "declaringClassName": "wpilib.MechanismRoot2d", + "functionName": "getName", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.MechanismRoot2d" }, { "defaultValue": "", - "name": "defaultValue", - "type": "bool" + "name": "x", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "y", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "setDefaultBoolean", - "returnType": "bool", - "tooltip": "Set the value in the table if key does not exist\n\n:param key: the key\n:param defaultValue: the value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" - }, + "declaringClassName": "wpilib.MechanismRoot2d", + "functionName": "setPosition", + "returnType": "None", + "tooltip": "Set the root's position.\n\n:param x: new x coordinate\n:param y: new y coordinate" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.MotorControllerGroup", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, + "name": "args", + "type": "tuple" + } + ], + "declaringClassName": "wpilib.MotorControllerGroup", + "functionName": "__init__", + "returnType": "wpilib.MotorControllerGroup", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ { "defaultValue": "", - "name": "defaultValue", - "type": "List[int]" + "name": "self", + "type": "wpilib.MotorControllerGroup" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "setDefaultBooleanArray", - "returnType": "bool", - "tooltip": "Set the value in the table if key does not exist.\n\n:param key: the key\n:param defaultValue: the value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" + "declaringClassName": "wpilib.MotorControllerGroup", + "functionName": "disable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "float" + "name": "self", + "type": "wpilib.MotorControllerGroup" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "setDefaultNumber", - "returnType": "bool", - "tooltip": "Set the value in the table if key does not exist.\n\n:param key: The key.\n:param defaultValue: The value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" + "declaringClassName": "wpilib.MotorControllerGroup", + "functionName": "get", + "returnType": "float", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" + "name": "self", + "type": "wpilib.MotorControllerGroup" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "setDefaultNumberArray", + "declaringClassName": "wpilib.MotorControllerGroup", + "functionName": "getInverted", "returnType": "bool", - "tooltip": "Set the value in the table if key does not exist.\n\n:param key: The key.\n:param defaultValue: The value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.MotorControllerGroup" }, { "defaultValue": "", - "name": "defaultValue", - "type": "Buffer" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "setDefaultRaw", - "returnType": "bool", - "tooltip": "Set the value in the table if key does not exist.\n\n:param key: The key.\n:param defaultValue: The value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" + "declaringClassName": "wpilib.MotorControllerGroup", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.MotorControllerGroup" }, { "defaultValue": "", - "name": "defaultValue", - "type": "str" + "name": "speed", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "setDefaultString", - "returnType": "bool", - "tooltip": "Set the value in the table if key does not exist.\n\n:param key: the key\n:param defaultValue: the value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" + "declaringClassName": "wpilib.MotorControllerGroup", + "functionName": "set", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.MotorControllerGroup" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[str]" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "setDefaultStringArray", - "returnType": "bool", - "tooltip": "Set the value in the table if key does not exist.\n\n:param key: The key.\n:param defaultValue: The value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" + "declaringClassName": "wpilib.MotorControllerGroup", + "functionName": "setInverted", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.MotorControllerGroup" }, { "defaultValue": "", - "name": "defaultValue", - "type": "ntcore.Value" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "setDefaultValue", - "returnType": "bool", - "tooltip": "Set the value in the table if key does not exist.\n\n:param key: the key\n:param defaultValue: The value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" + "declaringClassName": "wpilib.MotorControllerGroup", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "key", - "type": "str" + "name": "self", + "type": "wpilib.MotorControllerGroup" } ], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "setPersistent", - "returnType": "None", - "tooltip": "Makes a key's value persistent through program restarts.\n\n:param key: the key to make persistent" - }, - { - "args": [], - "declaringClassName": "wpilib.SmartDashboard", - "functionName": "updateValues", + "declaringClassName": "wpilib.MotorControllerGroup", + "functionName": "stopMotor", "returnType": "None", - "tooltip": "Puts all sendable data to the dashboard." + "tooltip": "" } - ] + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] }, { - "className": "wpilib.Solenoid", + "className": "wpilib.MotorSafety", "classVariables": [], "constructors": [ { - "args": [ - { - "defaultValue": "", - "name": "module", - "type": "int" - }, - { - "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Solenoid", - "functionName": "__init__", - "returnType": "wpilib.Solenoid", - "tooltip": "Constructs a solenoid for a specified module and type.\n\n:param module: The module ID to use.\n:param moduleType: The module type to use.\n:param channel: The channel the solenoid is on." - }, - { - "args": [ - { - "defaultValue": "", - "name": "moduleType", - "type": "wpilib.PneumaticsModuleType" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Solenoid", + "args": [], + "declaringClassName": "wpilib.MotorSafety", "functionName": "__init__", - "returnType": "wpilib.Solenoid", - "tooltip": "Constructs a solenoid for a default module and specified type.\n\n:param moduleType: The module type to use.\n:param channel: The channel the solenoid is on." + "returnType": "wpilib.MotorSafety", + "tooltip": "" } ], "enums": [], @@ -26910,141 +10200,157 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.Solenoid" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.Solenoid", - "functionName": "get", - "returnType": "bool", - "tooltip": "Read the current value of the solenoid.\n\n:returns: The current value of the solenoid." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Solenoid" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.Solenoid", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "Get the channel this solenoid is connected to." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Solenoid" - }, + "type": "wpilib.MotorSafety" + } + ], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "Returns a description to print when an error occurs.\n\n:returns: Description to print when an error occurs." + }, + { + "args": [ { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "self", + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.Solenoid", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Solenoid" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.Solenoid", - "functionName": "isDisabled", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", "returnType": "bool", - "tooltip": "Check if solenoid is Disabled.\n\nIf a solenoid is shorted, it is added to the DisabledList and\ndisabled until power cycle, or until faults are cleared.\n\n@see ClearAllPCMStickyFaults()\n\n:returns: If solenoid is disabled due to short." + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Solenoid" - }, - { - "defaultValue": "", - "name": "on", - "type": "bool" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.Solenoid", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the value of a solenoid.\n\n:param on: Turn the solenoid output off or on." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Solenoid" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "duration", + "name": "expirationTime", "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.Solenoid", - "functionName": "setPulseDuration", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", "returnType": "None", - "tooltip": "Set the pulse duration in the pneumatics module. This is used in\nconjunction with the startPulse method to allow the pneumatics module to\ncontrol the timing of a pulse.\n\nOn the PCM, the timing can be controlled in 0.01 second increments, with a\nmaximum of 2.55 seconds. On the PH, the timing can be controlled in 0.001\nsecond increments, with a maximum of 65.534 seconds.\n\n@see startPulse()\n\n:param duration: The duration of the pulse." + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Solenoid" + "type": "wpilib.MotorSafety" + }, + { + "defaultValue": "", + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.Solenoid", - "functionName": "startPulse", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", "returnType": "None", - "tooltip": "%Trigger the pneumatics module to generate a pulse of the duration set in\nsetPulseDuration.\n\n@see setPulseDuration()" + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Solenoid" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.Solenoid", - "functionName": "toggle", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "stopMotor", "returnType": "None", - "tooltip": "Toggle the value of the solenoid.\n\nIf the solenoid is set to on, it'll be turned off. If the solenoid is set\nto off, it'll be turned on." + "tooltip": "Called to stop the motor when the timeout expires." } ], "instanceVariables": [], "moduleName": "wpilib", - "staticMethods": [] + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] }, { - "className": "wpilib.Spark", + "className": "wpilib.Notifier", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "handler", + "type": "Callable[[], None]" } ], - "declaringClassName": "wpilib.Spark", + "declaringClassName": "wpilib.Notifier", "functionName": "__init__", - "returnType": "wpilib.Spark", - "tooltip": "Constructor for a SPARK connected via PWM.\n\n:param channel: The PWM channel that the SPARK is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + "returnType": "wpilib.Notifier", + "tooltip": "Create a Notifier for timer event notification.\n\n:param handler: The handler is called at the notification time which is set\n using StartSingle or StartPeriodic." } ], "enums": [], @@ -27054,316 +10360,375 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.Notifier" + }, + { + "defaultValue": "", + "name": "handler", + "type": "Callable[[], None]" + } + ], + "declaringClassName": "wpilib.Notifier", + "functionName": "setCallback", + "returnType": "None", + "tooltip": "Change the handler function.\n\n:param handler: Handler" + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.Notifier" + }, + { + "defaultValue": "", + "name": "name", + "type": "str" + } + ], + "declaringClassName": "wpilib.Notifier", + "functionName": "setName", + "returnType": "None", + "tooltip": "Sets the name of the notifier. Used for debugging purposes only.\n\n:param name: Name" + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.Notifier" }, { "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" + "name": "period", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", + "declaringClassName": "wpilib.Notifier", + "functionName": "startPeriodic", "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." + "tooltip": "Register for periodic event notification.\n\nA timer event is queued for periodic event notification. Each time the\ninterrupt occurs, the event will be immediately requeued for the same time\ninterval.\n\n:param period: Period to call the handler starting one period\n after the call to this method." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.Notifier" + }, + { + "defaultValue": "", + "name": "delay", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", + "declaringClassName": "wpilib.Notifier", + "functionName": "startSingle", "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + "tooltip": "Register for single event notification.\n\nA timer event is queued for a single event after the specified delay.\n\n:param delay: Amount of time to wait before the handler is called." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.Notifier" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", + "declaringClassName": "wpilib.Notifier", + "functionName": "stop", "returnType": "None", - "tooltip": "" - }, + "tooltip": "Stop timer events from occurring.\n\nStop any repeating timer events from occurring. This will also remove any\nsingle notification events from the queue.\n\nIf a timer-based call to the registered handler is in progress, this\nfunction will block until the handler call is complete." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" + "name": "realTime", + "type": "bool" }, { "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" + "name": "priority", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." - }, + "declaringClassName": "wpilib.Notifier", + "functionName": "setHALThreadPriority", + "returnType": "bool", + "tooltip": "Sets the HAL notifier thread priority.\n\nThe HAL notifier thread is responsible for managing the FPGA's notifier\ninterrupt and waking up user's Notifiers when it's their time to run.\nGiving the HAL notifier thread real-time priority helps ensure the user's\nreal-time Notifiers, if any, are notified to run in a timely manner.\n\n:param realTime: Set to true to set a real-time priority, false for standard\n priority.\n:param priority: Priority to set the thread to. For real-time, this is 1-99\n with 99 being highest. For non-real-time, this is forced to\n 0. See \"man 7 sched\" for more details.\n\n:returns: True on success." + } + ] + }, + { + "className": "wpilib.OnboardIMU", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" + "name": "mountOrientation", + "type": "wpilib.OnboardIMU.MountOrientation" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." - }, + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "__init__", + "returnType": "wpilib.OnboardIMU", + "tooltip": "Constructs a handle to the SystemCore onboard IMU.\n\n:param mountOrientation: the mount orientation of SystemCore to determine\n yaw." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getAccelX", + "returnType": "wpimath.units.meters_per_second_squared", + "tooltip": "Get the acceleration along the X axis of the IMU.\n\n:returns: acceleration along the X axis" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getAccelY", + "returnType": "wpimath.units.meters_per_second_squared", + "tooltip": "Get the acceleration along the Z axis of the IMU.\n\n:returns: acceleration along the Z axis" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getAccelZ", + "returnType": "wpimath.units.meters_per_second_squared", + "tooltip": "Get the acceleration along the Z axis of the IMU.\n\n:returns: acceleration along the Z axis" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getAngleX", + "returnType": "wpimath.units.radians", + "tooltip": "Get the angle about the X axis of the IMU.\n\n:returns: angle about the X axis" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getAngleY", + "returnType": "wpimath.units.radians", + "tooltip": "Get the angle about the Y axis of the IMU.\n\n:returns: angle about the Y axis" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getAngleZ", + "returnType": "wpimath.units.radians", + "tooltip": "Get the angle about the Z axis of the IMU.\n\n:returns: angle about the Z axis" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getGyroRateX", + "returnType": "wpimath.units.radians_per_second", + "tooltip": "Get the angular rate about the X axis of the IMU.\n\n:returns: angular rate about the X axis" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getGyroRateY", + "returnType": "wpimath.units.radians_per_second", + "tooltip": "Get the angular rate about the Y axis of the IMU.\n\n:returns: angular rate about the Y axis" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getGyroRateZ", + "returnType": "wpimath.units.radians_per_second", + "tooltip": "Get the angular rate about the Z axis of the IMU.\n\n:returns: angular rate about the Z axis" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getQuaternion", + "returnType": "wpimath.geometry.Quaternion", + "tooltip": "Get the 3D orientation as a Quaternion.\n\n:returns: 3D orientation" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getRotation2d", + "returnType": "wpimath.geometry.Rotation2d", + "tooltip": "Get the yaw as a Rotation2d.\n\n:returns: yaw" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getRotation3d", + "returnType": "wpimath.geometry.Rotation3d", + "tooltip": "Get the 3D orientation as a Rotation3d.\n\n:returns: 3D orientation" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "getYaw", + "returnType": "wpimath.units.radians", + "tooltip": "Get the yaw value\n\n:returns: yaw value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" + "type": "wpilib.OnboardIMU" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", + "declaringClassName": "wpilib.OnboardIMU", + "functionName": "resetYaw", "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + "tooltip": "Reset the current yaw value to 0. Future reads of the yaw value will be\nrelative to the current orientation." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.OnboardIMU.MountOrientation", + "classVariables": [ + { + "name": "kFlat", + "tooltip": "", + "type": "wpilib.OnboardIMU.MountOrientation", + "writable": false + }, + { + "name": "kLandscape", + "tooltip": "", + "type": "wpilib.OnboardIMU.MountOrientation", + "writable": false }, + { + "name": "kPortrait", + "tooltip": "", + "type": "wpilib.OnboardIMU.MountOrientation", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", + "declaringClassName": "wpilib.OnboardIMU.MountOrientation", + "functionName": "__init__", + "returnType": "wpilib.OnboardIMU.MountOrientation", "tooltip": "" } ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ + "enums": [], + "instanceMethods": [], + "instanceVariables": [ { - "args": [], - "declaringClassName": "wpilib.Spark", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false } - ] + ], + "moduleName": "wpilib", + "staticMethods": [] }, { - "className": "wpilib.StadiaController", + "className": "wpilib.PS4Controller", "classVariables": [], "constructors": [ { @@ -27371,12 +10736,12 @@ { "defaultValue": "", "name": "port", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.StadiaController", + "declaringClassName": "wpilib.PS4Controller", "functionName": "__init__", - "returnType": "wpilib.StadiaController", + "returnType": "wpilib.PS4Controller", "tooltip": "Construct an instance of a controller.\n\nThe controller index is the USB port on the Driver Station.\n\n:param port: The port on the Driver Station that the controller is plugged\n into (0-5)." } ], @@ -27387,7 +10752,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" }, { "defaultValue": "", @@ -27395,17 +10760,17 @@ "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "A", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "L1", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the A button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the A button's\n digital signal attached to the given loop." + "tooltip": "Constructs an event instance around the left trigger 1 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left trigger 1 button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" }, { "defaultValue": "", @@ -27413,10 +10778,28 @@ "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "B", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "L2", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the B button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the B button's\n digital signal attached to the given loop." + "tooltip": "Constructs an event instance around the left trigger 2 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left trigger 2 button's\n digital signal attached to the given loop." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PS4Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" + } + ], + "declaringClassName": "wpilib.PS4Controller", + "functionName": "L3", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the L3 (left stick) button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the L3 (left stick) button's\n digital signal attached to the given loop." }, { "args": [ @@ -27428,7 +10811,7 @@ { "defaultValue": "", "name": "angle", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" }, { "defaultValue": "", @@ -27439,7 +10822,7 @@ "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "POV", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ @@ -27451,12 +10834,12 @@ { "defaultValue": "", "name": "pov", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "angle", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" }, { "defaultValue": "", @@ -27467,7 +10850,7 @@ "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "POV", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ @@ -27503,7 +10886,7 @@ "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "POVDown", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 180 degree angle (down)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 180 degree angle of a POV\n on the HID." + "tooltip": "Constructs a BooleanEvent instance based around the down direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down direction of a POV\n on the HID." }, { "args": [ @@ -27521,7 +10904,7 @@ "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "POVDownLeft", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 225 degree angle (down\nleft) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 225 degree angle of a POV\n on the HID." + "tooltip": "Constructs a BooleanEvent instance based around the down left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down left direction of a\n POV on the HID." }, { "args": [ @@ -27539,7 +10922,7 @@ "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "POVDownRight", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 135 degree angle (right\ndown) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 135 degree angle of a POV\n on the HID." + "tooltip": "Constructs a BooleanEvent instance based around the down right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down right direction of a\n POV on the HID." }, { "args": [ @@ -27557,7 +10940,7 @@ "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "POVLeft", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 270 degree angle (left)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 270 degree angle of a POV\n on the HID." + "tooltip": "Constructs a BooleanEvent instance based around the left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the left direction of a POV\n on the HID." }, { "args": [ @@ -27575,7 +10958,7 @@ "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "POVRight", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 90 degree angle (right)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 90 degree angle of a POV\n on the HID." + "tooltip": "Constructs a BooleanEvent instance based around the right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the right direction of a POV\n on the HID." }, { "args": [ @@ -27593,7 +10976,7 @@ "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "POVUp", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 0 degree angle (up) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 0 degree angle of a POV on\n the HID." + "tooltip": "Constructs a BooleanEvent instance based around the up direction of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up direction of a POV on\n the HID." }, { "args": [ @@ -27611,7 +10994,7 @@ "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "POVUpLeft", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 315 degree angle (left\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 315 degree angle of a POV\n on the HID." + "tooltip": "Constructs a BooleanEvent instance based around the up left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up left direction of a POV\n on the HID." }, { "args": [ @@ -27629,14 +11012,14 @@ "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "POVUpRight", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 45 degree angle (right\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 45 degree angle of a POV\n on the HID." + "tooltip": "Constructs a BooleanEvent instance based around the up right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" }, { "defaultValue": "", @@ -27644,17 +11027,17 @@ "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "X", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "PS", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the X button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the X button's\n digital signal attached to the given loop." + "tooltip": "Constructs an event instance around the PlayStation button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the PlayStation button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" }, { "defaultValue": "", @@ -27662,10 +11045,46 @@ "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "Y", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "R1", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the Y button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the Y button's\n digital signal attached to the given loop." + "tooltip": "Constructs an event instance around the right trigger 1 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right trigger 1 button's\n digital signal attached to the given loop." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PS4Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" + } + ], + "declaringClassName": "wpilib.PS4Controller", + "functionName": "R2", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the right trigger 2 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right trigger 2 button's\n digital signal attached to the given loop." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PS4Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" + } + ], + "declaringClassName": "wpilib.PS4Controller", + "functionName": "R3", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the R3 (right stick) button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the R3 (right stick) button's\n digital signal attached to the given loop." }, { "args": [ @@ -27677,12 +11096,12 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "threshold", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -27705,12 +11124,12 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "threshold", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -27733,7 +11152,7 @@ { "defaultValue": "", "name": "button", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -27751,7 +11170,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" }, { "defaultValue": "", @@ -27759,17 +11178,17 @@ "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "ellipses", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "circle", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the ellipses button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the ellipses button's\n digital signal attached to the given loop." + "tooltip": "Constructs an event instance around the circle button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the circle button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" }, { "defaultValue": "", @@ -27777,49 +11196,10 @@ "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "frame", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "cross", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the frame button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the frame button's\n digital signal attached to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getAButton", - "returnType": "bool", - "tooltip": "Read the value of the A button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getAButtonPressed", - "returnType": "bool", - "tooltip": "Whether the A button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getAButtonReleased", - "returnType": "bool", - "tooltip": "Whether the A button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Constructs an event instance around the cross button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the cross button's\n digital signal attached to the given loop." }, { "args": [ @@ -27844,7 +11224,7 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.interfaces.GenericHID", @@ -27852,45 +11232,6 @@ "returnType": "int", "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getBButton", - "returnType": "bool", - "tooltip": "Read the value of the B button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getBButtonPressed", - "returnType": "bool", - "tooltip": "Whether the B button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getBButtonReleased", - "returnType": "bool", - "tooltip": "Whether the B button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, { "args": [ { @@ -27909,351 +11250,286 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getEllipsesButton", - "returnType": "bool", - "tooltip": "Read the value of the ellipses button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getEllipsesButtonPressed", - "returnType": "bool", - "tooltip": "Whether the ellipses button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getEllipsesButtonReleased", - "returnType": "bool", - "tooltip": "Whether the ellipses button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getFrameButton", - "returnType": "bool", - "tooltip": "Read the value of the frame button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getFrameButtonPressed", - "returnType": "bool", - "tooltip": "Whether the frame button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getFrameButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getCircleButton", "returnType": "bool", - "tooltip": "Whether the frame button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Read the value of the circle button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getGoogleButton", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getCircleButtonPressed", "returnType": "bool", - "tooltip": "Read the value of the google button on the controller.\n\n:returns: The state of the button." + "tooltip": "Whether the circle button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getGoogleButtonPressed", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getCircleButtonReleased", "returnType": "bool", - "tooltip": "Whether the google button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Whether the circle button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getGoogleButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getCrossButton", "returnType": "bool", - "tooltip": "Whether the google button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Read the value of the cross button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getHamburgerButton", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getCrossButtonPressed", "returnType": "bool", - "tooltip": "Read the value of the hamburger button on the controller.\n\n:returns: The state of the button." + "tooltip": "Whether the cross button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getHamburgerButtonPressed", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getCrossButtonReleased", "returnType": "bool", - "tooltip": "Whether the hamburger button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Whether the cross button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getHamburgerButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getL1Button", "returnType": "bool", - "tooltip": "Whether the hamburger button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Read the value of the left trigger 1 button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftBumper", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getL1ButtonPressed", "returnType": "bool", - "tooltip": "Read the value of the left bumper (LB) button on the controller.\n\n:deprecated: Use GetLeftBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: the state of the button" + "tooltip": "Whether the left trigger 1 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftBumperButton", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getL1ButtonReleased", "returnType": "bool", - "tooltip": "Read the value of the left bumper button on the controller.\n\n:returns: The state of the button." + "tooltip": "Whether the left trigger 1 button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftBumperButtonPressed", - "returnType": "bool", - "tooltip": "Whether the left bumper button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getL2Axis", + "returnType": "float", + "tooltip": "Get the left trigger 2 axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftBumperButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getL2Button", "returnType": "bool", - "tooltip": "Whether the left bumper button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Read the value of the left trigger 2 button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftBumperPressed", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getL2ButtonPressed", "returnType": "bool", - "tooltip": "Whether the left bumper (LB) was pressed since the last check.\n\n:deprecated: Use GetLeftBumperButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was pressed since the last check" + "tooltip": "Whether the left trigger 2 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftBumperReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getL2ButtonReleased", "returnType": "bool", - "tooltip": "Whether the left bumper (LB) was released since the last check.\n\n:deprecated: Use GetLeftBumperButtonReleased instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Whether the left trigger 2 button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftStickButton", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getL3Button", "returnType": "bool", - "tooltip": "Read the value of the left stick button on the controller.\n\n:returns: The state of the button." + "tooltip": "Read the value of the L3 (left stick) button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftStickButtonPressed", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getL3ButtonPressed", "returnType": "bool", - "tooltip": "Whether the left stick button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Whether the L3 (left stick) button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftStickButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getL3ButtonReleased", "returnType": "bool", - "tooltip": "Whether the left stick button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Whether the L3 (left stick) button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftTriggerButton", - "returnType": "bool", - "tooltip": "Read the value of the left trigger button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getLeftX", + "returnType": "float", + "tooltip": "Get the X axis value of left side of the controller. Right is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftTriggerButtonPressed", - "returnType": "bool", - "tooltip": "Whether the left trigger button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getLeftY", + "returnType": "float", + "tooltip": "Get the Y axis value of left side of the controller. Back is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftTriggerButtonReleased", - "returnType": "bool", - "tooltip": "Whether the left trigger button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getName", + "returnType": "str", + "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftX", - "returnType": "float", - "tooltip": "Get the X axis value of left side of the controller.\n\n:returns: the axis value." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getOptionsButton", + "returnType": "bool", + "tooltip": "Read the value of the options button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getLeftY", - "returnType": "float", - "tooltip": "Get the Y axis value of left side of the controller.\n\n:returns: the axis value." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getOptionsButtonPressed", + "returnType": "bool", + "tooltip": "Whether the options button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getName", - "returnType": "str", - "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getOptionsButtonReleased", + "returnType": "bool", + "tooltip": "Whether the options button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ @@ -28265,13 +11541,13 @@ { "defaultValue": "0", "name": "pov", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "getPOV", - "returnType": "int", - "tooltip": "Get the angle in degrees of a POV on the HID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(e.g. right is 90, upper-left is 315).\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV in degrees, or -1 if the POV is not pressed." + "returnType": "wpilib.DriverStation.POVDirection", + "tooltip": "Get the angle of a POV on the HID.\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV." }, { "args": [ @@ -28291,49 +11567,39 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPort", - "returnType": "int", - "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getPSButton", + "returnType": "bool", + "tooltip": "Read the value of the PlayStation button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawAxis", - "returnType": "float", - "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getPSButtonPressed", + "returnType": "bool", + "tooltip": "Whether the PlayStation button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButton", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getPSButtonReleased", "returnType": "bool", - "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." + "tooltip": "Whether the PlayStation button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ @@ -28341,511 +11607,486 @@ "defaultValue": "", "name": "self", "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" } ], "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonPressed", - "returnType": "bool", - "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." + "functionName": "getPort", + "returnType": "int", + "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getR1Button", "returnType": "bool", - "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Read the value of the right trigger 1 button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightBumper", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getR1ButtonPressed", "returnType": "bool", - "tooltip": "Read the value of the right bumper (RB) button on the controller.\n\n:deprecated: Use GetRightBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: the state of the button" + "tooltip": "Whether the right trigger 1 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightBumperButton", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getR1ButtonReleased", "returnType": "bool", - "tooltip": "Read the value of the right bumper button on the controller.\n\n:returns: The state of the button." + "tooltip": "Whether the right trigger 1 button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightBumperButtonPressed", - "returnType": "bool", - "tooltip": "Whether the right bumper button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getR2Axis", + "returnType": "float", + "tooltip": "Get the right trigger 2 axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightBumperButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getR2Button", "returnType": "bool", - "tooltip": "Whether the right bumper button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Read the value of the right trigger 2 button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightBumperPressed", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getR2ButtonPressed", "returnType": "bool", - "tooltip": "Whether the right bumper (RB) was pressed since the last check.\n\n:deprecated: Use GetRightBumperButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was pressed since the last check" + "tooltip": "Whether the right trigger 2 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightBumperReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getR2ButtonReleased", "returnType": "bool", - "tooltip": "Whether the right bumper (RB) was released since the last check.\n\n:deprecated: Use GetRightBumperButtonReleased instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Whether the right trigger 2 button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightStickButton", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getR3Button", "returnType": "bool", - "tooltip": "Read the value of the right stick button on the controller.\n\n:returns: The state of the button." + "tooltip": "Read the value of the R3 (right stick) button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightStickButtonPressed", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getR3ButtonPressed", "returnType": "bool", - "tooltip": "Whether the right stick button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Whether the R3 (right stick) button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightStickButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getR3ButtonReleased", "returnType": "bool", - "tooltip": "Whether the right stick button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Whether the R3 (right stick) button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightTriggerButton", - "returnType": "bool", - "tooltip": "Read the value of the right trigger button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawAxis", + "returnType": "float", + "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightTriggerButtonPressed", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButton", "returnType": "bool", - "tooltip": "Whether the right trigger button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightTriggerButtonReleased", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonPressed", "returnType": "bool", - "tooltip": "Whether the right trigger button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightX", - "returnType": "float", - "tooltip": "Get the X axis value of right side of the controller.\n\n:returns: the axis value." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonReleased", + "returnType": "bool", + "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getRightY", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getRightX", "returnType": "float", - "tooltip": "Get the Y axis value of right side of the controller.\n\n:returns: the axis value." + "tooltip": "Get the X axis value of right side of the controller. Right is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getStadiaButton", - "returnType": "bool", - "tooltip": "Read the value of the stadia button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getRightY", + "returnType": "float", + "tooltip": "Get the Y axis value of right side of the controller. Back is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getStadiaButtonPressed", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getShareButton", "returnType": "bool", - "tooltip": "Whether the stadia button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Read the value of the share button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getStadiaButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getShareButtonPressed", "returnType": "bool", - "tooltip": "Whether the stadia button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Whether the share button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getType", - "returnType": "wpilib.interfaces.GenericHID.HIDType", - "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getShareButtonReleased", + "returnType": "bool", + "tooltip": "Whether the share button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getXButton", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getSquareButton", "returnType": "bool", - "tooltip": "Read the value of the X button on the controller.\n\n:returns: The state of the button." + "tooltip": "Read the value of the square button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getXButtonPressed", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getSquareButtonPressed", "returnType": "bool", - "tooltip": "Whether the X button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Whether the square button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getXButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getSquareButtonReleased", "returnType": "bool", - "tooltip": "Whether the X button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Whether the square button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getYButton", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getTouchpad", "returnType": "bool", - "tooltip": "Read the value of the Y button on the controller.\n\n:returns: The state of the button." + "tooltip": "Read the value of the touchpad button on the controller.\n\n:deprecated: Use GetTouchpadButton instead. This function is deprecated for\n removal to make function names consistent to allow the HID classes to be\n automatically generated.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getYButtonPressed", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getTouchpadButton", "returnType": "bool", - "tooltip": "Whether the Y button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Read the value of the touchpad button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "getYButtonReleased", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getTouchpadButtonPressed", "returnType": "bool", - "tooltip": "Whether the Y button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Whether the touchpad button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "google", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the google button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the google button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getTouchpadButtonReleased", + "returnType": "bool", + "tooltip": "Whether the touchpad button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "hamburger", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the hamburger button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the hamburger button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getTouchpadPressed", + "returnType": "bool", + "tooltip": "Whether the touchpad was pressed since the last check.\n\n:deprecated: Use GetTouchpadButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the touchpad was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getTouchpadReleased", + "returnType": "bool", + "tooltip": "Whether the touchpad was released since the last check.\n\n:deprecated: Use GetLeftBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: Whether the touchpad was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "isConnected", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getTriangleButton", "returnType": "bool", - "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" + "tooltip": "Read the value of the triangle button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "leftBumper", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the left bumper button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left bumper button's\n digital signal attached to the given loop." + "type": "wpilib.PS4Controller" + } + ], + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getTriangleButtonPressed", + "returnType": "bool", + "tooltip": "Whether the triangle button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "leftStick", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the left stick button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left stick button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "getTriangleButtonReleased", + "returnType": "bool", + "tooltip": "Whether the triangle button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "leftTrigger", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the left trigger button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left trigger button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getType", + "returnType": "wpilib.interfaces.GenericHID.HIDType", + "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "rightBumper", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the right bumper button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right bumper button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.PS4Controller", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "rightStick", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the right stick button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right stick button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "isConnected", + "returnType": "bool", + "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" }, { "defaultValue": "", @@ -28853,10 +12094,10 @@ "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "rightTrigger", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "options", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the right trigger button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right trigger button's\n digital signal attached to the given loop." + "tooltip": "Constructs an event instance around the options button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the options button's\n digital signal attached to the given loop." }, { "args": [ @@ -28868,7 +12109,7 @@ { "defaultValue": "", "name": "outputNumber", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -28891,7 +12132,7 @@ { "defaultValue": "", "name": "value", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.interfaces.GenericHID", @@ -28914,7 +12155,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.interfaces.GenericHID", @@ -28927,7 +12168,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.StadiaController" + "type": "wpilib.PS4Controller" }, { "defaultValue": "", @@ -28935,10 +12176,64 @@ "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.StadiaController", - "functionName": "stadia", + "declaringClassName": "wpilib.PS4Controller", + "functionName": "share", "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the stadia button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the stadia button's\n digital signal attached to the given loop." + "tooltip": "Constructs an event instance around the share button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the share button's\n digital signal attached to the given loop." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PS4Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" + } + ], + "declaringClassName": "wpilib.PS4Controller", + "functionName": "square", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the square button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the square button's\n digital signal attached to the given loop." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PS4Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" + } + ], + "declaringClassName": "wpilib.PS4Controller", + "functionName": "touchpad", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the touchpad button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the touchpad button's\n digital signal attached to the given loop." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PS4Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" + } + ], + "declaringClassName": "wpilib.PS4Controller", + "functionName": "triangle", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the triangle button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the triangle button's\n digital signal attached to the given loop." } ], "instanceVariables": [], @@ -28946,8 +12241,14 @@ "staticMethods": [] }, { - "className": "wpilib.StadiaController.Axis", + "className": "wpilib.PS4Controller.Axis", "classVariables": [ + { + "name": "kL2", + "tooltip": "", + "type": "int", + "writable": false + }, { "name": "kLeftX", "tooltip": "", @@ -28960,6 +12261,12 @@ "type": "int", "writable": false }, + { + "name": "kR2", + "tooltip": "", + "type": "int", + "writable": false + }, { "name": "kRightX", "tooltip": "", @@ -28976,9 +12283,9 @@ "constructors": [ { "args": [], - "declaringClassName": "wpilib.StadiaController.Axis", + "declaringClassName": "wpilib.PS4Controller.Axis", "functionName": "__init__", - "returnType": "wpilib.StadiaController.Axis", + "returnType": "wpilib.PS4Controller.Axis", "tooltip": "" } ], @@ -28989,94 +12296,88 @@ "staticMethods": [] }, { - "className": "wpilib.StadiaController.Button", + "className": "wpilib.PS4Controller.Button", "classVariables": [ { - "name": "kA", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kB", + "name": "kCircle", "tooltip": "", "type": "int", "writable": false }, { - "name": "kEllipses", + "name": "kCross", "tooltip": "", "type": "int", "writable": false }, { - "name": "kFrame", + "name": "kL1", "tooltip": "", "type": "int", "writable": false }, { - "name": "kGoogle", + "name": "kL2", "tooltip": "", "type": "int", "writable": false }, { - "name": "kHamburger", + "name": "kL3", "tooltip": "", "type": "int", "writable": false }, { - "name": "kLeftBumper", + "name": "kOptions", "tooltip": "", "type": "int", "writable": false }, { - "name": "kLeftStick", + "name": "kPS", "tooltip": "", "type": "int", "writable": false }, { - "name": "kLeftTrigger", + "name": "kR1", "tooltip": "", "type": "int", "writable": false }, { - "name": "kRightBumper", + "name": "kR2", "tooltip": "", "type": "int", "writable": false }, { - "name": "kRightStick", + "name": "kR3", "tooltip": "", "type": "int", "writable": false }, { - "name": "kRightTrigger", + "name": "kShare", "tooltip": "", "type": "int", "writable": false }, { - "name": "kStadia", + "name": "kSquare", "tooltip": "", "type": "int", "writable": false }, { - "name": "kX", + "name": "kTouchpad", "tooltip": "", "type": "int", "writable": false }, { - "name": "kY", + "name": "kTriangle", "tooltip": "", "type": "int", "writable": false @@ -29085,9 +12386,9 @@ "constructors": [ { "args": [], - "declaringClassName": "wpilib.StadiaController.Button", + "declaringClassName": "wpilib.PS4Controller.Button", "functionName": "__init__", - "returnType": "wpilib.StadiaController.Button", + "returnType": "wpilib.PS4Controller.Button", "tooltip": "" } ], @@ -29097,1992 +12398,1679 @@ "moduleName": "wpilib", "staticMethods": [] }, - { - "className": "wpilib.SynchronousInterrupt", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.SynchronousInterrupt", - "functionName": "__init__", - "returnType": "wpilib.SynchronousInterrupt", - "tooltip": "Construct a Synchronous Interrupt from a Digital Source.\n\n:param source: the DigitalSource the interrupts are triggered from" - }, - { - "args": [ - { - "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.SynchronousInterrupt", - "functionName": "__init__", - "returnType": "wpilib.SynchronousInterrupt", - "tooltip": "Construct a Synchronous Interrupt from a Digital Source.\n\n:param source: the DigitalSource the interrupts are triggered from" - }, - { - "args": [ - { - "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.SynchronousInterrupt", - "functionName": "__init__", - "returnType": "wpilib.SynchronousInterrupt", - "tooltip": "Construct a Synchronous Interrupt from a Digital Source.\n\n:param source: the DigitalSource the interrupts are triggered from" - } - ], - "enums": [ - { - "enumClassName": "wpilib.SynchronousInterrupt.WaitResult", - "enumValues": [ - "kBoth", - "kFallingEdge", - "kRisingEdge", - "kTimeout" - ], - "moduleName": "wpilib", - "tooltip": "Event trigger combinations for a synchronous interrupt.\n\nMembers:\n\n kTimeout : Timeout event.\n\n kRisingEdge : Rising edge event.\n\n kFallingEdge : Falling edge event.\n\n kBoth : Both rising and falling edge events." - } - ], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.SynchronousInterrupt" - } - ], - "declaringClassName": "wpilib.SynchronousInterrupt", - "functionName": "getFallingTimestamp", - "returnType": "wpimath.units.seconds", - "tooltip": "Get the timestamp of the last falling edge.\n\nThis function does not require the interrupt to be enabled to work.\n\nThis only works if falling edge was configured using setInterruptEdges.\n\n:returns: the timestamp in seconds relative to getFPGATime" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.SynchronousInterrupt" - } - ], - "declaringClassName": "wpilib.SynchronousInterrupt", - "functionName": "getRisingTimestamp", - "returnType": "wpimath.units.seconds", - "tooltip": "Get the timestamp (relative to FPGA Time) of the last rising edge.\n\n:returns: the timestamp in seconds relative to getFPGATime" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.SynchronousInterrupt" - }, - { - "defaultValue": "", - "name": "risingEdge", - "type": "bool" - }, - { - "defaultValue": "", - "name": "fallingEdge", - "type": "bool" - } - ], - "declaringClassName": "wpilib.SynchronousInterrupt", - "functionName": "setInterruptEdges", - "returnType": "None", - "tooltip": "Set which edges cause an interrupt to occur.\n\n:param risingEdge: true to trigger on rising edge, false otherwise.\n:param fallingEdge: true to trigger on falling edge, false otherwise" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.SynchronousInterrupt" - }, - { - "defaultValue": "", - "name": "timeout", - "type": "wpimath.units.seconds" - }, - { - "defaultValue": "True", - "name": "ignorePrevious", - "type": "bool" - } - ], - "declaringClassName": "wpilib.SynchronousInterrupt", - "functionName": "waitForInterrupt", - "returnType": "wpilib.SynchronousInterrupt.WaitResult", - "tooltip": "Wait for an interrupt to occur.\n\nBoth rising and falling edge can be returned if both a rising and\nfalling happened between calls, and ignorePrevious is false.\n\n:param timeout: The timeout to wait for. 0s or less will return immediately.\n:param ignorePrevious: True to ignore any previous interrupts, false to\n return interrupt value if an interrupt has occurred since last call.\n\n:returns: The edge(s) that were triggered, or timeout." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.SynchronousInterrupt" - } - ], - "declaringClassName": "wpilib.SynchronousInterrupt", - "functionName": "wakeupWaitingInterrupt", - "returnType": "None", - "tooltip": "Wake up an existing wait call. Can be called from any thread." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.Talon", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.Talon", - "functionName": "__init__", - "returnType": "wpilib.Talon", - "tooltip": "Constructor for a Talon connected via PWM.\n\n:param channel: The PWM channel that the Talon is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getChannel", - "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" - } - ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", - "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." - }, + { + "className": "wpilib.PS5Controller", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" + "name": "port", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." - }, + "declaringClassName": "wpilib.PS5Controller", + "functionName": "__init__", + "returnType": "wpilib.PS5Controller", + "tooltip": "Construct an instance of a controller.\n\nThe controller index is the USB port on the Driver Station.\n\n:param port: The port on the Driver Station that the controller is plugged\n into (0-5)." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PS5Controller" }, { "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "L1", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the left trigger 1 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left trigger 1 button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.PS5Controller" }, { "defaultValue": "", - "name": "isInverted", - "type": "bool" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.PS5Controller", + "functionName": "L2", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the left trigger 2 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left trigger 2 button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PS5Controller" }, { "defaultValue": "", - "name": "enabled", - "type": "bool" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "L3", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the L3 (left stick) button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the L3 (left stick) button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." - }, - { - "args": [ + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.Talon", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.TimedRobot", - "classVariables": [ - { - "name": "kDefaultPeriod", - "tooltip": "", - "type": "float", - "writable": false - } - ], - "constructors": [ - { - "args": [ - { - "defaultValue": "0.02", - "name": "period", - "type": "wpimath.units.seconds" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "__init__", - "returnType": "wpilib.TimedRobot", - "tooltip": "Constructor for TimedRobot.\n\n:param period: Period." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POV", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.TimedRobot" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "callback", - "type": "Callable[[], None]" + "name": "pov", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "period", - "type": "wpimath.units.seconds" + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" }, { - "defaultValue": "0.0", - "name": "offset", - "type": "wpimath.units.seconds" + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "addPeriodic", - "returnType": "None", - "tooltip": "Add a callback to run at a specific period with a starting time offset.\n\nThis is scheduled on TimedRobot's Notifier, so TimedRobot and the callback\nrun synchronously. Interactions between them are thread-safe.\n\n:param callback: The callback to run.\n:param period: The period at which to run the callback.\n:param offset: The offset from the common starting time. This is useful\n for scheduling a callback in a different timeslot relative\n to TimedRobot." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POV", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "autonomousExit", - "returnType": "None", - "tooltip": "Exit code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits autonomous mode." - }, - { - "args": [ + "type": "wpilib.interfaces.GenericHID" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "autonomousInit", - "returnType": "None", - "tooltip": "Initialization code for autonomous mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters autonomous mode." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVCenter", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the center (not pressed) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the center of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" - } - ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "autonomousPeriodic", - "returnType": "None", - "tooltip": "Periodic code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in\nautonomous mode." - }, - { - "args": [ + "type": "wpilib.interfaces.GenericHID" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.IterativeRobotBase" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "disabledExit", - "returnType": "None", - "tooltip": "Exit code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits disabled mode." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDown", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "disabledInit", - "returnType": "None", - "tooltip": "Initialization code for disabled mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time\nthe robot enters disabled mode." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDownLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down left direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "disabledPeriodic", - "returnType": "None", - "tooltip": "Periodic code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in disabled\nmode." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDownRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "driverStationConnected", - "returnType": "None", - "tooltip": "Code that needs to know the DS state should go here.\n\nUsers should override this method for initialization that needs to occur\nafter the DS is connected, such as needing the alliance information." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the left direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "testLW", - "type": "bool" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "enableLiveWindowInTest", - "returnType": "None", - "tooltip": "Sets whether LiveWindow operation is enabled during test mode.\n\n:param testLW: True to enable, false to disable. Defaults to false.\n @throws if called in test mode." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the right direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.TimedRobot" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "endCompetition", - "returnType": "None", - "tooltip": "Ends the main loop in StartCompetition()." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUp", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up direction of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up direction of a POV on\n the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "getControlState", - "returnType": "tuple[bool, bool, bool]", - "tooltip": "More efficient way to determine what state the robot is in.\n\n:returns: booleans representing enabled, isautonomous, istest\n\n.. versionadded:: 2019.2.1\n\n.. note:: This function only exists in RobotPy" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUpLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up left direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.TimedRobot" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "getLoopStartTime", - "returnType": "int", - "tooltip": "Return the system clock time in micrseconds for the start of the current\nperiodic loop. This is in the same time base as Timer.GetFPGATimestamp(),\nbut is stable through a loop. It is updated at the beginning of every\nperiodic callback (including the normal periodic loop).\n\n:returns: Robot running time in microseconds, as of the start of the current\n periodic function." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUpRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "getPeriod", - "returnType": "wpimath.units.seconds", - "tooltip": "Gets time period between calls to Periodic() functions." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "PS", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the PlayStation button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the PlayStation button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isAutonomous", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Autonomous mode.\n\n:returns: True if the robot is currently operating Autonomously as determined\n by the Driver Station." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "R1", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the right trigger 1 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right trigger 1 button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isAutonomousEnabled", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Autonomous mode and enabled.\n\n:returns: True if the robot us currently operating Autonomously while enabled\n as determined by the Driver Station." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "R2", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the right trigger 2 button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right trigger 2 button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isDisabled", - "returnType": "bool", - "tooltip": "Determine if the Robot is currently disabled.\n\n:returns: True if the Robot is currently disabled by the Driver Station." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "R3", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the R3 (right stick) button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the R3 (right stick) button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "axis", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "threshold", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isEnabled", - "returnType": "bool", - "tooltip": "Determine if the Robot is currently enabled.\n\n:returns: True if the Robot is currently enabled by the Driver Station." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "axisGreaterThan", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance that is true when the axis value is greater\nthan threshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value above which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is greater than\n the provided threshold." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "axis", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "threshold", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "isLiveWindowEnabledInTest", - "returnType": "bool", - "tooltip": "Whether LiveWindow operation is enabled during test mode." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "axisLessThan", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance that is true when the axis value is less than\nthreshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value below which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is less than the\n provided threshold." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "button", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTeleop", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Operator Control mode.\n\n:returns: True if the robot is currently operating in Tele-Op mode as\n determined by the Driver Station." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "button", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around this button's digital signal.\n\n:param button: the button index\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the button's digital signal attached\n to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTeleopEnabled", - "returnType": "bool", - "tooltip": "Determine if the robot is current in Operator Control mode and enabled.\n\n:returns: True if the robot is currently operating in Tele-Op mode while\n enabled as determined by the Driver Station." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "circle", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the circle button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the circle button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTest", - "returnType": "bool", - "tooltip": "Determine if the robot is currently in Test mode.\n\n:returns: True if the robot is currently running in Test mode as determined\n by the Driver Station." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "create", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the create button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the create button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTestEnabled", - "returnType": "bool", - "tooltip": "Determine if the robot is current in Test mode and enabled.\n\n:returns: True if the robot is currently operating in Test mode while\n enabled as determined by the Driver Station." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "cross", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the cross button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the cross button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "printWatchdogEpochs", - "returnType": "None", - "tooltip": "Prints list of epochs added so far and their times." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getAxisCount", + "returnType": "int", + "tooltip": "Get the number of axes for the HID.\n\n:returns: the number of axis for the current HID" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "robotInit", - "returnType": "None", - "tooltip": "Robot-wide initialization code should go here.\n\nUsers should override this method for default Robot-wide initialization\nwhich will be called when the robot is first powered on. It will be called\nexactly one time.\n\nNote: This method is functionally identical to the class constructor so\nthat should be used instead." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getAxisType", + "returnType": "int", + "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "robotPeriodic", - "returnType": "None", - "tooltip": "Periodic code for all modes should go here.\n\nThis function is called each time a new packet is received from the driver\nstation." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getButtonCount", + "returnType": "int", + "tooltip": "Get the number of buttons for the HID.\n\n:returns: the number of buttons on the current HID" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "setNetworkTablesFlushEnabled", - "returnType": "None", - "tooltip": "Enables or disables flushing NetworkTables every loop iteration.\nBy default, this is enabled.\n\n:deprecated: Deprecated without replacement.\n\n:param enabled: True to enable, false to disable" + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getCircleButton", + "returnType": "bool", + "tooltip": "Read the value of the circle button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.TimedRobot" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "startCompetition", - "returnType": "None", - "tooltip": "Provide an alternate \"main loop\" via StartCompetition()." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getCircleButtonPressed", + "returnType": "bool", + "tooltip": "Whether the circle button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "teleopExit", - "returnType": "None", - "tooltip": "Exit code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits teleop mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getCircleButtonReleased", + "returnType": "bool", + "tooltip": "Whether the circle button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "teleopInit", - "returnType": "None", - "tooltip": "Initialization code for teleop mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters teleop mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getCreateButton", + "returnType": "bool", + "tooltip": "Read the value of the create button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "teleopPeriodic", - "returnType": "None", - "tooltip": "Periodic code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in teleop\nmode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getCreateButtonPressed", + "returnType": "bool", + "tooltip": "Whether the create button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "testExit", - "returnType": "None", - "tooltip": "Exit code for test mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits test mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getCreateButtonReleased", + "returnType": "bool", + "tooltip": "Whether the create button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "testInit", - "returnType": "None", - "tooltip": "Initialization code for test mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters test mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getCrossButton", + "returnType": "bool", + "tooltip": "Read the value of the cross button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "testPeriodic", - "returnType": "None", - "tooltip": "Periodic code for test mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in test\nmode." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "getRuntimeType", - "returnType": "wpilib.RuntimeType", - "tooltip": "Get the current runtime type.\n\n:returns: Current runtime type." - }, - { - "args": [], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "isReal", - "returnType": "bool", - "tooltip": "Get if the robot is real.\n\n:returns: If the robot is running in the real world." - }, - { - "args": [], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "isSimulation", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getCrossButtonPressed", "returnType": "bool", - "tooltip": "Get if the robot is a simulation.\n\n:returns: If the robot is running in simulation." + "tooltip": "Whether the cross button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", - "name": "robot_cls", - "type": "object" + "name": "self", + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "main", - "returnType": "object", - "tooltip": "Starting point for the application" - } - ] - }, - { - "className": "wpilib.Timer", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.Timer", - "functionName": "__init__", - "returnType": "wpilib.Timer", - "tooltip": "Create a new timer object.\n\nCreate a new timer object and reset the time to zero. The timer is\ninitially not running and must be started." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getCrossButtonReleased", + "returnType": "bool", + "tooltip": "Whether the cross button was released since the last check.\n\n:returns: Whether the button was released since the last check." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Timer" - }, - { - "defaultValue": "", - "name": "period", - "type": "wpimath.units.seconds" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Timer", - "functionName": "advanceIfElapsed", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getL1Button", "returnType": "bool", - "tooltip": "Check if the period specified has passed and if it has, advance the start\ntime by that period. This is useful to decide if it's time to do periodic\nwork without drifting later by the time it took to get around to checking.\n\n:param period: The period to check for.\n\n:returns: True if the period has passed." + "tooltip": "Read the value of the left trigger 1 button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Timer" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Timer", - "functionName": "get", - "returnType": "wpimath.units.seconds", - "tooltip": "Get the current time from the timer. If the clock is running it is derived\nfrom the current system clock the start time stored in the timer class. If\nthe clock is not running, then return the time when it was last stopped.\n\n:returns: Current time value for this timer in seconds" + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getL1ButtonPressed", + "returnType": "bool", + "tooltip": "Whether the left trigger 1 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Timer" - }, - { - "defaultValue": "", - "name": "period", - "type": "wpimath.units.seconds" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Timer", - "functionName": "hasElapsed", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getL1ButtonReleased", "returnType": "bool", - "tooltip": "Check if the period specified has passed.\n\n:param period: The period to check.\n\n:returns: True if the period has passed." + "tooltip": "Whether the left trigger 1 button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Timer" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Timer", - "functionName": "isRunning", - "returnType": "bool", - "tooltip": "Whether the timer is currently running.\n\n:returns: true if running." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getL2Axis", + "returnType": "float", + "tooltip": "Get the left trigger 2 axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Timer" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Timer", - "functionName": "reset", - "returnType": "None", - "tooltip": "Reset the timer by setting the time to 0.\n\nMake the timer startTime the current time so new requests will be relative\nto now." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getL2Button", + "returnType": "bool", + "tooltip": "Read the value of the left trigger 2 button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Timer" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Timer", - "functionName": "restart", - "returnType": "None", - "tooltip": "Restart the timer by stopping the timer, if it is not already stopped,\nresetting the accumulated time, then starting the timer again. If you\nwant an event to periodically reoccur at some time interval from the\nstart time, consider using AdvanceIfElapsed() instead." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getL2ButtonPressed", + "returnType": "bool", + "tooltip": "Whether the left trigger 2 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Timer" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Timer", - "functionName": "start", - "returnType": "None", - "tooltip": "Start the timer running.\n\nJust set the running flag to true indicating that all time requests should\nbe relative to the system clock. Note that this method is a no-op if the\ntimer is already running." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getL2ButtonReleased", + "returnType": "bool", + "tooltip": "Whether the left trigger 2 button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Timer" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Timer", - "functionName": "stop", - "returnType": "None", - "tooltip": "Stop the timer.\n\nThis computes the time as of now and clears the running flag, causing all\nsubsequent time requests to be read from the accumulated time rather than\nlooking at the system clock." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.Timer", - "functionName": "getFPGATimestamp", - "returnType": "wpimath.units.seconds", - "tooltip": "Return the FPGA system clock time in seconds.\n\nReturn the time from the FPGA hardware clock in seconds since the FPGA\nstarted. Rolls over after 71 minutes.\n\n:returns: Robot running time in seconds." - }, - { - "args": [], - "declaringClassName": "wpilib.Timer", - "functionName": "getMatchTime", - "returnType": "wpimath.units.seconds", - "tooltip": "Return the approximate match time.\n\nThe FMS does not send an official match time to the robots, but does send\nan approximate match time. The value will count down the time remaining in\nthe current period (auto or teleop).\n\nWarning: This is not an official time (so it cannot be used to dispute ref\ncalls or guarantee that a function will trigger before the match ends).\n\nThe Practice Match function of the DS approximates the behavior seen on the\nfield.\n\n:returns: Time remaining in current match period (auto or teleop)" + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getL3Button", + "returnType": "bool", + "tooltip": "Read the value of the L3 (left stick) button on the controller.\n\n:returns: The state of the button." }, - { - "args": [], - "declaringClassName": "wpilib.Timer", - "functionName": "getTimestamp", - "returnType": "wpimath.units.seconds", - "tooltip": "Return the clock time in seconds. By default, the time is based on the FPGA\nhardware clock in seconds since the FPGA started. However, the return value\nof this method may be modified to use any time base, including\nnon-monotonic time bases.\n\n:returns: Robot running time in seconds." - } - ] - }, - { - "className": "wpilib.TimesliceRobot", - "classVariables": [ - { - "name": "kDefaultPeriod", - "tooltip": "", - "type": "float", - "writable": false - } - ], - "constructors": [ { "args": [ { "defaultValue": "", - "name": "robotPeriodicAllocation", - "type": "wpimath.units.seconds" - }, - { - "defaultValue": "", - "name": "controllerPeriod", - "type": "wpimath.units.seconds" + "name": "self", + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.TimesliceRobot", - "functionName": "__init__", - "returnType": "wpilib.TimesliceRobot", - "tooltip": "Constructor for TimesliceRobot.\n\n:param robotPeriodicAllocation: The allocation to give the TimesliceRobot\n periodic functions.\n:param controllerPeriod: The controller period. The sum of all scheduler\n allocations should be less than or equal to this\n value." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getL3ButtonPressed", + "returnType": "bool", + "tooltip": "Whether the L3 (left stick) button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.TimedRobot" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[], None]" - }, - { - "defaultValue": "", - "name": "period", - "type": "wpimath.units.seconds" - }, - { - "defaultValue": "0.0", - "name": "offset", - "type": "wpimath.units.seconds" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "addPeriodic", - "returnType": "None", - "tooltip": "Add a callback to run at a specific period with a starting time offset.\n\nThis is scheduled on TimedRobot's Notifier, so TimedRobot and the callback\nrun synchronously. Interactions between them are thread-safe.\n\n:param callback: The callback to run.\n:param period: The period at which to run the callback.\n:param offset: The offset from the common starting time. This is useful\n for scheduling a callback in a different timeslot relative\n to TimedRobot." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getL3ButtonReleased", + "returnType": "bool", + "tooltip": "Whether the L3 (left stick) button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "autonomousExit", - "returnType": "None", - "tooltip": "Exit code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits autonomous mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getLeftX", + "returnType": "float", + "tooltip": "Get the X axis value of left side of the controller. Right is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "autonomousInit", - "returnType": "None", - "tooltip": "Initialization code for autonomous mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters autonomous mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getLeftY", + "returnType": "float", + "tooltip": "Get the Y axis value of left side of the controller. Back is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "autonomousPeriodic", - "returnType": "None", - "tooltip": "Periodic code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in\nautonomous mode." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getName", + "returnType": "str", + "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "disabledExit", - "returnType": "None", - "tooltip": "Exit code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits disabled mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getOptionsButton", + "returnType": "bool", + "tooltip": "Read the value of the options button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "disabledInit", - "returnType": "None", - "tooltip": "Initialization code for disabled mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time\nthe robot enters disabled mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getOptionsButtonPressed", + "returnType": "bool", + "tooltip": "Whether the options button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "disabledPeriodic", - "returnType": "None", - "tooltip": "Periodic code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in disabled\nmode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getOptionsButtonReleased", + "returnType": "bool", + "tooltip": "Whether the options button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "0", + "name": "pov", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "driverStationConnected", - "returnType": "None", - "tooltip": "Code that needs to know the DS state should go here.\n\nUsers should override this method for initialization that needs to occur\nafter the DS is connected, such as needing the alliance information." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPOV", + "returnType": "wpilib.DriverStation.POVDirection", + "tooltip": "Get the angle of a POV on the HID.\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" - }, - { - "defaultValue": "", - "name": "testLW", - "type": "bool" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "enableLiveWindowInTest", - "returnType": "None", - "tooltip": "Sets whether LiveWindow operation is enabled during test mode.\n\n:param testLW: True to enable, false to disable. Defaults to false.\n @throws if called in test mode." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPOVCount", + "returnType": "int", + "tooltip": "Get the number of POVs for the HID.\n\n:returns: the number of POVs for the current HID" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.TimedRobot" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "endCompetition", - "returnType": "None", - "tooltip": "Ends the main loop in StartCompetition()." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getPSButton", + "returnType": "bool", + "tooltip": "Read the value of the PlayStation button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "getControlState", - "returnType": "tuple[bool, bool, bool]", - "tooltip": "More efficient way to determine what state the robot is in.\n\n:returns: booleans representing enabled, isautonomous, istest\n\n.. versionadded:: 2019.2.1\n\n.. note:: This function only exists in RobotPy" + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getPSButtonPressed", + "returnType": "bool", + "tooltip": "Whether the PlayStation button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.TimedRobot" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "getLoopStartTime", - "returnType": "int", - "tooltip": "Return the system clock time in micrseconds for the start of the current\nperiodic loop. This is in the same time base as Timer.GetFPGATimestamp(),\nbut is stable through a loop. It is updated at the beginning of every\nperiodic callback (including the normal periodic loop).\n\n:returns: Robot running time in microseconds, as of the start of the current\n periodic function." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getPSButtonReleased", + "returnType": "bool", + "tooltip": "Whether the PlayStation button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "getPeriod", - "returnType": "wpimath.units.seconds", - "tooltip": "Gets time period between calls to Periodic() functions." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPort", + "returnType": "int", + "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isAutonomous", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getR1Button", "returnType": "bool", - "tooltip": "Determine if the robot is currently in Autonomous mode.\n\n:returns: True if the robot is currently operating Autonomously as determined\n by the Driver Station." + "tooltip": "Read the value of the right trigger 1 button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isAutonomousEnabled", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getR1ButtonPressed", "returnType": "bool", - "tooltip": "Determine if the robot is currently in Autonomous mode and enabled.\n\n:returns: True if the robot us currently operating Autonomously while enabled\n as determined by the Driver Station." + "tooltip": "Whether the right trigger 1 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isDisabled", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getR1ButtonReleased", "returnType": "bool", - "tooltip": "Determine if the Robot is currently disabled.\n\n:returns: True if the Robot is currently disabled by the Driver Station." + "tooltip": "Whether the right trigger 1 button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isEnabled", - "returnType": "bool", - "tooltip": "Determine if the Robot is currently enabled.\n\n:returns: True if the Robot is currently enabled by the Driver Station." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getR2Axis", + "returnType": "float", + "tooltip": "Get the right trigger 2 axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "isLiveWindowEnabledInTest", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getR2Button", "returnType": "bool", - "tooltip": "Whether LiveWindow operation is enabled during test mode." + "tooltip": "Read the value of the right trigger 2 button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTeleop", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getR2ButtonPressed", "returnType": "bool", - "tooltip": "Determine if the robot is currently in Operator Control mode.\n\n:returns: True if the robot is currently operating in Tele-Op mode as\n determined by the Driver Station." + "tooltip": "Whether the right trigger 2 button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTeleopEnabled", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getR2ButtonReleased", "returnType": "bool", - "tooltip": "Determine if the robot is current in Operator Control mode and enabled.\n\n:returns: True if the robot is currently operating in Tele-Op mode while\n enabled as determined by the Driver Station." + "tooltip": "Whether the right trigger 2 button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTest", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getR3Button", "returnType": "bool", - "tooltip": "Determine if the robot is currently in Test mode.\n\n:returns: True if the robot is currently running in Test mode as determined\n by the Driver Station." + "tooltip": "Read the value of the R3 (right stick) button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.RobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.RobotBase", - "functionName": "isTestEnabled", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getR3ButtonPressed", "returnType": "bool", - "tooltip": "Determine if the robot is current in Test mode and enabled.\n\n:returns: True if the robot is currently operating in Test mode while\n enabled as determined by the Driver Station." + "tooltip": "Whether the R3 (right stick) button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "printWatchdogEpochs", - "returnType": "None", - "tooltip": "Prints list of epochs added so far and their times." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getR3ButtonReleased", + "returnType": "bool", + "tooltip": "Whether the R3 (right stick) button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "robotInit", - "returnType": "None", - "tooltip": "Robot-wide initialization code should go here.\n\nUsers should override this method for default Robot-wide initialization\nwhich will be called when the robot is first powered on. It will be called\nexactly one time.\n\nNote: This method is functionally identical to the class constructor so\nthat should be used instead." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawAxis", + "returnType": "float", + "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "robotPeriodic", - "returnType": "None", - "tooltip": "Periodic code for all modes should go here.\n\nThis function is called each time a new packet is received from the driver\nstation." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButton", + "returnType": "bool", + "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.TimesliceRobot" - }, - { - "defaultValue": "", - "name": "func", - "type": "Callable[[], None]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "allocation", - "type": "wpimath.units.seconds" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.TimesliceRobot", - "functionName": "schedule", - "returnType": "None", - "tooltip": "Schedule a periodic function with the constructor's controller period and\nthe given allocation. The function's runtime allocation will be placed\nafter the end of the previous one's.\n\nIf a call to this function makes the allocations exceed the controller\nperiod, an exception will be thrown since that means the TimesliceRobot\nperiodic functions and the given function will have conflicting\ntimeslices.\n\n:param func: Function to schedule.\n:param allocation: The function's runtime allocation out of the controller\n period." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonPressed", + "returnType": "bool", + "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "enabled", - "type": "bool" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "setNetworkTablesFlushEnabled", - "returnType": "None", - "tooltip": "Enables or disables flushing NetworkTables every loop iteration.\nBy default, this is enabled.\n\n:deprecated: Deprecated without replacement.\n\n:param enabled: True to enable, false to disable" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonReleased", + "returnType": "bool", + "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.TimedRobot" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.TimedRobot", - "functionName": "startCompetition", - "returnType": "None", - "tooltip": "Provide an alternate \"main loop\" via StartCompetition()." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getRightX", + "returnType": "float", + "tooltip": "Get the X axis value of right side of the controller. Right is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "teleopExit", - "returnType": "None", - "tooltip": "Exit code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits teleop mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getRightY", + "returnType": "float", + "tooltip": "Get the Y axis value of right side of the controller. Back is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "teleopInit", - "returnType": "None", - "tooltip": "Initialization code for teleop mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters teleop mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getSquareButton", + "returnType": "bool", + "tooltip": "Read the value of the square button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "teleopPeriodic", - "returnType": "None", - "tooltip": "Periodic code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in teleop\nmode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getSquareButtonPressed", + "returnType": "bool", + "tooltip": "Whether the square button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "testExit", - "returnType": "None", - "tooltip": "Exit code for test mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits test mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getSquareButtonReleased", + "returnType": "bool", + "tooltip": "Whether the square button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "testInit", - "returnType": "None", - "tooltip": "Initialization code for test mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters test mode." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getTouchpad", + "returnType": "bool", + "tooltip": "Read the value of the touchpad button on the controller.\n\n:deprecated: Use GetTouchpadButton instead. This function is deprecated for\n removal to make function names consistent to allow the HID classes to be\n automatically generated.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.IterativeRobotBase" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.IterativeRobotBase", - "functionName": "testPeriodic", - "returnType": "None", - "tooltip": "Periodic code for test mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in test\nmode." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.TimesliceRobot", - "functionName": "getRuntimeType", - "returnType": "wpilib.RuntimeType", - "tooltip": "Get the current runtime type.\n\n:returns: Current runtime type." - }, - { - "args": [], - "declaringClassName": "wpilib.TimesliceRobot", - "functionName": "isReal", - "returnType": "bool", - "tooltip": "Get if the robot is real.\n\n:returns: If the robot is running in the real world." - }, - { - "args": [], - "declaringClassName": "wpilib.TimesliceRobot", - "functionName": "isSimulation", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getTouchpadButton", "returnType": "bool", - "tooltip": "Get if the robot is a simulation.\n\n:returns: If the robot is running in simulation." + "tooltip": "Read the value of the touchpad button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", - "name": "robot_cls", - "type": "object" + "name": "self", + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.TimesliceRobot", - "functionName": "main", - "returnType": "object", - "tooltip": "Starting point for the application" - } - ] - }, - { - "className": "wpilib.Tracer", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.Tracer", - "functionName": "__init__", - "returnType": "wpilib.Tracer", - "tooltip": "Constructs a Tracer instance." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getTouchpadButtonPressed", + "returnType": "bool", + "tooltip": "Whether the touchpad button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Tracer" - }, - { - "defaultValue": "", - "name": "epochName", - "type": "str" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Tracer", - "functionName": "addEpoch", - "returnType": "None", - "tooltip": "Adds time since last epoch to the list printed by PrintEpochs().\n\nEpochs are a way to partition the time elapsed so that when overruns occur,\none can determine which parts of an operation consumed the most time.\n\n:param epochName: The name to associate with the epoch." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getTouchpadButtonReleased", + "returnType": "bool", + "tooltip": "Whether the touchpad button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Tracer" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Tracer", - "functionName": "clearEpochs", - "returnType": "None", - "tooltip": "Clears all epochs." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getTouchpadPressed", + "returnType": "bool", + "tooltip": "Whether the touchpad was pressed since the last check.\n\n:deprecated: Use GetTouchpadButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the touchpad was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Tracer" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Tracer", - "functionName": "getEpochs", - "returnType": "str", - "tooltip": "Retreives list of epochs added so far as a string\n\n.. versionadded:: 2021.1.2\n\n.. note:: This function only exists in RobotPy" + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getTouchpadReleased", + "returnType": "bool", + "tooltip": "Whether the touchpad was released since the last check.\n\n:deprecated: Use GetLeftBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: Whether the touchpad was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Tracer" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Tracer", - "functionName": "printEpochs", - "returnType": "None", - "tooltip": "Prints list of epochs added so far and their times to the DriverStation." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getTriangleButton", + "returnType": "bool", + "tooltip": "Read the value of the triangle button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Tracer" + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Tracer", - "functionName": "resetTimer", - "returnType": "None", - "tooltip": "Restarts the epoch timer." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.Ultrasonic", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getTriangleButtonPressed", + "returnType": "bool", + "tooltip": "Whether the triangle button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + }, { "args": [ { "defaultValue": "", - "name": "pingChannel", - "type": "int" - }, - { - "defaultValue": "", - "name": "echoChannel", - "type": "int" + "name": "self", + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "__init__", - "returnType": "wpilib.Ultrasonic", - "tooltip": "Create an instance of the Ultrasonic Sensor.\n\nThis is designed to support the Daventech SRF04 and Vex ultrasonic sensors.\n\n:param pingChannel: The digital output channel that sends the pulse to\n initiate the sensor sending the ping.\n:param echoChannel: The digital input channel that receives the echo. The\n length of time that the echo is high represents the\n round trip time of the ping, and the distance." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "getTriangleButtonReleased", + "returnType": "bool", + "tooltip": "Whether the triangle button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", - "name": "pingChannel", - "type": "wpilib.DigitalOutput" - }, - { - "defaultValue": "", - "name": "echoChannel", - "type": "wpilib.DigitalInput" + "name": "self", + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "__init__", - "returnType": "wpilib.Ultrasonic", - "tooltip": "Create an instance of an Ultrasonic Sensor from a DigitalInput for the echo\nchannel and a DigitalOutput for the ping channel.\n\n:param pingChannel: The digital output object that starts the sensor doing a\n ping. Requires a 10uS pulse to start.\n:param echoChannel: The digital input object that times the return pulse to\n determine the range." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getType", + "returnType": "wpilib.interfaces.GenericHID.HIDType", + "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Ultrasonic" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "getEchoChannel", - "returnType": "int", - "tooltip": "Returns the echo channel.\n\n:returns: The echo channel." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Ultrasonic" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "getRange", - "returnType": "wpimath.units.meters", - "tooltip": "Get the range from the ultrasonic sensor.\n\n:returns: Range of the target returned from the ultrasonic sensor. If there\n is no valid value yet, i.e. at least one measurement hasn't\n completed, then return 0." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "isConnected", + "returnType": "bool", + "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Ultrasonic" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "getRangeInches", - "returnType": "wpimath.units.inches", - "tooltip": "" + "declaringClassName": "wpilib.PS5Controller", + "functionName": "options", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the options button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the options button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Ultrasonic" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "outputNumber", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "getRangeMM", - "returnType": "wpimath.units.millimeters", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setOutput", + "returnType": "None", + "tooltip": "Set a single HID output value for the HID.\n\n:param outputNumber: The index of the output to set (1-32)\n:param value: The value to set the output to" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Ultrasonic" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "initSendable", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setOutputs", "returnType": "None", - "tooltip": "" + "tooltip": "Set all output values for the HID.\n\n:param value: The 32 bit output value (1 bit for each output)" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Ultrasonic" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "type", + "type": "wpilib.interfaces.GenericHID.RumbleType" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "isEnabled", - "returnType": "bool", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setRumble", + "returnType": "None", + "tooltip": "Set the rumble output for the HID.\n\nThe DS currently supports 2 rumble values, left rumble and right rumble.\n\n:param type: Which rumble value to set\n:param value: The normalized value (0 to 1) to set the rumble to" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Ultrasonic" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "isRangeValid", - "returnType": "bool", - "tooltip": "Check if there is a valid range measurement.\n\nThe ranges are accumulated in a counter that will increment on each edge of\nthe echo (return) signal. If the count is not at least 2, then the range\nhas not yet been measured, and is invalid." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "square", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the square button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the square button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Ultrasonic" + "type": "wpilib.PS5Controller" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "ping", - "returnType": "None", - "tooltip": "Single ping to ultrasonic sensor.\n\nSend out a single ping to the ultrasonic sensor. This only works if\nautomatic (round robin) mode is disabled. A single ping is sent out, and\nthe counter should count the semi-period when it comes in. The counter is\nreset to make the current value invalid." + "declaringClassName": "wpilib.PS5Controller", + "functionName": "touchpad", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the touchpad button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the touchpad button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Ultrasonic" + "type": "wpilib.PS5Controller" }, { "defaultValue": "", - "name": "enable", - "type": "bool" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "setEnabled", - "returnType": "None", + "declaringClassName": "wpilib.PS5Controller", + "functionName": "triangle", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the triangle button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the triangle button's\n digital signal attached to the given loop." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.PS5Controller.Axis", + "classVariables": [ + { + "name": "kL2", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kLeftX", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kLeftY", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kR2", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightX", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightY", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.PS5Controller.Axis", + "functionName": "__init__", + "returnType": "wpilib.PS5Controller.Axis", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.PS5Controller.Button", + "classVariables": [ + { + "name": "kCircle", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kCreate", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kCross", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kL1", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kL2", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kL3", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kOptions", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kPS", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kR1", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kR2", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kR3", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kSquare", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kTouchpad", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kTriangle", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.PS5Controller.Button", + "functionName": "__init__", + "returnType": "wpilib.PS5Controller.Button", "tooltip": "" } ], + "enums": [], + "instanceMethods": [], "instanceVariables": [], "moduleName": "wpilib", - "staticMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "enabling", - "type": "bool" - } - ], - "declaringClassName": "wpilib.Ultrasonic", - "functionName": "setAutomaticMode", - "returnType": "None", - "tooltip": "Turn Automatic mode on/off.\n\nWhen in Automatic mode, all sensors will fire in round robin, waiting a set\ntime between each sensor.\n\n:param enabling: Set to true if round robin scheduling should start for all\n the ultrasonic sensors. This scheduling method assures that\n the sensors are non-interfering because no two sensors fire\n at the same time. If another scheduling algorithm is\n preferred, it can be implemented by pinging the sensors\n manually and waiting for the results to come back." - } - ] + "staticMethods": [] }, { - "className": "wpilib.Victor", + "className": "wpilib.PWM", "classVariables": [], "constructors": [ { @@ -31090,13 +14078,18 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" + }, + { + "defaultValue": "True", + "name": "registerSendable", + "type": "bool" } ], - "declaringClassName": "wpilib.Victor", + "declaringClassName": "wpilib.PWM", "functionName": "__init__", - "returnType": "wpilib.Victor", - "tooltip": "Constructor for a Victor 888 connected via PWM.\n\n:param channel: The PWM channel that the Victor 888 is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + "returnType": "wpilib.PWM", + "tooltip": "Allocate a PWM given a channel number.\n\nChecks channel value range and allocates the appropriate channel.\nThe allocation is only done to help users ensure that they don't double\nassign channels.\n\n:param channel: The PWM channel number. 0-9 are on-board, 10-19 are on the\n MXP port\n:param registerSendable: If true, adds this instance to SendableRegistry" } ], "enums": [], @@ -31106,98 +14099,10 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "follower", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "addFollower", - "returnType": "None", - "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "disable", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "eliminateDeadband", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "enableDeadbandElimination", - "returnType": "None", - "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.PWM" } ], - "declaringClassName": "wpilib.PWMMotorController", + "declaringClassName": "wpilib.PWM", "functionName": "getChannel", "returnType": "int", "tooltip": "" @@ -31207,52 +14112,13 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.PWM" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "getVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." + "declaringClassName": "wpilib.PWM", + "functionName": "getPulseTime", + "returnType": "wpimath.units.microseconds", + "tooltip": "Get the PWM pulse time directly from the hardware.\n\nRead a microsecond value from a PWM channel.\n\n:returns: Microsecond PWM control value." }, { "args": [ @@ -31277,159 +14143,150 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" + "type": "wpilib.PWM" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "set", + "declaringClassName": "wpilib.PWM", + "functionName": "setDisabled", "returnType": "None", - "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + "tooltip": "Temporarily disables the PWM output. The next set call will re-enable\nthe output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PWM" }, { "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" + "name": "mult", + "type": "wpilib.PWM.OutputPeriod" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", + "declaringClassName": "wpilib.PWM", + "functionName": "setOutputPeriod", "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "tooltip": "Sets the PWM output period.\n\n:param mult: The output period to apply to this channel" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.PWMMotorController" + "type": "wpilib.PWM" }, { "defaultValue": "", - "name": "isInverted", - "type": "bool" + "name": "time", + "type": "wpimath.units.microseconds" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", + "declaringClassName": "wpilib.PWM", + "functionName": "setPulseTime", "returnType": "None", - "tooltip": "" + "tooltip": "Set the PWM pulse time directly to the hardware.\n\nWrite a microsecond value to a PWM channel.\n\n:param time: Microsecond PWM value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PWM" }, { "defaultValue": "", - "name": "enabled", - "type": "bool" + "name": "device", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", + "declaringClassName": "wpilib.PWM", + "functionName": "setSimDevice", "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "tooltip": "Indicates this input is used by a simulated device.\n\n:param device: simulated device handle" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.PWM.OutputPeriod", + "classVariables": [ + { + "name": "kOutputPeriod_10Ms", + "tooltip": "", + "type": "wpilib.PWM.OutputPeriod", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + "name": "kOutputPeriod_20Ms", + "tooltip": "", + "type": "wpilib.PWM.OutputPeriod", + "writable": false }, + { + "name": "kOutputPeriod_5Ms", + "tooltip": "", + "type": "wpilib.PWM.OutputPeriod", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", + "declaringClassName": "wpilib.PWM.OutputPeriod", + "functionName": "__init__", + "returnType": "wpilib.PWM.OutputPeriod", "tooltip": "" } ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ + "enums": [], + "instanceMethods": [], + "instanceVariables": [ { - "args": [], - "declaringClassName": "wpilib.Victor", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false } - ] + ], + "moduleName": "wpilib", + "staticMethods": [] }, { - "className": "wpilib.VictorSP", + "className": "wpilib.PWMMotorController", "classVariables": [], "constructors": [ { "args": [ + { + "defaultValue": "", + "name": "name", + "type": "str" + }, { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.VictorSP", + "declaringClassName": "wpilib.PWMMotorController", "functionName": "__init__", - "returnType": "wpilib.VictorSP", - "tooltip": "Constructor for a Victor SP connected via PWM.\n\n:param channel: The PWM channel that the Victor SP is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + "returnType": "wpilib.PWMMotorController", + "tooltip": "Constructor for a PWM Motor %Controller connected via PWM.\n\n:param name: Name to use for SendableRegistry\n:param channel: The PWM channel that the controller is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" } ], "enums": [], @@ -31641,7 +14498,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.PWMMotorController", @@ -31654,290 +14511,115 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - }, - { - "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.PWMMotorController" - } - ], - "declaringClassName": "wpilib.PWMMotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.VictorSP", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." - } - ] - }, - { - "className": "wpilib.Watchdog", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "timeout", - "type": "wpimath.units.seconds" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[], None]" - } - ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "__init__", - "returnType": "wpilib.Watchdog", - "tooltip": "Watchdog constructor.\n\n:param timeout: The watchdog's timeout in seconds with microsecond\n resolution.\n:param callback: This function is called when the timeout expires." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Watchdog" - }, - { - "defaultValue": "", - "name": "epochName", - "type": "str" - } - ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "addEpoch", - "returnType": "None", - "tooltip": "Adds time since last epoch to the list printed by PrintEpochs().\n\nEpochs are a way to partition the time elapsed so that when overruns occur,\none can determine which parts of an operation consumed the most time.\n\n:param epochName: The name to associate with the epoch." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Watchdog" - } - ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "disable", - "returnType": "None", - "tooltip": "Disables the watchdog timer." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Watchdog" - } - ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "enable", - "returnType": "None", - "tooltip": "Enables the watchdog timer." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Watchdog" - } - ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "getTime", - "returnType": "wpimath.units.seconds", - "tooltip": "Returns the time since the watchdog was last fed." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.Watchdog" - } - ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "getTimeout", - "returnType": "wpimath.units.seconds", - "tooltip": "Returns the watchdog's timeout." - }, - { - "args": [ + "type": "wpilib.MotorSafety" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.Watchdog" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "isExpired", - "returnType": "bool", - "tooltip": "Returns true if the watchdog timer has expired." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Watchdog" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "printEpochs", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", "returnType": "None", - "tooltip": "Prints list of epochs added so far and their times." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Watchdog" + "type": "wpilib.MotorSafety" + }, + { + "defaultValue": "", + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "reset", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", "returnType": "None", - "tooltip": "Resets the watchdog timer.\n\nThis also enables the timer if it was previously disabled." + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Watchdog" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "timeout", - "type": "wpimath.units.seconds" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "setTimeout", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", "returnType": "None", - "tooltip": "Sets the watchdog's timeout.\n\n:param timeout: The watchdog's timeout in seconds with microsecond\n resolution." + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.Watchdog" - }, - { - "defaultValue": "", - "name": "suppress", - "type": "bool" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.Watchdog", - "functionName": "suppressTimeoutMessage", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", "returnType": "None", - "tooltip": "Enable or disable suppression of the generic timeout message.\n\nThis may be desirable if the user-provided callback already prints a more\nspecific message.\n\n:param suppress: Whether to suppress generic timeout message." + "tooltip": "" } ], "instanceVariables": [], "moduleName": "wpilib", - "staticMethods": [] + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] }, { - "className": "wpilib.XboxController", + "className": "wpilib.PWMSparkFlex", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "port", - "type": "int" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.XboxController", + "declaringClassName": "wpilib.PWMSparkFlex", "functionName": "__init__", - "returnType": "wpilib.XboxController", - "tooltip": "Construct an instance of a controller.\n\nThe controller index is the USB port on the Driver Station.\n\n:param port: The port on the Driver Station that the controller is plugged\n into (0-5)." + "returnType": "wpilib.PWMSparkFlex", + "tooltip": "Constructor for a SPARK Flex connected via PWM.\n\n:param channel: The PWM channel that the SPARK Flex is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" } ], "enums": [], @@ -31947,1131 +14629,1099 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "A", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the A button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the A button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "B", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the B button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the B button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "angle", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POV", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "pov", - "type": "int" - }, - { - "defaultValue": "", - "name": "angle", - "type": "int" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POV", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", + "returnType": "None", + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVCenter", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the center (not pressed) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the center of a POV on the\n HID." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDown", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 180 degree angle (down)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 180 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDownLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 225 degree angle (down\nleft) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 225 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDownRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 135 degree angle (right\ndown) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 135 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 270 degree angle (left)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 270 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 90 degree angle (right)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 90 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUp", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 0 degree angle (up) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 0 degree angle of a POV on\n the HID." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUpLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 315 degree angle (left\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 315 degree angle of a POV\n on the HID." + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUpRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 45 degree angle (right\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 45 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "X", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the X button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the X button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "Y", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the Y button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the Y button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "axisGreaterThan", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance that is true when the axis value is greater\nthan threshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value above which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is greater than\n the provided threshold." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "axisLessThan", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance that is true when the axis value is less than\nthreshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value below which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is less than the\n provided threshold." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "back", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the back button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the back button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", + "returnType": "None", + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "button", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around this button's digital signal.\n\n:param button: the button index\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the button's digital signal attached\n to the given loop." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.XboxController" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getAButton", - "returnType": "bool", - "tooltip": "Read the value of the A button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getAButtonPressed", - "returnType": "bool", - "tooltip": "Whether the A button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.XboxController" - } - ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getAButtonReleased", - "returnType": "bool", - "tooltip": "Whether the A button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, + "args": [], + "declaringClassName": "wpilib.PWMSparkFlex", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] + }, + { + "className": "wpilib.PWMSparkMax", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getAxisCount", - "returnType": "int", - "tooltip": "Get the number of axes for the HID.\n\n:returns: the number of axis for the current HID" - }, + "declaringClassName": "wpilib.PWMSparkMax", + "functionName": "__init__", + "returnType": "wpilib.PWMSparkMax", + "tooltip": "Constructor for a SPARK MAX connected via PWM.\n\n:param channel: The PWM channel that the SPARK MAX is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "axis", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getAxisType", - "returnType": "int", - "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.XboxController" - } - ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getBButton", - "returnType": "bool", - "tooltip": "Read the value of the B button on the controller.\n\n:returns: The state of the button." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.XboxController" - } - ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getBButtonPressed", - "returnType": "bool", - "tooltip": "Whether the B button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.XboxController" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getBButtonReleased", - "returnType": "bool", - "tooltip": "Whether the B button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getBackButton", - "returnType": "bool", - "tooltip": "Read the value of the back button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getBackButtonPressed", - "returnType": "bool", - "tooltip": "Whether the back button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getBackButtonReleased", - "returnType": "bool", - "tooltip": "Whether the back button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", + "returnType": "None", + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getButtonCount", - "returnType": "int", - "tooltip": "Get the number of buttons for the HID.\n\n:returns: the number of buttons on the current HID" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftBumper", - "returnType": "bool", - "tooltip": "Read the value of the left bumper (LB) button on the controller.\n\n:deprecated: Use GetLeftBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: the state of the button" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftBumperButton", - "returnType": "bool", - "tooltip": "Read the value of the left bumper button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftBumperButtonPressed", - "returnType": "bool", - "tooltip": "Whether the left bumper button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftBumperButtonReleased", - "returnType": "bool", - "tooltip": "Whether the left bumper button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftBumperPressed", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", "returnType": "bool", - "tooltip": "Whether the left bumper (LB) was pressed since the last check.\n\n:deprecated: Use GetLeftBumperButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was pressed since the last check" + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftBumperReleased", - "returnType": "bool", - "tooltip": "Whether the left bumper (LB) was released since the last check.\n\n:deprecated: Use GetLeftBumperButtonReleased instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was released since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpiutil.Sendable" + }, + { + "defaultValue": "", + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftStickButton", - "returnType": "bool", - "tooltip": "Read the value of the left stick button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftStickButtonPressed", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", "returnType": "bool", - "tooltip": "Whether the left stick button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftStickButtonReleased", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", "returnType": "bool", - "tooltip": "Whether the left stick button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftTriggerAxis", - "returnType": "float", - "tooltip": "Get the left trigger axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" + }, + { + "defaultValue": "", + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftX", - "returnType": "float", - "tooltip": "Get the X axis value of left side of the controller.\n\n:returns: the axis value." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getLeftY", - "returnType": "float", - "tooltip": "Get the Y axis value of left side of the controller.\n\n:returns: the axis value." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.MotorSafety" + }, + { + "defaultValue": "", + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getName", - "returnType": "str", - "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", + "returnType": "None", + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PWMMotorController" }, { - "defaultValue": "0", - "name": "pov", - "type": "int" + "defaultValue": "", + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPOV", - "returnType": "int", - "tooltip": "Get the angle in degrees of a POV on the HID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(e.g. right is 90, upper-left is 315).\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV in degrees, or -1 if the POV is not pressed." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPOVCount", - "returnType": "int", - "tooltip": "Get the number of POVs for the HID.\n\n:returns: the number of POVs for the current HID" - }, + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.PWMSparkMax", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] + }, + { + "className": "wpilib.PWMTalonFX", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPort", - "returnType": "int", - "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." - }, + "declaringClassName": "wpilib.PWMTalonFX", + "functionName": "__init__", + "returnType": "wpilib.PWMTalonFX", + "tooltip": "Constructor for a Talon FX connected via PWM.\n\n:param channel: The PWM channel that the Talon FX is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "axis", - "type": "int" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawAxis", - "returnType": "float", - "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, + "type": "wpilib.MotorSafety" + } + ], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + }, + { + "args": [ { "defaultValue": "", - "name": "button", - "type": "int" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButton", - "returnType": "bool", - "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "button", - "type": "int" + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonPressed", - "returnType": "bool", - "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", + "returnType": "None", + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonReleased", - "returnType": "bool", - "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightBumper", - "returnType": "bool", - "tooltip": "Read the value of the right bumper (RB) button on the controller.\n\n:deprecated: Use GetRightBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: the state of the button" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightBumperButton", - "returnType": "bool", - "tooltip": "Read the value of the right bumper button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightBumperButtonPressed", - "returnType": "bool", - "tooltip": "Whether the right bumper button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightBumperButtonReleased", - "returnType": "bool", - "tooltip": "Whether the right bumper button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightBumperPressed", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", "returnType": "bool", - "tooltip": "Whether the right bumper (RB) was pressed since the last check.\n\n:deprecated: Use GetRightBumperButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was pressed since the last check" + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightBumperReleased", - "returnType": "bool", - "tooltip": "Whether the right bumper (RB) was released since the last check.\n\n:deprecated: Use GetRightBumperButtonReleased instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was released since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpiutil.Sendable" + }, + { + "defaultValue": "", + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightStickButton", - "returnType": "bool", - "tooltip": "Read the value of the right stick button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightStickButtonPressed", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", "returnType": "bool", - "tooltip": "Whether the right stick button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightStickButtonReleased", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", "returnType": "bool", - "tooltip": "Whether the right stick button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightTriggerAxis", - "returnType": "float", - "tooltip": "Get the right trigger axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" + }, + { + "defaultValue": "", + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightX", - "returnType": "float", - "tooltip": "Get the X axis value of right side of the controller.\n\n:returns: the axis value." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getRightY", - "returnType": "float", - "tooltip": "Get the Y axis value of right side of the controller.\n\n:returns: the axis value." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" + }, + { + "defaultValue": "", + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getStartButton", - "returnType": "bool", - "tooltip": "Read the value of the start button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", + "returnType": "None", + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getStartButtonPressed", - "returnType": "bool", - "tooltip": "Whether the start button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getStartButtonReleased", - "returnType": "bool", - "tooltip": "Whether the start button was released since the last check.\n\n:returns: Whether the button was released since the last check." - }, + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.PWMTalonFX", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] + }, + { + "className": "wpilib.PWMTalonSRX", + "classVariables": [], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.PWMTalonSRX", + "functionName": "__init__", + "returnType": "wpilib.PWMTalonSRX", + "tooltip": "Constructor for a Talon SRX connected via PWM.\n\n:param channel: The PWM channel that the Talon SRX is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getType", - "returnType": "wpilib.interfaces.GenericHID.HIDType", - "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." - }, - { - "args": [ + "type": "wpilib.PWMMotorController" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.XboxController" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getXButton", - "returnType": "bool", - "tooltip": "Read the value of the X button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getXButtonPressed", - "returnType": "bool", - "tooltip": "Whether the X button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getXButtonReleased", - "returnType": "bool", - "tooltip": "Whether the X button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getYButton", - "returnType": "bool", - "tooltip": "Read the value of the Y button on the controller.\n\n:returns: The state of the button." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", + "returnType": "None", + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getYButtonPressed", - "returnType": "bool", - "tooltip": "Whether the Y button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "getYButtonReleased", - "returnType": "bool", - "tooltip": "Whether the Y button was released since the last check.\n\n:returns: Whether the button was released since the last check." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "initSendable", - "returnType": "None", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", "tooltip": "" }, { @@ -33079,478 +15729,229 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "isConnected", - "returnType": "bool", - "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "leftBumper", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the left bumper button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left bumper button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "leftStick", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the left stick button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left stick button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "leftTrigger", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the axis value of the left trigger.\nThe returned trigger will be true when the axis value is greater than\n``threshold``.\n\n:param threshold: the minimum axis value for the returned event to be true.\n This value should be in the range [0, 1] where 0 is the unpressed state of\n the axis.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the left trigger's axis\n exceeds the provided threshold, attached to the given event loop" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "leftTrigger", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the axis value of the left trigger.\nThe returned trigger will be true when the axis value is greater than 0.5.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the left trigger's axis\n exceeds 0.5, attached to the given event loop" + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "rightBumper", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the right bumper button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right bumper button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "rightStick", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the right stick button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right stick button's\n digital signal attached to the given loop." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "rightTrigger", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the axis value of the right trigger.\nThe returned trigger will be true when the axis value is greater than\n``threshold``.\n\n:param threshold: the minimum axis value for the returned event to be true.\n This value should be in the range [0, 1] where 0 is the unpressed state of\n the axis.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the right trigger's axis\n exceeds the provided threshold, attached to the given event loop" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "rightTrigger", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the axis value of the right trigger.\nThe returned trigger will be true when the axis value is greater than 0.5.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the right trigger's axis\n exceeds 0.5, attached to the given event loop" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "outputNumber", - "type": "int" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "value", + "name": "isInverted", "type": "bool" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setOutput", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", "returnType": "None", - "tooltip": "Set a single HID output value for the HID.\n\n:param outputNumber: The index of the output to set (1-32)\n:param value: The value to set the output to" + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "value", - "type": "int" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setOutputs", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", "returnType": "None", - "tooltip": "Set all output values for the HID.\n\n:param value: The 32 bit output value (1 bit for each output)" + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.interfaces.GenericHID.RumbleType" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setRumble", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", "returnType": "None", - "tooltip": "Set the rumble output for the HID.\n\nThe DS currently supports 2 rumble values, left rumble and right rumble.\n\n:param type: Which rumble value to set\n:param value: The normalized value (0 to 1) to set the rumble to" + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.XboxController" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.XboxController", - "functionName": "start", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around the start button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the start button's\n digital signal attached to the given loop." - } - ], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.XboxController.Axis", - "classVariables": [ - { - "name": "kLeftTrigger", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kLeftX", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kLeftY", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kRightTrigger", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kRightX", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kRightY", - "tooltip": "", - "type": "int", - "writable": false - } - ], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.XboxController.Axis", - "functionName": "__init__", - "returnType": "wpilib.XboxController.Axis", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.XboxController.Button", - "classVariables": [ - { - "name": "kA", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kB", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kBack", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kLeftBumper", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kLeftStick", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kRightBumper", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kRightStick", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kStart", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kX", - "tooltip": "", - "type": "int", - "writable": false - }, - { - "name": "kY", - "tooltip": "", - "type": "int", - "writable": false - } - ], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.XboxController.Button", - "functionName": "__init__", - "returnType": "wpilib.XboxController.Button", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", + "returnType": "None", "tooltip": "" } ], - "enums": [], - "instanceMethods": [], "instanceVariables": [], "moduleName": "wpilib", - "staticMethods": [] - }, - { - "className": "wpilib.cameraserver.CameraServer", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.cameraserver.CameraServer", - "functionName": "__init__", - "returnType": "wpilib.cameraserver.CameraServer", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib.cameraserver", "staticMethods": [ { "args": [], - "declaringClassName": "wpilib.cameraserver.CameraServer", - "functionName": "is_alive", - "returnType": "bool", - "tooltip": ":returns: True if the CameraServer is still alive" - }, - { - "args": [ - { - "defaultValue": "", - "name": "vision_py", - "type": "typing.Optional[str]" - } - ], - "declaringClassName": "wpilib.cameraserver.CameraServer", - "functionName": "launch", + "declaringClassName": "wpilib.PWMTalonSRX", + "functionName": "checkMotors", "returnType": "None", - "tooltip": "\n Launches the CameraServer process in autocapture mode or\n using a user-specified python script\n\n :param vision_py: If specified, this is the relative path to\n a filename with a function in it\n\n Example usage::\n\n wpilib.CameraServer.launch(\"vision.py:main\")\n\n .. warning:: You must have robotpy-cscore installed, or this\n function will fail without returning an error\n (you will see an error in the console).\n\n " + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." } ] }, { - "className": "wpilib.counter.ExternalDirectionCounter", + "className": "wpilib.PWMVenom", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "countSource", - "type": "wpilib.DigitalSource" - }, - { - "defaultValue": "", - "name": "directionSource", - "type": "wpilib.DigitalSource" - } - ], - "declaringClassName": "wpilib.counter.ExternalDirectionCounter", - "functionName": "__init__", - "returnType": "wpilib.counter.ExternalDirectionCounter", - "tooltip": "Constructs a new ExternalDirectionCounter.\n\n:param countSource: The source for counting.\n:param directionSource: The source for selecting count direction." - }, - { - "args": [ - { - "defaultValue": "", - "name": "countSource", - "type": "wpilib.DigitalSource" - }, - { - "defaultValue": "", - "name": "directionSource", - "type": "wpilib.DigitalSource" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.counter.ExternalDirectionCounter", + "declaringClassName": "wpilib.PWMVenom", "functionName": "__init__", - "returnType": "wpilib.counter.ExternalDirectionCounter", - "tooltip": "Constructs a new ExternalDirectionCounter.\n\n:param countSource: The source for counting.\n:param directionSource: The source for selecting count direction." + "returnType": "wpilib.PWMVenom", + "tooltip": "Constructor for a Venom connected via PWM.\n\n:param channel: The PWM channel that the Venom is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" } ], "enums": [], @@ -33560,521 +15961,548 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.ExternalDirectionCounter" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.counter.ExternalDirectionCounter", - "functionName": "getCount", - "returnType": "int", - "tooltip": "Gets the current count.\n\n:returns: The current count." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpiutil.Sendable" - }, - { - "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.ExternalDirectionCounter" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.counter.ExternalDirectionCounter", - "functionName": "reset", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", "returnType": "None", - "tooltip": "Resets the current count." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.ExternalDirectionCounter" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "configuration", - "type": "wpilib.counter.EdgeConfiguration" + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.counter.ExternalDirectionCounter", - "functionName": "setEdgeConfiguration", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", "returnType": "None", - "tooltip": "Sets the edge configuration for counting.\n\n:param configuration: The counting edge configuration." + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.ExternalDirectionCounter" - }, - { - "defaultValue": "", - "name": "reverseDirection", - "type": "bool" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.counter.ExternalDirectionCounter", - "functionName": "setReverseDirection", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", "returnType": "None", - "tooltip": "Sets to reverse the counter direction.\n\n:param reverseDirection: True to reverse counting direction." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.counter", - "staticMethods": [] - }, - { - "className": "wpilib.counter.Tachometer", - "classVariables": [], - "constructors": [ + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." + }, { "args": [ { "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "__init__", - "returnType": "wpilib.counter.Tachometer", - "tooltip": "Constructs a new tachometer.\n\n:param source: The source." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", - "name": "source", - "type": "wpilib.DigitalSource" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "__init__", - "returnType": "wpilib.counter.Tachometer", - "tooltip": "Constructs a new tachometer.\n\n:param source: The source." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "getEdgesPerRevolution", - "returnType": "int", - "tooltip": "Gets the number of edges per revolution.\n\n:returns: Edges per revolution." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "getFrequency", - "returnType": "wpimath.units.hertz", - "tooltip": "Gets the tachometer frequency.\n\n:returns: Current frequency." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "getPeriod", - "returnType": "wpimath.units.seconds", - "tooltip": "Gets the tachometer period.\n\n:returns: Current period." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "getRevolutionsPerMinute", - "returnType": "wpimath.units.revolutions_per_minute", - "tooltip": "Gets the current tachometer revolutions per minute.\n\nSetEdgesPerRevolution must be set with a non 0 value for this to work.\n\n:returns: Current RPM." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpiutil.Sendable" + }, + { + "defaultValue": "", + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "getRevolutionsPerSecond", - "returnType": "wpimath.units.turns_per_second", - "tooltip": "Gets the current tachometer revolutions per second.\n\nSetEdgesPerRevolution must be set with a non 0 value for this to work.\n\n:returns: Current RPS." + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "getSamplesToAverage", - "returnType": "int", - "tooltip": "Gets the number of sample to average.\n\n:returns: Samples to average." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "getStopped", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", "returnType": "bool", - "tooltip": "Gets if the tachometer is stopped.\n\n:returns: True if the tachometer is stopped." + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpiutil.Sendable" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "edges", - "type": "int" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "setEdgesPerRevolution", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", "returnType": "None", - "tooltip": "Sets the number of edges per revolution.\n\n:param edges: Edges per revolution." + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "maxPeriod", - "type": "wpimath.units.seconds" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "setMaxPeriod", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", "returnType": "None", - "tooltip": "Sets the maximum period before the tachometer is considered stopped.\n\n:param maxPeriod: The max period." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "samples", - "type": "int" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "setSamplesToAverage", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", "returnType": "None", - "tooltip": "Sets the number of samples to average.\n\n:param samples: Samples to average." + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.Tachometer" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "updateWhenEmpty", - "type": "bool" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.counter.Tachometer", - "functionName": "setUpdateWhenEmpty", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PWMMotorController" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", "returnType": "None", - "tooltip": "Sets if to update when empty.\n\n:param updateWhenEmpty: True to update when empty." + "tooltip": "" } ], "instanceVariables": [], - "moduleName": "wpilib.counter", - "staticMethods": [] + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.PWMVenom", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] }, { - "className": "wpilib.counter.UpDownCounter", + "className": "wpilib.PWMVictorSPX", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "upSource", - "type": "wpilib.DigitalSource" - }, - { - "defaultValue": "", - "name": "downSource", - "type": "wpilib.DigitalSource" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.counter.UpDownCounter", + "declaringClassName": "wpilib.PWMVictorSPX", "functionName": "__init__", - "returnType": "wpilib.counter.UpDownCounter", - "tooltip": "Constructs a new UpDown Counter.\n\n:param upSource: The up count source (can be null).\n:param downSource: The down count source (can be null)." - }, + "returnType": "wpilib.PWMVictorSPX", + "tooltip": "Constructor for a Victor SPX connected via PWM.\n\n:param channel: The PWM channel that the Victor SPX is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", - "name": "upSource", - "type": "wpilib.DigitalSource" + "name": "self", + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "downSource", - "type": "wpilib.DigitalSource" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.counter.UpDownCounter", - "functionName": "__init__", - "returnType": "wpilib.counter.UpDownCounter", - "tooltip": "Constructs a new UpDown Counter.\n\n:param upSource: The up count source (can be null).\n:param downSource: The down count source (can be null)." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.UpDownCounter" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.counter.UpDownCounter", - "functionName": "getCount", - "returnType": "int", - "tooltip": "Gets the current count.\n\n:returns: The current count." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpiutil.Sendable" + "type": "wpilib.PWMMotorController" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", + "returnType": "None", + "tooltip": "" + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpiutil.Sendable", - "functionName": "initSendable", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", "returnType": "None", - "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.UpDownCounter" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.counter.UpDownCounter", - "functionName": "reset", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", "returnType": "None", - "tooltip": "Resets the current count." + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.UpDownCounter" - }, + "type": "wpilib.PWMMotorController" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." + }, + { + "args": [ { "defaultValue": "", - "name": "configuration", - "type": "wpilib.counter.EdgeConfiguration" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.counter.UpDownCounter", - "functionName": "setDownEdgeConfiguration", - "returnType": "None", - "tooltip": "Sets the configuration for the down source.\n\n:param configuration: The down source configuration." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.UpDownCounter" - }, + "type": "wpilib.PWMMotorController" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" + }, + { + "args": [ { "defaultValue": "", - "name": "reverseDirection", - "type": "bool" + "name": "self", + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.counter.UpDownCounter", - "functionName": "setReverseDirection", - "returnType": "None", - "tooltip": "Sets to revert the counter direction.\n\n:param reverseDirection: True to reverse counting direction." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.counter.UpDownCounter" - }, + "type": "wpilib.PWMMotorController" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", + "tooltip": "" + }, + { + "args": [ { "defaultValue": "", - "name": "configuration", - "type": "wpilib.counter.EdgeConfiguration" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.counter.UpDownCounter", - "functionName": "setUpEdgeConfiguration", - "returnType": "None", - "tooltip": "Sets the configuration for the up source.\n\n:param configuration: The up source configuration." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.counter", - "staticMethods": [] - }, - { - "className": "wpilib.drive.DifferentialDrive", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." + }, { "args": [ { "defaultValue": "", - "name": "leftMotor", - "type": "wpilib.interfaces.MotorController" + "name": "self", + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "rightMotor", - "type": "wpilib.interfaces.MotorController" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "__init__", - "returnType": "wpilib.drive.DifferentialDrive", - "tooltip": "Construct a DifferentialDrive.\n\nTo pass multiple motors per side, use CAN motor controller followers or\nPWMSpeedController::AddFollower(). If a motor needs to be inverted, do so\nbefore passing it in.\n\n:param leftMotor: Left motor.\n:param rightMotor: Right motor." + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", - "name": "leftMotor", - "type": "Callable[[float], None]" - }, - { - "defaultValue": "", - "name": "rightMotor", - "type": "Callable[[float], None]" + "name": "self", + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "__init__", - "returnType": "wpilib.drive.DifferentialDrive", - "tooltip": "Construct a DifferentialDrive.\n\nTo pass multiple motors per side, use CAN motor controller followers or\nPWMSpeedController::AddFollower(). If a motor needs to be inverted, do so\nbefore passing it in.\n\n:param leftMotor: Left motor setter.\n:param rightMotor: Right motor setter." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.DifferentialDrive" - }, + "type": "wpilib.MotorSafety" + } + ], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + }, + { + "args": [ { "defaultValue": "", - "name": "xSpeed", - "type": "float" + "name": "self", + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "zRotation", - "type": "float" - }, - { - "defaultValue": "True", - "name": "squareInputs", - "type": "bool" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "arcadeDrive", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", "returnType": "None", - "tooltip": "Arcade drive method for differential drive platform.\n\nNote: Some drivers may prefer inverted rotation controls. This can be done\nby negating the value passed for rotation.\n\n:param xSpeed: The speed at which the robot should drive along the X\n axis [-1.0..1.0]. Forward is positive.\n:param zRotation: The rotation rate of the robot around the Z axis\n [-1.0..1.0]. Counterclockwise is positive.\n:param squareInputs: If set, decreases the input sensitivity at low speeds." + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ @@ -34082,109 +16510,170 @@ "defaultValue": "", "name": "self", "type": "wpilib.MotorSafety" + }, + { + "defaultValue": "", + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", + "functionName": "setExpiration", "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.DifferentialDrive" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "xSpeed", - "type": "float" - }, + "name": "isInverted", + "type": "bool" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", + "returnType": "None", + "tooltip": "" + }, + { + "args": [ { "defaultValue": "", - "name": "zRotation", - "type": "float" + "name": "self", + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "allowTurnInPlace", + "name": "enabled", "type": "bool" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "curvatureDrive", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", "returnType": "None", - "tooltip": "Curvature drive method for differential drive platform.\n\nThe rotation argument controls the curvature of the robot's path rather\nthan its rate of heading change. This makes the robot more controllable at\nhigh speeds.\n\n:param xSpeed: The robot's speed along the X axis [-1.0..1.0].\n Forward is positive.\n:param zRotation: The normalized curvature [-1.0..1.0].\n Counterclockwise is positive.\n:param allowTurnInPlace: If set, overrides constant-curvature turning for\n turn-in-place maneuvers. zRotation will control\n turning rate instead of curvature." + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.RobotDriveBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "feedWatchdog", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", "returnType": "None", - "tooltip": "Feed the motor safety object. Resets the timer that will stop the motors if\nit completes.\n\n@see MotorSafetyHelper::Feed()" + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.PWMVictorSPX", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] + }, + { + "className": "wpilib.PneumaticHub", + "classVariables": [], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "busId", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "__init__", + "returnType": "wpilib.PneumaticHub", + "tooltip": "Constructs a PneumaticHub with the default ID (1).\n\n:param busId: The bus ID." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.drive.DifferentialDrive" + "name": "busId", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "module", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" - }, + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "__init__", + "returnType": "wpilib.PneumaticHub", + "tooltip": "Constructs a PneumaticHub.\n\n:param busId: The bus ID.\n:param module: module number to construct" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PneumaticHub" + }, + { + "defaultValue": "", + "name": "mask", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "checkAndReserveSolenoids", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.DifferentialDrive" + "type": "wpilib.PneumaticHub" }, { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "initSendable", - "returnType": "None", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "checkSolenoidChannel", + "returnType": "bool", "tooltip": "" }, { @@ -34192,458 +16681,333 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "clearStickyFaults", + "returnType": "None", + "tooltip": "Clears the sticky faults." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "disableCompressor", + "returnType": "None", + "tooltip": "Disables the compressor. The compressor will not turn on until\nEnableCompressorDigital(), EnableCompressorAnalog(), or\nEnableCompressorHybrid() are called." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.RobotDriveBase" + "type": "wpilib.PneumaticHub" }, { "defaultValue": "", - "name": "deadband", - "type": "float" + "name": "minPressure", + "type": "wpimath.units.pounds_per_square_inch" + }, + { + "defaultValue": "", + "name": "maxPressure", + "type": "wpimath.units.pounds_per_square_inch" } ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "setDeadband", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "enableCompressorAnalog", "returnType": "None", - "tooltip": "Sets the deadband applied to the drive inputs (e.g., joystick values).\n\nThe default value is 0.02. Inputs smaller than the deadband are set to 0.0\nwhile inputs larger than the deadband are scaled from 0.0 to 1.0. See\nfrc::ApplyDeadband().\n\n:param deadband: The deadband to set." + "tooltip": "Enables the compressor in analog mode. This mode uses an analog pressure\nsensor connected to analog channel 0 to cycle the compressor. The\ncompressor will turn on when the pressure drops below ``minPressure``\nand will turn off when the pressure reaches ``maxPressure``.\n\n:param minPressure: The minimum pressure. The compressor will turn on when\n the pressure drops below this value. Range 0 - 120 PSI.\n:param maxPressure: The maximum pressure. The compressor will turn off when\n the pressure reaches this value. Range 0 - 120 PSI. Must be larger then\n minPressure." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "enableCompressorDigital", "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.RobotDriveBase" + "type": "wpilib.PneumaticHub" }, { "defaultValue": "", - "name": "maxOutput", - "type": "float" + "name": "minPressure", + "type": "wpimath.units.pounds_per_square_inch" + }, + { + "defaultValue": "", + "name": "maxPressure", + "type": "wpimath.units.pounds_per_square_inch" } ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "setMaxOutput", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "enableCompressorHybrid", "returnType": "None", - "tooltip": "Configure the scaling factor for using RobotDrive with motor controllers in\na mode other than PercentVbus or to limit the maximum output.\n\n:param maxOutput: Multiplied with the output percentage computed by the\n drive functions." + "tooltip": "Enables the compressor in hybrid mode. This mode uses both a digital\npressure switch and an analog pressure sensor connected to analog channel 0\nto cycle the compressor.\n\nThe compressor will turn on when \\a both:\n\n- The digital pressure switch indicates the system is not full AND\n- The analog pressure sensor indicates that the pressure in the system is\nbelow the specified minimum pressure.\n\nThe compressor will turn off when \\a either:\n\n- The digital pressure switch is disconnected or indicates that the system\nis full OR\n- The pressure detected by the analog sensor is greater than the specified\nmaximum pressure.\n\n:param minPressure: The minimum pressure. The compressor will turn on when\n the pressure drops below this value and the pressure switch indicates that\n the system is not full. Range 0 - 120 PSI.\n:param maxPressure: The maximum pressure. The compressor will turn off when\n the pressure reaches this value or the pressure switch is disconnected or\n indicates that the system is full. Range 0 - 120 PSI. Must be larger then\n minPressure." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PneumaticHub" }, { "defaultValue": "", - "name": "enabled", - "type": "bool" + "name": "index", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "fireOneShot", "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.DifferentialDrive" + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "get5VRegulatedVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Returns the current voltage of the regulated 5v supply.\n\n:returns: The current voltage of the 5v supply." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.DifferentialDrive" - }, - { - "defaultValue": "", - "name": "leftSpeed", - "type": "float" + "type": "wpilib.PneumaticHub" }, { "defaultValue": "", - "name": "rightSpeed", - "type": "float" - }, - { - "defaultValue": "True", - "name": "squareInputs", - "type": "bool" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "tankDrive", - "returnType": "None", - "tooltip": "Tank drive method for differential drive platform.\n\n:param leftSpeed: The robot left side's speed along the X axis\n [-1.0..1.0]. Forward is positive.\n:param rightSpeed: The robot right side's speed along the X axis\n [-1.0..1.0]. Forward is positive.\n:param squareInputs: If set, decreases the input sensitivity at low speeds." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.drive", - "staticMethods": [ + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getAnalogVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Returns the raw voltage of the specified analog input channel.\n\n:param channel: The analog input channel to read voltage from.\n\n:returns: The voltage of the specified analog input channel." + }, { "args": [ { "defaultValue": "", - "name": "xSpeed", - "type": "float" - }, - { - "defaultValue": "", - "name": "zRotation", - "type": "float" - }, - { - "defaultValue": "True", - "name": "squareInputs", - "type": "bool" + "name": "self", + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "arcadeDriveIK", - "returnType": "wpilib.drive.DifferentialDrive.WheelSpeeds", - "tooltip": "Arcade drive inverse kinematics for differential drive platform.\n\nNote: Some drivers may prefer inverted rotation controls. This can be done\nby negating the value passed for rotation.\n\n:param xSpeed: The speed at which the robot should drive along the X\n axis [-1.0..1.0]. Forward is positive.\n:param zRotation: The rotation rate of the robot around the Z axis\n [-1.0..1.0]. Clockwise is positive.\n:param squareInputs: If set, decreases the input sensitivity at low speeds.\n\n:returns: Wheel speeds [-1.0..1.0]." - }, - { - "args": [], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getCompressor", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "xSpeed", - "type": "float" - }, - { - "defaultValue": "", - "name": "zRotation", - "type": "float" - }, - { - "defaultValue": "", - "name": "allowTurnInPlace", - "type": "bool" + "name": "self", + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "curvatureDriveIK", - "returnType": "wpilib.drive.DifferentialDrive.WheelSpeeds", - "tooltip": "Curvature drive inverse kinematics for differential drive platform.\n\nThe rotation argument controls the curvature of the robot's path rather\nthan its rate of heading change. This makes the robot more controllable at\nhigh speeds.\n\n:param xSpeed: The robot's speed along the X axis [-1.0..1.0].\n Forward is positive.\n:param zRotation: The normalized curvature [-1.0..1.0]. Clockwise is\n positive.\n:param allowTurnInPlace: If set, overrides constant-curvature turning for\n turn-in-place maneuvers. zRotation will control\n turning rate instead of curvature.\n\n:returns: Wheel speeds [-1.0..1.0]." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getCompressorConfigType", + "returnType": "wpilib.CompressorConfigType", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "leftSpeed", - "type": "float" - }, - { - "defaultValue": "", - "name": "rightSpeed", - "type": "float" - }, - { - "defaultValue": "True", - "name": "squareInputs", - "type": "bool" + "name": "self", + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.drive.DifferentialDrive", - "functionName": "tankDriveIK", - "returnType": "wpilib.drive.DifferentialDrive.WheelSpeeds", - "tooltip": "Tank drive inverse kinematics for differential drive platform.\n\n:param leftSpeed: The robot left side's speed along the X axis\n [-1.0..1.0]. Forward is positive.\n:param rightSpeed: The robot right side's speed along the X axis\n [-1.0..1.0]. Forward is positive.\n:param squareInputs: If set, decreases the input sensitivity at low speeds.\n\n:returns: Wheel speeds [-1.0..1.0]." - } - ] - }, - { - "className": "wpilib.drive.DifferentialDrive.WheelSpeeds", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.drive.DifferentialDrive.WheelSpeeds", - "functionName": "__init__", - "returnType": "wpilib.drive.DifferentialDrive.WheelSpeeds", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getCompressorCurrent", + "returnType": "wpimath.units.amperes", "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [ - { - "name": "left", - "tooltip": "Left wheel speed.", - "type": "float", - "writable": true }, - { - "name": "right", - "tooltip": "Right wheel speed.", - "type": "float", - "writable": true - } - ], - "moduleName": "wpilib.drive", - "staticMethods": [] - }, - { - "className": "wpilib.drive.MecanumDrive", - "classVariables": [], - "constructors": [ { "args": [ { "defaultValue": "", - "name": "frontLeftMotor", - "type": "wpilib.interfaces.MotorController" - }, - { - "defaultValue": "", - "name": "rearLeftMotor", - "type": "wpilib.interfaces.MotorController" - }, - { - "defaultValue": "", - "name": "frontRightMotor", - "type": "wpilib.interfaces.MotorController" - }, - { - "defaultValue": "", - "name": "rearRightMotor", - "type": "wpilib.interfaces.MotorController" + "name": "self", + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.drive.MecanumDrive", - "functionName": "__init__", - "returnType": "wpilib.drive.MecanumDrive", - "tooltip": "Construct a MecanumDrive.\n\nIf a motor needs to be inverted, do so before passing it in.\n\n:param frontLeftMotor: Front-left motor.\n:param rearLeftMotor: Rear-left motor.\n:param frontRightMotor: Front-right motor.\n:param rearRightMotor: Rear-right motor." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getFaults", + "returnType": "wpilib.PneumaticHub.Faults", + "tooltip": "Returns the faults currently active on this device.\n\n:returns: The faults." }, { "args": [ { "defaultValue": "", - "name": "frontLeftMotor", - "type": "Callable[[float], None]" - }, - { - "defaultValue": "", - "name": "rearLeftMotor", - "type": "Callable[[float], None]" - }, - { - "defaultValue": "", - "name": "frontRightMotor", - "type": "Callable[[float], None]" - }, - { - "defaultValue": "", - "name": "rearRightMotor", - "type": "Callable[[float], None]" + "name": "self", + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.drive.MecanumDrive", - "functionName": "__init__", - "returnType": "wpilib.drive.MecanumDrive", - "tooltip": "Construct a MecanumDrive.\n\nIf a motor needs to be inverted, do so before passing it in.\n\n:param frontLeftMotor: Front-left motor setter.\n:param rearLeftMotor: Rear-left motor setter.\n:param frontRightMotor: Front-right motor setter.\n:param rearRightMotor: Rear-right motor setter." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getInputVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Returns the current input voltage for this device.\n\n:returns: The input voltage." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getModuleNumber", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.MecanumDrive" - }, - { - "defaultValue": "", - "name": "xSpeed", - "type": "float" - }, - { - "defaultValue": "", - "name": "ySpeed", - "type": "float" + "type": "wpilib.PneumaticHub" }, { "defaultValue": "", - "name": "zRotation", - "type": "float" - }, - { - "defaultValue": "Rotation2d(0.000000)", - "name": "gyroAngle", - "type": "wpimath.geometry.Rotation2d" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.drive.MecanumDrive", - "functionName": "driveCartesian", - "returnType": "None", - "tooltip": "Drive method for Mecanum platform.\n\nAngles are measured counterclockwise from the positive X axis. The robot's\nspeed is independent from its angle or rotation rate.\n\n:param xSpeed: The robot's speed along the X axis [-1.0..1.0]. Forward is\n positive.\n:param ySpeed: The robot's speed along the Y axis [-1.0..1.0]. Left is\n positive.\n:param zRotation: The robot's rotation rate around the Z axis [-1.0..1.0].\n Counterclockwise is positive.\n:param gyroAngle: The gyro heading around the Z axis. Use this to implement\n field-oriented controls." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getPressure", + "returnType": "wpimath.units.pounds_per_square_inch", + "tooltip": "Returns the pressure read by an analog pressure sensor on the specified\nanalog input channel.\n\n:param channel: The analog input channel to read pressure from.\n\n:returns: The pressure read by an analog pressure sensor on the specified\n analog input channel." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.MecanumDrive" - }, - { - "defaultValue": "", - "name": "magnitude", - "type": "float" - }, - { - "defaultValue": "", - "name": "angle", - "type": "wpimath.geometry.Rotation2d" - }, + "type": "wpilib.PneumaticHub" + } + ], + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getPressureSwitch", + "returnType": "bool", + "tooltip": "" + }, + { + "args": [ { "defaultValue": "", - "name": "zRotation", - "type": "float" + "name": "self", + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.drive.MecanumDrive", - "functionName": "drivePolar", - "returnType": "None", - "tooltip": "Drive method for Mecanum platform.\n\nAngles are measured counterclockwise from the positive X axis. The robot's\nspeed is independent from its angle or rotation rate.\n\n:param magnitude: The robot's speed at a given angle [-1.0..1.0]. Forward is\n positive.\n:param angle: The angle around the Z axis at which the robot drives.\n:param zRotation: The robot's rotation rate around the Z axis [-1.0..1.0].\n Counterclockwise is positive." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getSolenoidDisabledList", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getSolenoids", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.RobotDriveBase" + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "feedWatchdog", - "returnType": "None", - "tooltip": "Feed the motor safety object. Resets the timer that will stop the motors if\nit completes.\n\n@see MotorSafetyHelper::Feed()" + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getSolenoidsTotalCurrent", + "returnType": "wpimath.units.amperes", + "tooltip": "Returns the total current drawn by all solenoids.\n\n:returns: Total current drawn by all solenoids." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.MecanumDrive" + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.drive.MecanumDrive", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getSolenoidsVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Returns the current voltage of the solenoid power supply.\n\n:returns: The current voltage of the solenoid power supply." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getStickyFaults", + "returnType": "wpilib.PneumaticHub.StickyFaults", + "tooltip": "Returns the sticky faults currently active on this device.\n\n:returns: The sticky faults." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.MecanumDrive" - }, + "type": "wpilib.PneumaticHub" + } + ], + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getVersion", + "returnType": "wpilib.PneumaticHub.Version", + "tooltip": "Returns the hardware and firmware versions of this device.\n\n:returns: The hardware and firmware versions." + }, + { + "args": [ { "defaultValue": "", - "name": "builder", - "type": "wpiutil.SendableBuilder" + "name": "self", + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.drive.MecanumDrive", - "functionName": "initSendable", - "returnType": "None", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "makeCompressor", + "returnType": "wpilib.Compressor", "tooltip": "" }, { @@ -34651,435 +17015,505 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PneumaticHub" + }, + { + "defaultValue": "", + "name": "forwardChannel", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "reverseChannel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "makeDoubleSolenoid", + "returnType": "wpilib.DoubleSolenoid", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PneumaticHub" + }, + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "makeSolenoid", + "returnType": "wpilib.Solenoid", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.RobotDriveBase" + "type": "wpilib.PneumaticHub" }, { "defaultValue": "", - "name": "deadband", - "type": "float" + "name": "device", + "type": "str" + }, + { + "defaultValue": "", + "name": "data", + "type": "str" } ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "setDeadband", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "reportUsage", "returnType": "None", - "tooltip": "Sets the deadband applied to the drive inputs (e.g., joystick values).\n\nThe default value is 0.02. Inputs smaller than the deadband are set to 0.0\nwhile inputs larger than the deadband are scaled from 0.0 to 1.0. See\nfrc::ApplyDeadband().\n\n:param deadband: The deadband to set." + "tooltip": "" + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PneumaticHub" + } + ], + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "reserveCompressor", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" + "type": "wpilib.PneumaticHub" }, { "defaultValue": "", - "name": "expirationTime", + "name": "index", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "duration", "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "setOneShotDuration", "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.RobotDriveBase" + "type": "wpilib.PneumaticHub" }, { "defaultValue": "", - "name": "maxOutput", - "type": "float" + "name": "mask", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "values", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "setMaxOutput", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "setSolenoids", "returnType": "None", - "tooltip": "Configure the scaling factor for using RobotDrive with motor controllers in\na mode other than PercentVbus or to limit the maximum output.\n\n:param maxOutput: Multiplied with the output percentage computed by the\n drive functions." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" + "type": "wpilib.PneumaticHub" } ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "unreserveCompressor", "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.drive.MecanumDrive" + "type": "wpilib.PneumaticHub" + }, + { + "defaultValue": "", + "name": "mask", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.drive.MecanumDrive", - "functionName": "stopMotor", + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "unreserveSolenoids", "returnType": "None", "tooltip": "" } ], "instanceVariables": [], - "moduleName": "wpilib.drive", + "moduleName": "wpilib", "staticMethods": [ { - "args": [], - "declaringClassName": "wpilib.drive.MecanumDrive", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + "args": [ + { + "defaultValue": "", + "name": "moduleType", + "type": "wpilib.PneumaticsModuleType" + } + ], + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getDefaultForType", + "returnType": "int", + "tooltip": "For internal use to get the default for a specific type.\n\n:param moduleType: module type\n\n:returns: module default" }, { "args": [ { "defaultValue": "", - "name": "xSpeed", - "type": "float" + "name": "busId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "ySpeed", - "type": "float" + "name": "module", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "zRotation", - "type": "float" - }, - { - "defaultValue": "Rotation2d(0.000000)", - "name": "gyroAngle", - "type": "wpimath.geometry.Rotation2d" + "name": "moduleType", + "type": "wpilib.PneumaticsModuleType" } ], - "declaringClassName": "wpilib.drive.MecanumDrive", - "functionName": "driveCartesianIK", - "returnType": "wpilib.drive.MecanumDrive.WheelSpeeds", - "tooltip": "Cartesian inverse kinematics for Mecanum platform.\n\nAngles are measured counterclockwise from the positive X axis. The robot's\nspeed is independent from its angle or rotation rate.\n\n:param xSpeed: The robot's speed along the X axis [-1.0..1.0]. Forward is\n positive.\n:param ySpeed: The robot's speed along the Y axis [-1.0..1.0]. Left is\n positive.\n:param zRotation: The robot's rotation rate around the Z axis [-1.0..1.0].\n Counterclockwise is positive.\n:param gyroAngle: The gyro heading around the Z axis. Use this to implement\n field-oriented controls.\n\n:returns: Wheel speeds [-1.0..1.0]." + "declaringClassName": "wpilib.PneumaticHub", + "functionName": "getForType", + "returnType": "wpilib.PneumaticsBase", + "tooltip": "For internal use to get a module for a specific type.\n\n:param busId: The bus ID.\n:param module: module number\n:param moduleType: module type\n\n:returns: module" } ] }, { - "className": "wpilib.drive.MecanumDrive.WheelSpeeds", + "className": "wpilib.PneumaticHub.Faults", "classVariables": [], "constructors": [ { "args": [], - "declaringClassName": "wpilib.drive.MecanumDrive.WheelSpeeds", + "declaringClassName": "wpilib.PneumaticHub.Faults", "functionName": "__init__", - "returnType": "wpilib.drive.MecanumDrive.WheelSpeeds", + "returnType": "wpilib.PneumaticHub.Faults", "tooltip": "" } ], "enums": [], - "instanceMethods": [], + "instanceMethods": [ + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PneumaticHub.Faults" + }, + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.PneumaticHub.Faults", + "functionName": "getChannelFault", + "returnType": "bool", + "tooltip": "Gets whether there is a fault at the specified channel.\n\n:param channel: Channel to check for faults.\n\n:returns: True if a a fault exists at the channel, otherwise false.\n @throws A ChannelIndexOutOfRange error if the provided channel is outside\n of the range supported by the hardware." + } + ], "instanceVariables": [ { - "name": "frontLeft", - "tooltip": "Front-left wheel speed.", - "type": "float", + "name": "Brownout", + "tooltip": "The input voltage is below the minimum voltage.", + "type": "int", "writable": true }, { - "name": "frontRight", - "tooltip": "Front-right wheel speed.", - "type": "float", + "name": "CanWarning", + "tooltip": "A warning was raised by the device's CAN controller.", + "type": "int", "writable": true }, { - "name": "rearLeft", - "tooltip": "Rear-left wheel speed.", - "type": "float", + "name": "Channel0Fault", + "tooltip": "Fault on channel 0.", + "type": "int", "writable": true }, { - "name": "rearRight", - "tooltip": "Rear-right wheel speed.", - "type": "float", + "name": "Channel10Fault", + "tooltip": "Fault on channel 10.", + "type": "int", + "writable": true + }, + { + "name": "Channel11Fault", + "tooltip": "Fault on channel 11.", + "type": "int", + "writable": true + }, + { + "name": "Channel12Fault", + "tooltip": "Fault on channel 12.", + "type": "int", + "writable": true + }, + { + "name": "Channel13Fault", + "tooltip": "Fault on channel 13.", + "type": "int", + "writable": true + }, + { + "name": "Channel14Fault", + "tooltip": "Fault on channel 14.", + "type": "int", + "writable": true + }, + { + "name": "Channel15Fault", + "tooltip": "Fault on channel 15.", + "type": "int", + "writable": true + }, + { + "name": "Channel1Fault", + "tooltip": "Fault on channel 1.", + "type": "int", + "writable": true + }, + { + "name": "Channel2Fault", + "tooltip": "Fault on channel 2.", + "type": "int", + "writable": true + }, + { + "name": "Channel3Fault", + "tooltip": "Fault on channel 3.", + "type": "int", + "writable": true + }, + { + "name": "Channel4Fault", + "tooltip": "Fault on channel 4.", + "type": "int", + "writable": true + }, + { + "name": "Channel5Fault", + "tooltip": "Fault on channel 5.", + "type": "int", + "writable": true + }, + { + "name": "Channel6Fault", + "tooltip": "Fault on channel 6.", + "type": "int", + "writable": true + }, + { + "name": "Channel7Fault", + "tooltip": "Fault on channel 7.", + "type": "int", + "writable": true + }, + { + "name": "Channel8Fault", + "tooltip": "Fault on channel 8.", + "type": "int", + "writable": true + }, + { + "name": "Channel9Fault", + "tooltip": "Fault on channel 9.", + "type": "int", + "writable": true + }, + { + "name": "CompressorOpen", + "tooltip": "The compressor output has an open circuit.", + "type": "int", + "writable": true + }, + { + "name": "CompressorOverCurrent", + "tooltip": "An overcurrent event occurred on the compressor output.", + "type": "int", + "writable": true + }, + { + "name": "HardwareFault", + "tooltip": "The hardware on the device has malfunctioned.", + "type": "int", + "writable": true + }, + { + "name": "SolenoidOverCurrent", + "tooltip": "An overcurrent event occurred on a solenoid output.", + "type": "int", "writable": true } ], - "moduleName": "wpilib.drive", + "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.drive.RobotDriveBase", + "className": "wpilib.PneumaticHub.StickyFaults", "classVariables": [], "constructors": [ { "args": [], - "declaringClassName": "wpilib.drive.RobotDriveBase", + "declaringClassName": "wpilib.PneumaticHub.StickyFaults", "functionName": "__init__", - "returnType": "wpilib.drive.RobotDriveBase", + "returnType": "wpilib.PneumaticHub.StickyFaults", "tooltip": "" } ], - "enums": [ - { - "enumClassName": "wpilib.drive.RobotDriveBase.MotorType", - "enumValues": [ - "kBack", - "kFrontLeft", - "kFrontRight", - "kLeft", - "kRearLeft", - "kRearRight", - "kRight" - ], - "moduleName": "wpilib.drive", - "tooltip": "The location of a motor on the robot for the purpose of driving.\n\nMembers:\n\n kFrontLeft : Front-left motor.\n\n kFrontRight : Front-right motor.\n\n kRearLeft : Rear-left motor.\n\n kRearRight : Rear-right motor.\n\n kLeft : Left motor.\n\n kRight : Right motor.\n\n kBack : Back motor." - } - ], - "instanceMethods": [ + "enums": [], + "instanceMethods": [], + "instanceVariables": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "check", - "returnType": "None", - "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + "name": "Brownout", + "tooltip": "The input voltage is below the minimum voltage.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "feed", - "returnType": "None", - "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." + "name": "CanBusOff", + "tooltip": "The device's CAN controller experienced a \"Bus Off\" event.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.drive.RobotDriveBase" - } - ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "feedWatchdog", - "returnType": "None", - "tooltip": "Feed the motor safety object. Resets the timer that will stop the motors if\nit completes.\n\n@see MotorSafetyHelper::Feed()" + "name": "CanWarning", + "tooltip": "A warning was raised by the device's CAN controller.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.drive.RobotDriveBase" - } - ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "getDescription", - "returnType": "str", - "tooltip": "" + "name": "CompressorOpen", + "tooltip": "The compressor output has an open circuit.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "getExpiration", - "returnType": "wpimath.units.seconds", - "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + "name": "CompressorOverCurrent", + "tooltip": "An overcurrent event occurred on the compressor output.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isAlive", - "returnType": "bool", - "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + "name": "FirmwareFault", + "tooltip": "The firmware on the device has malfunctioned.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "isSafetyEnabled", - "returnType": "bool", - "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + "name": "HardwareFault", + "tooltip": "The hardware on the device has malfunctioned.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.drive.RobotDriveBase" - }, - { - "defaultValue": "", - "name": "deadband", - "type": "float" - } - ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "setDeadband", - "returnType": "None", - "tooltip": "Sets the deadband applied to the drive inputs (e.g., joystick values).\n\nThe default value is 0.02. Inputs smaller than the deadband are set to 0.0\nwhile inputs larger than the deadband are scaled from 0.0 to 1.0. See\nfrc::ApplyDeadband().\n\n:param deadband: The deadband to set." + "name": "HasReset", + "tooltip": "The device has rebooted.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "expirationTime", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setExpiration", - "returnType": "None", - "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + "name": "SolenoidOverCurrent", + "tooltip": "An overcurrent event occurred on a solenoid output.", + "type": "int", + "writable": true + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.PneumaticHub.Version", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.PneumaticHub.Version", + "functionName": "__init__", + "returnType": "wpilib.PneumaticHub.Version", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "FirmwareFix", + "tooltip": "The firmware fix version.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.drive.RobotDriveBase" - }, - { - "defaultValue": "", - "name": "maxOutput", - "type": "float" - } - ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "setMaxOutput", - "returnType": "None", - "tooltip": "Configure the scaling factor for using RobotDrive with motor controllers in\na mode other than PercentVbus or to limit the maximum output.\n\n:param maxOutput: Multiplied with the output percentage computed by the\n drive functions." + "name": "FirmwareMajor", + "tooltip": "The firmware major version.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.MotorSafety" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpilib.MotorSafety", - "functionName": "setSafetyEnabled", - "returnType": "None", - "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." + "name": "FirmwareMinor", + "tooltip": "The firmware minor version.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.drive.RobotDriveBase" - } - ], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.drive", - "staticMethods": [ + "name": "HardwareMajor", + "tooltip": "The hardware major version.", + "type": "int", + "writable": true + }, { - "args": [], - "declaringClassName": "wpilib.drive.RobotDriveBase", - "functionName": "checkMotors", - "returnType": "None", - "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + "name": "HardwareMinor", + "tooltip": "The hardware minor version.", + "type": "int", + "writable": true + }, + { + "name": "UniqueId", + "tooltip": "The device's unique ID.", + "type": "int", + "writable": true } - ] + ], + "moduleName": "wpilib", + "staticMethods": [] }, { - "className": "wpilib.event.BooleanEvent", + "className": "wpilib.PneumaticsBase", "classVariables": [], "constructors": [ { - "args": [ - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - }, - { - "defaultValue": "", - "name": "signal", - "type": "Callable[[], bool]" - } - ], - "declaringClassName": "wpilib.event.BooleanEvent", + "args": [], + "declaringClassName": "wpilib.PneumaticsBase", "functionName": "__init__", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Creates a new event that is active when the condition is true.\n\n:param loop: the loop that polls this event\n:param signal: the digital signal represented by this object." + "returnType": "wpilib.PneumaticsBase", + "tooltip": "" } ], "enums": [], @@ -35089,1266 +17523,1176 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" + "type": "wpilib.PneumaticsBase" }, { "defaultValue": "", - "name": "ctor", - "type": "Callable" + "name": "mask", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "castTo", - "returnType": "object", - "tooltip": "A method to \"downcast\" a BooleanEvent instance to a subclass (for example,\nto a command-based version of this class).\n\n:param ctor: a method reference to the constructor of the subclass that\n accepts the loop as the first parameter and the condition/signal as the\n second.\n\n:returns: an instance of the subclass." + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "checkAndReserveSolenoids", + "returnType": "int", + "tooltip": "Check to see if the solenoids marked in the bitmask can be reserved, and if\nso, reserve them.\n\n:param mask: The bitmask of solenoids to reserve. The LSB represents\n solenoid 0.\n\n:returns: 0 if successful; mask of solenoids that couldn't be allocated\n otherwise" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" + "type": "wpilib.PneumaticsBase" }, { "defaultValue": "", - "name": "debounceTime", - "type": "wpimath.units.seconds" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpimath.filter.Debouncer.DebounceType" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "debounce", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Creates a new debounced event from this event - it will become active when\nthis event has been active for longer than the specified period.\n\n:param debounceTime: The debounce period.\n:param type: The debounce type.\n\n:returns: The debounced event." + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "checkSolenoidChannel", + "returnType": "bool", + "tooltip": "Check if a solenoid channel is valid.\n\n:param channel: Channel to check\n\n:returns: True if channel exists" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "falling", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Creates a new event that triggers when this one changes from true to false.\n\n:returns: the event." + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "disableCompressor", + "returnType": "None", + "tooltip": "Disables the compressor." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" - } - ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "getAsBoolean", - "returnType": "bool", - "tooltip": "Returns the state of this signal (high or low) as of the last loop poll.\n\n:returns: true for the high state, false for the low state. If the event was\n never polled, it returns the state at event construction." - }, - { - "args": [ + "type": "wpilib.PneumaticsBase" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.event.BooleanEvent" + "name": "minPressure", + "type": "wpimath.units.pounds_per_square_inch" }, { "defaultValue": "", - "name": "action", - "type": "Callable[[], None]" + "name": "maxPressure", + "type": "wpimath.units.pounds_per_square_inch" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "ifHigh", + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "enableCompressorAnalog", "returnType": "None", - "tooltip": "Bind an action to this event.\n\n:param action: the action to run if this event is active." + "tooltip": "If supported by the device, enables the compressor in analog mode. This\nmode uses an analog pressure sensor connected to analog channel 0 to cycle\nthe compressor. The compressor will turn on when the pressure drops below\n``minPressure`` and will turn off when the pressure reaches {@code\nmaxPressure}. This mode is only supported by the REV PH with the REV Analog\nPressure Sensor connected to analog channel 0.\n\nOn CTRE PCM, this will enable digital control.\n\n:param minPressure: The minimum pressure. The compressor will turn on\n when the pressure drops below this value.\n:param maxPressure: The maximum pressure. The compressor will turn\n off when the pressure reaches this value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "rising", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Creates a new event that triggers when this one changes from false to true.\n\n:returns: the new event." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.event", - "staticMethods": [] - }, - { - "className": "wpilib.event.EventLoop", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.event.EventLoop", - "functionName": "__init__", - "returnType": "wpilib.event.EventLoop", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "enableCompressorDigital", + "returnType": "None", + "tooltip": "Enables the compressor in digital mode using the digital pressure switch.\nThe compressor will turn on when the pressure switch indicates that the\nsystem is not full, and will turn off when the pressure switch indicates\nthat the system is full." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PneumaticsBase" }, { "defaultValue": "", - "name": "action", - "type": "Callable[[], None]" + "name": "minPressure", + "type": "wpimath.units.pounds_per_square_inch" + }, + { + "defaultValue": "", + "name": "maxPressure", + "type": "wpimath.units.pounds_per_square_inch" } ], - "declaringClassName": "wpilib.event.EventLoop", - "functionName": "bind", + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "enableCompressorHybrid", "returnType": "None", - "tooltip": "Bind a new action to run when the loop is polled.\n\n:param action: the action to run." + "tooltip": "If supported by the device, enables the compressor in hybrid mode. This\nmode uses both a digital pressure switch and an analog pressure sensor\nconnected to analog channel 0 to cycle the compressor. This mode is only\nsupported by the REV PH with the REV Analog Pressure Sensor connected to\nanalog channel 0.\n\nThe compressor will turn on when \\a both:\n\n- The digital pressure switch indicates the system is not full AND\n- The analog pressure sensor indicates that the pressure in the system\nis below the specified minimum pressure.\n\nThe compressor will turn off when \\a either:\n\n- The digital pressure switch is disconnected or indicates that the system\nis full OR\n- The pressure detected by the analog sensor is greater than the specified\nmaximum pressure.\n\nOn CTRE PCM, this will enable digital control.\n\n:param minPressure: The minimum pressure. The compressor will turn on\n when the pressure drops below this value and the pressure switch indicates\n that the system is not full.\n:param maxPressure: The maximum pressure. The compressor will turn\n off when the pressure reaches this value or the pressure switch is\n disconnected or indicates that the system is full." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PneumaticsBase" + }, + { + "defaultValue": "", + "name": "index", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.event.EventLoop", - "functionName": "clear", + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "fireOneShot", "returnType": "None", - "tooltip": "Clear all bindings." + "tooltip": "Fire a single solenoid shot.\n\n:param index: solenoid index" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PneumaticsBase" + }, + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.event.EventLoop", - "functionName": "poll", - "returnType": "None", - "tooltip": "Poll all bindings." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.event", - "staticMethods": [] - }, - { - "className": "wpilib.event.NetworkBooleanEvent", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getAnalogVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "If supported by the device, returns the raw voltage of the specified analog\ninput channel.\n\nThis function is only supported by the REV PH. On CTRE PCM, this will\nreturn 0.\n\n:param channel: The analog input channel to read voltage from.\n\n:returns: The voltage of the specified analog input channel." + }, { "args": [ { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - }, - { - "defaultValue": "", - "name": "topic", - "type": "ntcore.BooleanTopic" + "name": "self", + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.event.NetworkBooleanEvent", - "functionName": "__init__", - "returnType": "wpilib.event.NetworkBooleanEvent", - "tooltip": "Creates a new event with the given boolean topic determining whether it is\nactive.\n\n:param loop: the loop that polls this event\n:param topic: The boolean topic that contains the value" + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getCompressor", + "returnType": "bool", + "tooltip": "Returns whether the compressor is active or not.\n\n:returns: True if the compressor is on - otherwise false." }, { "args": [ { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - }, - { - "defaultValue": "", - "name": "sub", - "type": "ntcore.BooleanSubscriber" + "name": "self", + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.event.NetworkBooleanEvent", - "functionName": "__init__", - "returnType": "wpilib.event.NetworkBooleanEvent", - "tooltip": "Creates a new event with the given boolean subscriber determining whether\nit is active.\n\n:param loop: the loop that polls this event\n:param sub: The boolean subscriber that provides the value" + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getCompressorConfigType", + "returnType": "wpilib.CompressorConfigType", + "tooltip": "Returns the active compressor configuration.\n\n:returns: The active compressor configuration." }, { "args": [ { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - }, - { - "defaultValue": "", - "name": "table", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "topicName", - "type": "str" + "name": "self", + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.event.NetworkBooleanEvent", - "functionName": "__init__", - "returnType": "wpilib.event.NetworkBooleanEvent", - "tooltip": "Creates a new event with the given boolean topic determining whether it is\nactive.\n\n:param loop: the loop that polls this event\n:param table: The NetworkTable that contains the topic\n:param topicName: The topic name within the table that contains the value" + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getCompressorCurrent", + "returnType": "wpimath.units.amperes", + "tooltip": "Returns the current drawn by the compressor.\n\n:returns: The current drawn by the compressor." }, { "args": [ { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - }, - { - "defaultValue": "", - "name": "tableName", - "type": "str" - }, - { - "defaultValue": "", - "name": "topicName", - "type": "str" + "name": "self", + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.event.NetworkBooleanEvent", - "functionName": "__init__", - "returnType": "wpilib.event.NetworkBooleanEvent", - "tooltip": "Creates a new event with the given boolean topic determining whether it is\nactive.\n\n:param loop: the loop that polls this event\n:param tableName: The NetworkTable name that contains the topic\n:param topicName: The topic name within the table that contains the value" + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getModuleNumber", + "returnType": "int", + "tooltip": "Get module number for this module.\n\n:returns: module number" }, { "args": [ { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" - }, - { - "defaultValue": "", - "name": "inst", - "type": "ntcore.NetworkTableInstance" - }, - { - "defaultValue": "", - "name": "tableName", - "type": "str" + "name": "self", + "type": "wpilib.PneumaticsBase" }, { "defaultValue": "", - "name": "topicName", - "type": "str" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.event.NetworkBooleanEvent", - "functionName": "__init__", - "returnType": "wpilib.event.NetworkBooleanEvent", - "tooltip": "Creates a new event with the given boolean topic determining whether it is\nactive.\n\n:param loop: the loop that polls this event\n:param inst: The NetworkTable instance to use\n:param tableName: The NetworkTable that contains the topic\n:param topicName: The topic name within the table that contains the value" - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getPressure", + "returnType": "wpimath.units.pounds_per_square_inch", + "tooltip": "If supported by the device, returns the pressure read by an analog\npressure sensor on the specified analog input channel.\n\nThis function is only supported by the REV PH. On CTRE PCM, this will\nreturn 0.\n\n:param channel: The analog input channel to read pressure from.\n\n:returns: The pressure read by an analog pressure sensor on the\n specified analog input channel." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" - }, - { - "defaultValue": "", - "name": "ctor", - "type": "Callable" + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "castTo", - "returnType": "object", - "tooltip": "A method to \"downcast\" a BooleanEvent instance to a subclass (for example,\nto a command-based version of this class).\n\n:param ctor: a method reference to the constructor of the subclass that\n accepts the loop as the first parameter and the condition/signal as the\n second.\n\n:returns: an instance of the subclass." + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getPressureSwitch", + "returnType": "bool", + "tooltip": "Returns the state of the pressure switch.\n\n:returns: True if pressure switch indicates that the system is full,\n otherwise false." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" - }, - { - "defaultValue": "", - "name": "debounceTime", - "type": "wpimath.units.seconds" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpimath.filter.Debouncer.DebounceType" + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "debounce", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Creates a new debounced event from this event - it will become active when\nthis event has been active for longer than the specified period.\n\n:param debounceTime: The debounce period.\n:param type: The debounce type.\n\n:returns: The debounced event." + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getSolenoidDisabledList", + "returnType": "int", + "tooltip": "Get a bitmask of disabled solenoids.\n\n:returns: Bitmask indicating disabled solenoids. The LSB represents solenoid\n 0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "falling", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Creates a new event that triggers when this one changes from true to false.\n\n:returns: the event." + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getSolenoids", + "returnType": "int", + "tooltip": "Gets a bitmask of solenoid values.\n\n:returns: Bitmask containing the state of the solenoids. The LSB represents\n solenoid 0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "getAsBoolean", - "returnType": "bool", - "tooltip": "Returns the state of this signal (high or low) as of the last loop poll.\n\n:returns: true for the high state, false for the low state. If the event was\n never polled, it returns the state at event construction." + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "makeCompressor", + "returnType": "wpilib.Compressor", + "tooltip": "Create a compressor object.\n\n:returns: Compressor object" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" + "type": "wpilib.PneumaticsBase" }, { "defaultValue": "", - "name": "action", - "type": "Callable[[], None]" + "name": "forwardChannel", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "reverseChannel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "ifHigh", - "returnType": "None", - "tooltip": "Bind an action to this event.\n\n:param action: the action to run if this event is active." + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "makeDoubleSolenoid", + "returnType": "wpilib.DoubleSolenoid", + "tooltip": "Create a double solenoid object for the specified channels.\n\n:param forwardChannel: solenoid channel for forward\n:param reverseChannel: solenoid channel for reverse\n\n:returns: DoubleSolenoid object" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.event.BooleanEvent" + "type": "wpilib.PneumaticsBase" + }, + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.event.BooleanEvent", - "functionName": "rising", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Creates a new event that triggers when this one changes from false to true.\n\n:returns: the new event." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.event", - "staticMethods": [] - }, - { - "className": "wpilib.interfaces.CounterBase", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.interfaces.CounterBase", - "functionName": "__init__", - "returnType": "wpilib.interfaces.CounterBase", - "tooltip": "" - } - ], - "enums": [ - { - "enumClassName": "wpilib.interfaces.CounterBase.EncodingType", - "enumValues": [ - "k1X", - "k2X", - "k4X" - ], - "moduleName": "wpilib.interfaces", - "tooltip": "Members:\n\n k1X\n\n k2X\n\n k4X" - } - ], - "instanceMethods": [ + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "makeSolenoid", + "returnType": "wpilib.Solenoid", + "tooltip": "Create a solenoid object for the specified channel.\n\n:param channel: solenoid channel\n\n:returns: Solenoid object" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.CounterBase" + "type": "wpilib.PneumaticsBase" + }, + { + "defaultValue": "", + "name": "device", + "type": "str" + }, + { + "defaultValue": "", + "name": "data", + "type": "str" } ], - "declaringClassName": "wpilib.interfaces.CounterBase", - "functionName": "get", - "returnType": "int", - "tooltip": "" + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "reportUsage", + "returnType": "None", + "tooltip": "Report usage.\n\n:param device: device and channel as appropriate\n:param data: arbitrary usage data" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.CounterBase" + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.interfaces.CounterBase", - "functionName": "getDirection", + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "reserveCompressor", "returnType": "bool", - "tooltip": "" + "tooltip": "Reserve the compressor.\n\n:returns: true if successful; false if compressor already reserved" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.CounterBase" + "type": "wpilib.PneumaticsBase" + }, + { + "defaultValue": "", + "name": "index", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "duration", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.interfaces.CounterBase", - "functionName": "getPeriod", - "returnType": "wpimath.units.seconds", - "tooltip": "" + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "setOneShotDuration", + "returnType": "None", + "tooltip": "Set the duration for a single solenoid shot.\n\n:param index: solenoid index\n:param duration: shot duration" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.CounterBase" + "type": "wpilib.PneumaticsBase" + }, + { + "defaultValue": "", + "name": "mask", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "values", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.CounterBase", - "functionName": "getStopped", - "returnType": "bool", - "tooltip": "" + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "setSolenoids", + "returnType": "None", + "tooltip": "Sets solenoids on a pneumatics module.\n\n:param mask: Bitmask indicating which solenoids to set. The LSB represents\n solenoid 0.\n:param values: Bitmask indicating the desired states of the solenoids. The\n LSB represents solenoid 0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.CounterBase" + "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.interfaces.CounterBase", - "functionName": "reset", + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "unreserveCompressor", "returnType": "None", - "tooltip": "" + "tooltip": "Unreserve the compressor." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.CounterBase" + "type": "wpilib.PneumaticsBase" }, { "defaultValue": "", - "name": "maxPeriod", - "type": "wpimath.units.seconds" + "name": "mask", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.CounterBase", - "functionName": "setMaxPeriod", + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "unreserveSolenoids", "returnType": "None", - "tooltip": "" + "tooltip": "Unreserve the solenoids marked in the bitmask.\n\n:param mask: The bitmask of solenoids to unreserve. The LSB represents\n solenoid 0." } ], "instanceVariables": [], - "moduleName": "wpilib.interfaces", - "staticMethods": [] - }, - { - "className": "wpilib.interfaces.GenericHID", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "port", - "type": "int" - } - ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "__init__", - "returnType": "wpilib.interfaces.GenericHID", - "tooltip": "" - } - ], - "enums": [ - { - "enumClassName": "wpilib.interfaces.GenericHID.HIDType", - "enumValues": [ - "kHID1stPerson", - "kHIDDriving", - "kHIDFlight", - "kHIDGamepad", - "kHIDJoystick", - "kUnknown", - "kXInputArcadePad", - "kXInputArcadeStick", - "kXInputDancePad", - "kXInputDrumKit", - "kXInputFlightStick", - "kXInputGamepad", - "kXInputGuitar", - "kXInputGuitar2", - "kXInputGuitar3", - "kXInputUnknown", - "kXInputWheel" - ], - "moduleName": "wpilib.interfaces", - "tooltip": "USB HID interface type.\n\nMembers:\n\n kUnknown : Unknown.\n\n kXInputUnknown : XInputUnknown.\n\n kXInputGamepad : XInputGamepad.\n\n kXInputWheel : XInputWheel.\n\n kXInputArcadeStick : XInputArcadeStick.\n\n kXInputFlightStick : XInputFlightStick.\n\n kXInputDancePad : XInputDancePad.\n\n kXInputGuitar : XInputGuitar.\n\n kXInputGuitar2 : XInputGuitar2.\n\n kXInputDrumKit : XInputDrumKit.\n\n kXInputGuitar3 : XInputGuitar3.\n\n kXInputArcadePad : XInputArcadePad.\n\n kHIDJoystick : HIDJoystick.\n\n kHIDGamepad : HIDGamepad.\n\n kHIDDriving : HIDDriving.\n\n kHIDFlight : HIDFlight.\n\n kHID1stPerson : HID1stPerson." - }, - { - "enumClassName": "wpilib.interfaces.GenericHID.RumbleType", - "enumValues": [ - "kBothRumble", - "kLeftRumble", - "kRightRumble" - ], - "moduleName": "wpilib.interfaces", - "tooltip": "Represents a rumble output on the Joystick.\n\nMembers:\n\n kLeftRumble : Left rumble motor.\n\n kRightRumble : Right rumble motor.\n\n kBothRumble : Both left and right rumble motors." - } - ], - "instanceMethods": [ + "moduleName": "wpilib", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "angle", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "moduleType", + "type": "wpilib.PneumaticsModuleType" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POV", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getDefaultForType", + "returnType": "int", + "tooltip": "For internal use to get the default for a specific type.\n\n:param moduleType: module type\n\n:returns: module default" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" + "name": "busId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "pov", - "type": "int" + "name": "module", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "angle", - "type": "int" - }, + "name": "moduleType", + "type": "wpilib.PneumaticsModuleType" + } + ], + "declaringClassName": "wpilib.PneumaticsBase", + "functionName": "getForType", + "returnType": "wpilib.PneumaticsBase", + "tooltip": "For internal use to get a module for a specific type.\n\n:param busId: The bus ID.\n:param module: module number\n:param moduleType: module type\n\n:returns: module" + } + ] + }, + { + "className": "wpilib.PneumaticsControlModule", + "classVariables": [], + "constructors": [ + { + "args": [ { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "busId", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POV", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(eg right is 90, upper-left is 315).\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle in degrees, or -1 for the center / not pressed.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "__init__", + "returnType": "wpilib.PneumaticsControlModule", + "tooltip": "Constructs a PneumaticsControlModule with the default ID (0).\n\n:param busId: The bus ID." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.GenericHID" + "name": "busId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "module", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVCenter", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the center (not pressed) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the center of a POV on the\n HID." - }, + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "__init__", + "returnType": "wpilib.PneumaticsControlModule", + "tooltip": "Constructs a PneumaticsControlModule.\n\n:param busId: The bus ID.\n:param module: module number to construct" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "mask", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDown", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 180 degree angle (down)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 180 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "checkAndReserveSolenoids", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDownLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 225 degree angle (down\nleft) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 225 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "checkSolenoidChannel", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVDownRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 135 degree angle (right\ndown) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 135 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "clearAllStickyFaults", + "returnType": "None", + "tooltip": "Clears all sticky faults on this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 270 degree angle (left)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 270 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "disableCompressor", + "returnType": "None", + "tooltip": "Disables the compressor. The compressor will not turn on until\nEnableCompressorDigital() is called." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "minPressure", + "type": "wpimath.units.pounds_per_square_inch" + }, + { + "defaultValue": "", + "name": "maxPressure", + "type": "wpimath.units.pounds_per_square_inch" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 90 degree angle (right)\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 90 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "enableCompressorAnalog", + "returnType": "None", + "tooltip": "Enables the compressor in digital mode. Analog mode is unsupported by the\nCTRE PCM.\n\n:param minPressure: Unsupported.\n:param maxPressure: Unsupported.\n @see EnableCompressorDigital()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUp", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 0 degree angle (up) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 0 degree angle of a POV on\n the HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "enableCompressorDigital", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "minPressure", + "type": "wpimath.units.pounds_per_square_inch" + }, + { + "defaultValue": "", + "name": "maxPressure", + "type": "wpimath.units.pounds_per_square_inch" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUpLeft", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 315 degree angle (left\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 315 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "enableCompressorHybrid", + "returnType": "None", + "tooltip": "Enables the compressor in digital mode. Hybrid mode is unsupported by the\nCTRE PCM.\n\n:param minPressure: Unsupported.\n:param maxPressure: Unsupported.\n @see EnableCompressorDigital()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "index", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "POVUpRight", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs a BooleanEvent instance based around the 45 degree angle (right\nup) of the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the 45 degree angle of a POV\n on the HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "fireOneShot", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "axisGreaterThan", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance that is true when the axis value is greater\nthan threshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value above which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is greater than\n the provided threshold." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getAnalogVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Unsupported by the CTRE PCM.\n\n:param channel: Unsupported.\n\n:returns: 0" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" - }, - { - "defaultValue": "", - "name": "threshold", - "type": "float" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "axisLessThan", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance that is true when the axis value is less than\nthreshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value below which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is less than the\n provided threshold." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getCompressor", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" - }, - { - "defaultValue": "", - "name": "loop", - "type": "wpilib.event.EventLoop" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "button", - "returnType": "wpilib.event.BooleanEvent", - "tooltip": "Constructs an event instance around this button's digital signal.\n\n:param button: the button index\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the button's digital signal attached\n to the given loop." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getCompressorConfigType", + "returnType": "wpilib.CompressorConfigType", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getAxisCount", - "returnType": "int", - "tooltip": "Get the number of axes for the HID.\n\n:returns: the number of axis for the current HID" + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getCompressorCurrent", + "returnType": "wpimath.units.amperes", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, + "type": "wpilib.PneumaticsControlModule" + } + ], + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getCompressorCurrentTooHighFault", + "returnType": "bool", + "tooltip": "Return whether the compressor current is currently too high.\n\n:returns: True if the compressor current is too high, otherwise false.\n @see GetCompressorCurrentTooHighStickyFault()" + }, + { + "args": [ { "defaultValue": "", - "name": "axis", - "type": "int" + "name": "self", + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getAxisType", - "returnType": "int", - "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getCompressorCurrentTooHighStickyFault", + "returnType": "bool", + "tooltip": "Returns whether the compressor current has been too high since sticky\nfaults were last cleared. This fault is persistent and can be cleared by\nClearAllStickyFaults()\n\n:returns: True if the compressor current has been too high since sticky\n faults were last cleared.\n @see GetCompressorCurrentTooHighFault()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getButtonCount", - "returnType": "int", - "tooltip": "Get the number of buttons for the HID.\n\n:returns: the number of buttons on the current HID" + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getCompressorNotConnectedFault", + "returnType": "bool", + "tooltip": "Returns whether the compressor is currently disconnected.\n\n:returns: True if compressor is currently disconnected, otherwise false.\n @see GetCompressorNotConnectedStickyFault()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getName", - "returnType": "str", - "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getCompressorNotConnectedStickyFault", + "returnType": "bool", + "tooltip": "Returns whether the compressor has been disconnected since sticky faults\nwere last cleared. This fault is persistent and can be cleared by\nClearAllStickyFaults()\n\n:returns: True if the compressor has been disconnected since sticky faults\n were last cleared, otherwise false.\n @see GetCompressorNotConnectedFault()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "0", - "name": "pov", - "type": "int" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPOV", - "returnType": "int", - "tooltip": "Get the angle in degrees of a POV on the HID.\n\nThe POV angles start at 0 in the up direction, and increase clockwise\n(e.g. right is 90, upper-left is 315).\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV in degrees, or -1 if the POV is not pressed." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getCompressorShortedFault", + "returnType": "bool", + "tooltip": "Returns whether the compressor is currently shorted.\n\n:returns: True if the compressor is currently shorted, otherwise false.\n @see GetCompressorShortedStickyFault()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPOVCount", - "returnType": "int", - "tooltip": "Get the number of POVs for the HID.\n\n:returns: the number of POVs for the current HID" + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getCompressorShortedStickyFault", + "returnType": "bool", + "tooltip": "Returns whether the compressor has been shorted since sticky faults were\nlast cleared. This fault is persistent and can be cleared by\nClearAllStickyFaults()\n\n:returns: True if the compressor has been shorted since sticky faults were\n last cleared, otherwise false.\n @see GetCompressorShortedFault()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getPort", + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getModuleNumber", "returnType": "int", - "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "axis", - "type": "int" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawAxis", - "returnType": "float", - "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getPressure", + "returnType": "wpimath.units.pounds_per_square_inch", + "tooltip": "Unsupported by the CTRE PCM.\n\n:param channel: Unsupported.\n\n:returns: 0" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButton", + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getPressureSwitch", "returnType": "bool", - "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, + "type": "wpilib.PneumaticsControlModule" + } + ], + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getSolenoidDisabledList", + "returnType": "int", + "tooltip": "" + }, + { + "args": [ { "defaultValue": "", - "name": "button", - "type": "int" + "name": "self", + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonPressed", + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getSolenoidVoltageFault", "returnType": "bool", - "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." + "tooltip": "Returns whether the solenoid is currently reporting a voltage fault.\n\n:returns: True if solenoid is reporting a fault, otherwise false.\n @see GetSolenoidVoltageStickyFault()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getRawButtonReleased", + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getSolenoidVoltageStickyFault", "returnType": "bool", - "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." + "tooltip": "Returns whether the solenoid has reported a voltage fault since sticky\nfaults were last cleared. This fault is persistent and can be cleared by\nClearAllStickyFaults()\n\n:returns: True if solenoid is reporting a fault, otherwise false.\n @see GetSolenoidVoltageFault()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "getType", - "returnType": "wpilib.interfaces.GenericHID.HIDType", - "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getSolenoids", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "isConnected", - "returnType": "bool", - "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "makeCompressor", + "returnType": "wpilib.Compressor", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "outputNumber", - "type": "int" + "name": "forwardChannel", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "reverseChannel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setOutput", - "returnType": "None", - "tooltip": "Set a single HID output value for the HID.\n\n:param outputNumber: The index of the output to set (1-32)\n:param value: The value to set the output to" + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "makeDoubleSolenoid", + "returnType": "wpilib.DoubleSolenoid", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "value", - "type": "int" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setOutputs", - "returnType": "None", - "tooltip": "Set all output values for the HID.\n\n:param value: The 32 bit output value (1 bit for each output)" + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "makeSolenoid", + "returnType": "wpilib.Solenoid", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.GenericHID" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "type", - "type": "wpilib.interfaces.GenericHID.RumbleType" + "name": "device", + "type": "str" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "data", + "type": "str" } ], - "declaringClassName": "wpilib.interfaces.GenericHID", - "functionName": "setRumble", + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "reportUsage", "returnType": "None", - "tooltip": "Set the rumble output for the HID.\n\nThe DS currently supports 2 rumble values, left rumble and right rumble.\n\n:param type: Which rumble value to set\n:param value: The normalized value (0 to 1) to set the rumble to" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.interfaces", - "staticMethods": [] - }, - { - "className": "wpilib.interfaces.MotorController", - "classVariables": [], - "constructors": [ + "tooltip": "" + }, { - "args": [], - "declaringClassName": "wpilib.interfaces.MotorController", - "functionName": "__init__", - "returnType": "wpilib.interfaces.MotorController", + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PneumaticsControlModule" + } + ], + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "reserveCompressor", + "returnType": "bool", "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.MotorController" + "type": "wpilib.PneumaticsControlModule" + }, + { + "defaultValue": "", + "name": "index", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "duration", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.interfaces.MotorController", - "functionName": "disable", + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "setOneShotDuration", "returnType": "None", - "tooltip": "Common interface for disabling a motor." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.MotorController" + "type": "wpilib.PneumaticsControlModule" + }, + { + "defaultValue": "", + "name": "mask", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "values", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.MotorController", - "functionName": "get", - "returnType": "float", - "tooltip": "Common interface for getting the current set speed of a motor controller.\n\n:returns: The current set speed. Value is between -1.0 and 1.0." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "setSolenoids", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.MotorController" + "type": "wpilib.PneumaticsControlModule" } ], - "declaringClassName": "wpilib.interfaces.MotorController", - "functionName": "getInverted", - "returnType": "bool", - "tooltip": "Common interface for returning the inversion state of a motor controller.\n\n:returns: isInverted The state of inversion, true is inverted." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "unreserveCompressor", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.interfaces.MotorController" + "type": "wpilib.PneumaticsControlModule" }, { "defaultValue": "", - "name": "speed", - "type": "float" + "name": "mask", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.MotorController", - "functionName": "set", + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "unreserveSolenoids", "returnType": "None", - "tooltip": "Common interface for setting the speed of a motor controller.\n\n:param speed: The speed to set. Value should be between -1.0 and 1.0." - }, + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.MotorController" - }, - { - "defaultValue": "", - "name": "isInverted", - "type": "bool" + "name": "moduleType", + "type": "wpilib.PneumaticsModuleType" } ], - "declaringClassName": "wpilib.interfaces.MotorController", - "functionName": "setInverted", - "returnType": "None", - "tooltip": "Common interface for inverting direction of a motor controller.\n\n:param isInverted: The state of inversion, true is inverted." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getDefaultForType", + "returnType": "int", + "tooltip": "For internal use to get the default for a specific type.\n\n:param moduleType: module type\n\n:returns: module default" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.MotorController" + "name": "busId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "output", - "type": "wpimath.units.volts" + "name": "module", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "moduleType", + "type": "wpilib.PneumaticsModuleType" } ], - "declaringClassName": "wpilib.interfaces.MotorController", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Sets the voltage output of the MotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + "declaringClassName": "wpilib.PneumaticsControlModule", + "functionName": "getForType", + "returnType": "wpilib.PneumaticsBase", + "tooltip": "For internal use to get a module for a specific type.\n\n:param busId: The bus ID.\n:param module: module number\n:param moduleType: module type\n\n:returns: module" + } + ] + }, + { + "className": "wpilib.PneumaticsModuleType", + "classVariables": [ + { + "name": "CTREPCM", + "tooltip": "", + "type": "wpilib.PneumaticsModuleType", + "writable": false }, + { + "name": "REVPH", + "tooltip": "", + "type": "wpilib.PneumaticsModuleType", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.interfaces.MotorController" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.interfaces.MotorController", - "functionName": "stopMotor", - "returnType": "None", - "tooltip": "Common interface to stop the motor until Set is called again." + "declaringClassName": "wpilib.PneumaticsModuleType", + "functionName": "__init__", + "returnType": "wpilib.PneumaticsModuleType", + "tooltip": "" } ], - "instanceVariables": [], - "moduleName": "wpilib.interfaces", + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.shuffleboard.ComplexWidget", - "classVariables": [], + "className": "wpilib.PowerDistribution", + "classVariables": [ + { + "name": "kDefaultModule", + "tooltip": "", + "type": "int", + "writable": false + } + ], "constructors": [ { "args": [ { "defaultValue": "", - "name": "parent", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "name": "busId", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "__init__", + "returnType": "wpilib.PowerDistribution", + "tooltip": "Constructs a PowerDistribution object.\n\nDetects the connected PDP/PDH using the default CAN ID (0 for CTRE and 1\nfor REV).\n\n:param busId: The bus ID." + }, + { + "args": [ + { + "defaultValue": "", + "name": "busId", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "title", - "type": "str" + "name": "module", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "sendable", - "type": "wpiutil.Sendable" + "name": "moduleType", + "type": "wpilib.PowerDistribution.ModuleType" } ], - "declaringClassName": "wpilib.shuffleboard.ComplexWidget", + "declaringClassName": "wpilib.PowerDistribution", "functionName": "__init__", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "" + "returnType": "wpilib.PowerDistribution", + "tooltip": "Constructs a PowerDistribution object.\n\n:param busId: The bus ID.\n:param module: The CAN ID of the PDP/PDH\n:param moduleType: The type of module" } ], "enums": [], @@ -36358,263 +18702,264 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ComplexWidget" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, + "type": "wpilib.PowerDistribution" + } + ], + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "clearStickyFaults", + "returnType": "None", + "tooltip": "Remove all of the fault flags on the PDP/PDH." + }, + { + "args": [ { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "self", + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard.ComplexWidget", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getAllCurrents", + "returnType": "list[float]", + "tooltip": "Query all currents of the PDP.\n\n:returns: The current of each channel in Amperes" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PowerDistribution" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getCurrent", + "returnType": "float", + "tooltip": "Query the current of a single channel of the PDP/PDH.\n\n:param channel: the channel to query (0-15 for PDP, 0-23 for PDH)\n\n:returns: The current of the channel in Amperes" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ComplexWidget" + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard.ComplexWidget", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getFaults", + "returnType": "wpilib.PowerDistribution.Faults", + "tooltip": "Returns the power distribution faults.\n\nOn a CTRE PDP, this will return an object with no faults active.\n\n:returns: The power distribution faults." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ComplexWidget" + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard.ComplexWidget", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getModule", + "returnType": "int", + "tooltip": "Gets module number (CAN ID)." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getNumChannels", + "returnType": "int", + "tooltip": "Gets the number of channels for this power distribution object.\n\n:returns: Number of output channels (16 for PDP, 24 for PDH)." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getStickyFaults", + "returnType": "wpilib.PowerDistribution.StickyFaults", + "tooltip": "Returns the power distribution sticky faults.\n\nOn a CTRE PDP, this will return an object with no faults active.\n\n:returns: The power distribution sticky faults." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getSwitchableChannel", + "returnType": "bool", + "tooltip": "Gets whether the PDH switchable channel is turned on or off. Returns false\nwith the CTRE PDP.\n\n:returns: The output state of the PDH switchable channel" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getTemperature", + "returnType": "float", + "tooltip": "Query the temperature of the PDP.\n\nNot supported on the Rev PDH and returns 0.\n\n:returns: The temperature in degrees Celsius" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexComponent" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexComponent", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getTotalCurrent", + "returnType": "float", + "tooltip": "Query the total current of all monitored PDP/PDH channels.\n\n:returns: The total current drawn from all channels in Amperes" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexComponent" - }, + "type": "wpilib.PowerDistribution" + } + ], + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getTotalEnergy", + "returnType": "float", + "tooltip": "Query the total energy drawn from the monitored PDP channels.\n\nNot supported on the Rev PDH and returns 0.\n\n:returns: The total energy drawn in Joules" + }, + { + "args": [ { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "self", + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexComponent", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getTotalPower", + "returnType": "float", + "tooltip": "Query the total power drawn from all monitored PDP channels.\n\nNot supported on the Rev PDH and returns 0.\n\n:returns: The total power drawn in Watts" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexComponent" - }, + "type": "wpilib.PowerDistribution" + } + ], + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getType", + "returnType": "wpilib.PowerDistribution.ModuleType", + "tooltip": "Gets module type." + }, + { + "args": [ { "defaultValue": "", - "name": "width", - "type": "int" - }, + "name": "self", + "type": "wpilib.PowerDistribution" + } + ], + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getVersion", + "returnType": "wpilib.PowerDistribution.Version", + "tooltip": "" + }, + { + "args": [ { "defaultValue": "", - "name": "height", - "type": "int" + "name": "self", + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexComponent", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "getVoltage", + "returnType": "float", + "tooltip": "Query the input voltage of the PDP/PDH.\n\n:returns: The input voltage in volts" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexWidget" + "type": "wpilib.PowerDistribution" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexWidget" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "resetTotalEnergy", + "returnType": "None", + "tooltip": "Reset the total energy drawn from the PDP.\n\nNot supported on the Rev PDH and does nothing.\n\n@see PowerDistribution#GetTotalEnergy" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexWidget" + "type": "wpilib.PowerDistribution" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.PowerDistribution", + "functionName": "setSwitchableChannel", + "returnType": "None", + "tooltip": "Sets the PDH switchable channel on or off. Does nothing with the CTRE PDP.\n\n:param enabled: Whether to turn the PDH switchable channel on or off" } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", + "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.shuffleboard.LayoutType", + "className": "wpilib.PowerDistribution.Faults", "classVariables": [], "constructors": [ { - "args": [ - { - "defaultValue": "", - "name": "layoutName", - "type": "str" - } - ], - "declaringClassName": "wpilib.shuffleboard.LayoutType", + "args": [], + "declaringClassName": "wpilib.PowerDistribution.Faults", "functionName": "__init__", - "returnType": "wpilib.shuffleboard.LayoutType", + "returnType": "wpilib.PowerDistribution.Faults", "tooltip": "" } ], @@ -36625,212 +18970,247 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.LayoutType" - } - ], - "declaringClassName": "wpilib.shuffleboard.LayoutType", - "functionName": "getLayoutName", - "returnType": "str", - "tooltip": "Gets the string type of the layout as defined by that layout in\nShuffleboard." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.Shuffleboard", - "classVariables": [ - { - "name": "kBaseTableName", - "tooltip": "", - "type": "str", - "writable": false - } - ], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" + "type": "wpilib.PowerDistribution.Faults" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.Shuffleboard", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "declaringClassName": "wpilib.PowerDistribution.Faults", + "functionName": "getBreakerFault", + "returnType": "bool", + "tooltip": "Gets whether there is a breaker fault at a specified channel.\n\n:param channel: Channel to check for faults.\n\n:returns: If there is a breaker fault.\n @throws A ChannelIndexOutOfRange error if the given int is outside of the\n range supported by the hardware." } ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [ + "instanceVariables": [ { - "args": [ - { - "defaultValue": "", - "name": "name", - "type": "str" - }, - { - "defaultValue": "", - "name": "description", - "type": "str" - }, - { - "defaultValue": "", - "name": "importance", - "type": "wpilib.shuffleboard.ShuffleboardEventImportance" - } - ], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "addEventMarker", - "returnType": "None", - "tooltip": "Notifies Shuffleboard of an event. Events can range from as trivial as a\nchange in a command state to as critical as a total power loss or component\nfailure. If Shuffleboard is recording, the event will also be recorded.\n\nIf ``name`` is ``null`` or empty, no event will be sent and an\nerror will be printed to the driver station.\n\n:param name: the name of the event\n:param description: a description of the event\n:param importance: the importance of the event" + "name": "Brownout", + "tooltip": "The input voltage is below the minimum voltage.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "name", - "type": "str" - }, - { - "defaultValue": "", - "name": "importance", - "type": "wpilib.shuffleboard.ShuffleboardEventImportance" - } - ], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "addEventMarker", - "returnType": "None", - "tooltip": "Notifies Shuffleboard of an event. Events can range from as trivial as a\nchange in a command state to as critical as a total power loss or component\nfailure. If Shuffleboard is recording, the event will also be recorded.\n\nIf ``name`` is ``null`` or empty, no event will be sent and an\nerror will be printed to the driver station.\n\n:param name: the name of the event\n:param importance: the importance of the event" + "name": "CanWarning", + "tooltip": "A warning was raised by the device's CAN controller.", + "type": "int", + "writable": true }, { - "args": [], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "clearRecordingFileNameFormat", - "returnType": "None", - "tooltip": "Clears the custom name format for recording files. New recordings will use\nthe default format.\n\n@see SetRecordingFileNameFormat(std::string_view)" + "name": "Channel0BreakerFault", + "tooltip": "Breaker fault on channel 0.", + "type": "int", + "writable": true }, { - "args": [], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "disableActuatorWidgets", - "returnType": "None", - "tooltip": "Disables user control of widgets containing actuators. For safety reasons,\nactuators should only be controlled while in test mode. IterativeRobotBase\nand SampleRobot are both configured to call this method when exiting in\ntest mode; most users should not need to use this method directly." + "name": "Channel10BreakerFault", + "tooltip": "Breaker fault on channel 10.", + "type": "int", + "writable": true }, { - "args": [], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "enableActuatorWidgets", - "returnType": "None", - "tooltip": "Enables user control of widgets containing actuators: motor controllers,\nrelays, etc. This should only be used when the robot is in test mode.\nIterativeRobotBase and SampleRobot are both configured to call this method\nwhen entering test mode; most users should not need to use this method\ndirectly." + "name": "Channel11BreakerFault", + "tooltip": "Breaker fault on channel 12.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "title", - "type": "str" - } - ], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "getTab", - "returnType": "wpilib.shuffleboard.ShuffleboardTab", - "tooltip": "Gets the Shuffleboard tab with the given title, creating it if it does not\nalready exist.\n\n:param title: the title of the tab\n\n:returns: the tab with the given title" + "name": "Channel12BreakerFault", + "tooltip": "Breaker fault on channel 13.", + "type": "int", + "writable": true + }, + { + "name": "Channel13BreakerFault", + "tooltip": "Breaker fault on channel 14.", + "type": "int", + "writable": true + }, + { + "name": "Channel14BreakerFault", + "tooltip": "Breaker fault on channel 15.", + "type": "int", + "writable": true + }, + { + "name": "Channel15BreakerFault", + "tooltip": "Breaker fault on channel 16.", + "type": "int", + "writable": true + }, + { + "name": "Channel16BreakerFault", + "tooltip": "Breaker fault on channel 17.", + "type": "int", + "writable": true + }, + { + "name": "Channel17BreakerFault", + "tooltip": "Breaker fault on channel 18.", + "type": "int", + "writable": true + }, + { + "name": "Channel18BreakerFault", + "tooltip": "Breaker fault on channel 19.", + "type": "int", + "writable": true + }, + { + "name": "Channel19BreakerFault", + "tooltip": "Breaker fault on channel 20.", + "type": "int", + "writable": true + }, + { + "name": "Channel1BreakerFault", + "tooltip": "Breaker fault on channel 1.", + "type": "int", + "writable": true + }, + { + "name": "Channel20BreakerFault", + "tooltip": "Breaker fault on channel 21.", + "type": "int", + "writable": true + }, + { + "name": "Channel21BreakerFault", + "tooltip": "Breaker fault on channel 22.", + "type": "int", + "writable": true + }, + { + "name": "Channel22BreakerFault", + "tooltip": "Breaker fault on channel 23.", + "type": "int", + "writable": true + }, + { + "name": "Channel23BreakerFault", + "tooltip": "Breaker fault on channel 24.", + "type": "int", + "writable": true + }, + { + "name": "Channel2BreakerFault", + "tooltip": "Breaker fault on channel 2.", + "type": "int", + "writable": true + }, + { + "name": "Channel3BreakerFault", + "tooltip": "Breaker fault on channel 3.", + "type": "int", + "writable": true + }, + { + "name": "Channel4BreakerFault", + "tooltip": "Breaker fault on channel 4.", + "type": "int", + "writable": true + }, + { + "name": "Channel5BreakerFault", + "tooltip": "Breaker fault on channel 5.", + "type": "int", + "writable": true + }, + { + "name": "Channel6BreakerFault", + "tooltip": "Breaker fault on channel 6.", + "type": "int", + "writable": true + }, + { + "name": "Channel7BreakerFault", + "tooltip": "Breaker fault on channel 7.", + "type": "int", + "writable": true + }, + { + "name": "Channel8BreakerFault", + "tooltip": "Breaker fault on channel 8.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "index", - "type": "int" - } - ], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "selectTab", - "returnType": "None", - "tooltip": "Selects the tab in the dashboard with the given index in the range\n[0..n-1], where *n* is the number of tabs in the dashboard at the time\nthis method is called.\n\n:param index: the index of the tab to select" + "name": "Channel9BreakerFault", + "tooltip": "Breaker fault on channel 9.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "title", - "type": "str" - } - ], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "selectTab", - "returnType": "None", - "tooltip": "Selects the tab in the dashboard with the given title.\n\n:param title: the title of the tab to select" + "name": "HardwareFault", + "tooltip": "The hardware on the device has malfunctioned.", + "type": "int", + "writable": true + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.PowerDistribution.ModuleType", + "classVariables": [ + { + "name": "kCTRE", + "tooltip": "", + "type": "wpilib.PowerDistribution.ModuleType", + "writable": false }, + { + "name": "kRev", + "tooltip": "", + "type": "wpilib.PowerDistribution.ModuleType", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "format", - "type": "str" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "setRecordingFileNameFormat", - "returnType": "None", - "tooltip": "Sets the file name format for new recording files to use. If recording is\nin progress when this method is called, it will continue to use the same\nfile. New recordings will use the format.\n\nTo avoid recording files overwriting each other, make sure to use unique\nrecording file names. File name formats accept templates for inserting the\ndate and time when the recording started with the ``${date``} and\n``${time``} templates, respectively. For example, the default format is\n``\"recording-${time``\"} and recording files created with it will have\nnames like ``\"recording-2018.01.15.sbr\"``. Users are\n**strongly** recommended to use the ``${time``} template\nto ensure unique file names.\n

\n\n:param format: the format for the" - }, - { - "args": [], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "startRecording", - "returnType": "None", - "tooltip": "Starts data recording on the dashboard. Has no effect if recording is\nalready in progress." - }, + "declaringClassName": "wpilib.PowerDistribution.ModuleType", + "functionName": "__init__", + "returnType": "wpilib.PowerDistribution.ModuleType", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ { - "args": [], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "stopRecording", - "returnType": "None", - "tooltip": "Stops data recording on the dashboard. Has no effect if no recording is in\nprogress." + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, { - "args": [], - "declaringClassName": "wpilib.shuffleboard.Shuffleboard", - "functionName": "update", - "returnType": "None", - "tooltip": "Updates all the values in Shuffleboard. Iterative and timed robots are\npre-configured to call this method in the main robot loop; teams using\ncustom robot base classes, or subclass SampleRobot, should make sure to\ncall this repeatedly to keep data on the dashboard up to date." + "name": "value", + "tooltip": "", + "type": "int", + "writable": false } - ] + ], + "moduleName": "wpilib", + "staticMethods": [] }, { - "className": "wpilib.shuffleboard.ShuffleboardComponentBase", + "className": "wpilib.PowerDistribution.StickyFaults", "classVariables": [], "constructors": [ { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", + "args": [], + "declaringClassName": "wpilib.PowerDistribution.StickyFaults", "functionName": "__init__", - "returnType": "wpilib.shuffleboard.ShuffleboardComponentBase", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.PowerDistribution.StickyFaults", + "tooltip": "" } ], "enums": [], @@ -36840,2120 +19220,1754 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.PowerDistribution.StickyFaults" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.PowerDistribution.StickyFaults", + "functionName": "getBreakerFault", + "returnType": "bool", + "tooltip": "Gets whether there is a sticky breaker fault at the specified channel.\n\n:param channel: Index to check for sticky faults.\n\n:returns: True if there is a sticky breaker fault at the channel, otherwise\n false.\n @throws A ChannelIndexOutOfRange error if the provided channel is outside\n of the range supported by the hardware." + } + ], + "instanceVariables": [ + { + "name": "Brownout", + "tooltip": "The input voltage is below the minimum voltage.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "name": "CanBusOff", + "tooltip": "The device's CAN controller experienced a \"Bus Off\" event.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "name": "CanWarning", + "tooltip": "A warning was raised by the device's CAN controller.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "name": "Channel0BreakerFault", + "tooltip": "Breaker fault on channel 0.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "name": "Channel10BreakerFault", + "tooltip": "Breaker fault on channel 10.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "name": "Channel11BreakerFault", + "tooltip": "Breaker fault on channel 12.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "name": "Channel12BreakerFault", + "tooltip": "Breaker fault on channel 13.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.ShuffleboardContainer", - "classVariables": [], - "constructors": [ + "name": "Channel13BreakerFault", + "tooltip": "Breaker fault on channel 14.", + "type": "int", + "writable": true + }, { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "name": "Channel14BreakerFault", + "tooltip": "Breaker fault on channel 15.", + "type": "int", + "writable": true + }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "wpiutil.Sendable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Adds a widget to this container to display the given sendable.\n\n:param title: the title of the widget\n:param defaultValue: the sendable to display\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title" + "name": "Channel15BreakerFault", + "tooltip": "Breaker fault on channel 16.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "wpiutil.Sendable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Adds a widget to this container to display the given sendable.\n\n:param defaultValue: the sendable to display\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title, or if the sendable's name has not been\n specified" + "name": "Channel16BreakerFault", + "tooltip": "Breaker fault on channel 17.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "ntcore.Value" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::shared_ptr)\n Add(std::string_view title, std::shared_ptr defaultValue)" + "name": "Channel17BreakerFault", + "tooltip": "Breaker fault on channel 18.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "bool" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, bool)\n Add(std::string_view title, bool defaultValue)" + "name": "Channel18BreakerFault", + "tooltip": "Breaker fault on channel 19.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "float" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, double)\n Add(std::string_view title, double defaultValue)" + "name": "Channel19BreakerFault", + "tooltip": "Breaker fault on channel 20.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "float" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, double)\n Add(std::string_view title, double defaultValue)" + "name": "Channel1BreakerFault", + "tooltip": "Breaker fault on channel 1.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "int" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, int)\n Add(std::string_view title, int defaultValue)" + "name": "Channel20BreakerFault", + "tooltip": "Breaker fault on channel 21.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "str" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::string_view)\n Add(std::string_view title, std::string_view defaultValue)" + "name": "Channel21BreakerFault", + "tooltip": "Breaker fault on channel 22.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[bool]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "name": "Channel22BreakerFault", + "tooltip": "Breaker fault on channel 23.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "name": "Channel23BreakerFault", + "tooltip": "Breaker fault on channel 24.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "name": "Channel2BreakerFault", + "tooltip": "Breaker fault on channel 2.", + "type": "int", + "writable": true + }, + { + "name": "Channel3BreakerFault", + "tooltip": "Breaker fault on channel 3.", + "type": "int", + "writable": true + }, + { + "name": "Channel4BreakerFault", + "tooltip": "Breaker fault on channel 4.", + "type": "int", + "writable": true + }, + { + "name": "Channel5BreakerFault", + "tooltip": "Breaker fault on channel 5.", + "type": "int", + "writable": true + }, + { + "name": "Channel6BreakerFault", + "tooltip": "Breaker fault on channel 6.", + "type": "int", + "writable": true + }, + { + "name": "Channel7BreakerFault", + "tooltip": "Breaker fault on channel 7.", + "type": "int", + "writable": true + }, + { + "name": "Channel8BreakerFault", + "tooltip": "Breaker fault on channel 8.", + "type": "int", + "writable": true + }, + { + "name": "Channel9BreakerFault", + "tooltip": "Breaker fault on channel 9.", + "type": "int", + "writable": true + }, + { + "name": "FirmwareFault", + "tooltip": "The firmware on the device has malfunctioned.", + "type": "int", + "writable": true + }, + { + "name": "HardwareFault", + "tooltip": "The hardware on the device has malfunctioned.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[int]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "name": "HasReset", + "tooltip": "The device has rebooted.", + "type": "int", + "writable": true + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.PowerDistribution.Version", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.PowerDistribution.Version", + "functionName": "__init__", + "returnType": "wpilib.PowerDistribution.Version", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "FirmwareFix", + "tooltip": "Firmware fix version number.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[str]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "name": "FirmwareMajor", + "tooltip": "Firmware major version number.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], bool]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addBoolean", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "name": "FirmwareMinor", + "tooltip": "Firmware minor version number.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addBooleanArray", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "name": "HardwareMajor", + "tooltip": "Hardware major version number.", + "type": "int", + "writable": true }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], float]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addDouble", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "name": "HardwareMinor", + "tooltip": "Hardware minor version number.", + "type": "int", + "writable": true }, + { + "name": "UniqueId", + "tooltip": "Unique ID.", + "type": "int", + "writable": true + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.Preferences", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "name": "args", + "type": "tuple" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[float]]" + "name": "kwargs", + "type": "dict" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addDoubleArray", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" - }, + "declaringClassName": "wpilib.Preferences", + "functionName": "__init__", + "returnType": "wpilib.Preferences", + "tooltip": "Initialize self. See help(type(self)) for accurate signature." + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], float]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addFloat", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.Preferences", + "functionName": "containsKey", + "returnType": "bool", + "tooltip": "Returns whether or not there is a key with the given name.\n\n:param key: the key\n\n:returns: if there is a value at the given key" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[float]]" + "defaultValue": "False", + "name": "defaultValue", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addFloatArray", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.Preferences", + "functionName": "getBoolean", + "returnType": "bool", + "tooltip": "Returns the boolean at the given key. If this table does not have a value\nfor that position, then the given defaultValue value will be returned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], int]" + "defaultValue": "0.0", + "name": "defaultValue", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addInteger", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.Preferences", + "functionName": "getDouble", + "returnType": "float", + "tooltip": "Returns the double at the given key. If this table does not have a value\nfor that position, then the given defaultValue value will be returned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" + "defaultValue": "0.0", + "name": "defaultValue", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addIntegerArray", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.Preferences", + "functionName": "getFloat", + "returnType": "float", + "tooltip": "Returns the float at the given key. If this table does not have a value\nfor that position, then the given defaultValue value will be returned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], float]" + "defaultValue": "0", + "name": "defaultValue", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addNumber", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.Preferences", + "functionName": "getInt", + "returnType": "int", + "tooltip": "Returns the int at the given key. If this table does not have a value for\nthat position, then the given defaultValue value will be returned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[float]]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addNumberArray", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "args": [], + "declaringClassName": "wpilib.Preferences", + "functionName": "getKeys", + "returnType": "list[str]", + "tooltip": "Returns a vector of all the keys.\n\n:returns: a vector of the keys" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { - "defaultValue": "", + "defaultValue": "0", "name": "defaultValue", - "type": "ntcore.Value" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::shared_ptr), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(stdd::string_view, std::shared_ptr)\n Add(std::string_view title, std::shared_ptr defaultValue)" + "declaringClassName": "wpilib.Preferences", + "functionName": "getLong", + "returnType": "int", + "tooltip": "Returns the long (int64_t) at the given key. If this table does not have a\nvalue for that position, then the given defaultValue value will be\nreturned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { - "defaultValue": "", + "defaultValue": "''", "name": "defaultValue", - "type": "bool" + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, bool), the value in the widget will be saved\non the robot and will be used when the robot program next starts rather\nthan ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, bool)\n Add(std::string_view title, bool defaultValue)" + "declaringClassName": "wpilib.Preferences", + "functionName": "getString", + "returnType": "str", + "tooltip": "Returns the string at the given key. If this table does not have a value\nfor that position, then the given defaultValue will be returned.\n\n:param key: the key\n:param defaultValue: the value to return if none exists in the table\n\n:returns: either the value in the table, or the defaultValue" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "float" + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, double), the value in the widget will be saved\non the robot and will be used when the robot program next starts rather\nthan ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, double)\n Add(std::string_view title, double defaultValue)" + "declaringClassName": "wpilib.Preferences", + "functionName": "initBoolean", + "returnType": "None", + "tooltip": "Puts the given boolean into the preferences table if it doesn't\nalready exist." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "float" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, float), the value in the widget will be saved\non the robot and will be used when the robot program next starts rather\nthan ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, float)\n Add(std::string_view title, float defaultValue)" + "declaringClassName": "wpilib.Preferences", + "functionName": "initDouble", + "returnType": "None", + "tooltip": "Puts the given double into the preferences table if it doesn't\nalready exist." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "int" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, int64_t), the value in the widget will be\nsaved on the robot and will be used when the robot program next starts\nrather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std:string_view, int64_t)\n Add(std::string_view title, int64_t defaultValue)" + "declaringClassName": "wpilib.Preferences", + "functionName": "initFloat", + "returnType": "None", + "tooltip": "Puts the given float into the preferences table if it doesn't\nalready exist." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "str" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::string_view), the value in the widget\nwill be saved on the robot and will be used when the robot program next\nstarts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::string_view)\n Add(std::string_view title, std::string_view defaultValue)" + "declaringClassName": "wpilib.Preferences", + "functionName": "initInt", + "returnType": "None", + "tooltip": "Puts the given int into the preferences table if it doesn't\nalready exist." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[bool]" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.Preferences", + "functionName": "initLong", + "returnType": "None", + "tooltip": "Puts the given long into the preferences table if it doesn't\nalready exist." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" + "name": "value", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.Preferences", + "functionName": "initString", + "returnType": "None", + "tooltip": "Puts the given string into the preferences table if it doesn't\nalready exist." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.Preferences", + "functionName": "remove", + "returnType": "None", + "tooltip": "Remove a preference.\n\n:param key: the key" }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[int]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "args": [], + "declaringClassName": "wpilib.Preferences", + "functionName": "removeAll", + "returnType": "None", + "tooltip": "Remove all preferences." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[str]" + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in\nthe widget will be saved on the robot and will be used when the robot\nprogram next starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.Preferences", + "functionName": "setBoolean", + "returnType": "None", + "tooltip": "Puts the given boolean into the preferences table.\n\nThe key may not have any whitespace nor an equals sign.\n\n:param key: the key\n:param value: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addRaw", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.Preferences", + "functionName": "setDouble", + "returnType": "None", + "tooltip": "Puts the given double into the preferences table.\n\nThe key may not have any whitespace nor an equals sign.\n\n:param key: the key\n:param value: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "typeString", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addRaw", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param typeString: the NT type string\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.Preferences", + "functionName": "setFloat", + "returnType": "None", + "tooltip": "Puts the given float into the preferences table.\n\nThe key may not have any whitespace nor an equals sign.\n\n:param key: the key\n:param value: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], str]" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addString", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.Preferences", + "functionName": "setInt", + "returnType": "None", + "tooltip": "Puts the given int into the preferences table.\n\nThe key may not have any whitespace nor an equals sign.\n\n:param key: the key\n:param value: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[str]]" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addStringArray", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.Preferences", + "functionName": "setLong", + "returnType": "None", + "tooltip": "Puts the given long (int64_t) into the preferences table.\n\nThe key may not have any whitespace nor an equals sign.\n\n:param key: the key\n:param value: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "value", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", + "declaringClassName": "wpilib.Preferences", + "functionName": "setString", "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" - }, + "tooltip": "Puts the given string into the preferences table.\n\nThe value may not have quotation marks, nor may the key have any whitespace\nnor an equals sign.\n\n:param key: the key\n:param value: the value" + } + ] + }, + { + "className": "wpilib.RobotBase", + "classVariables": [], + "constructors": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "" - }, + "args": [], + "declaringClassName": "wpilib.RobotBase", + "functionName": "__init__", + "returnType": "wpilib.RobotBase", + "tooltip": "Constructor for a generic robot program.\n\nUser code can be placed in the constructor that runs before the\nAutonomous or Operator Control period starts. The constructor will run to\ncompletion before Autonomous is entered.\n\nThis must be used to ensure that the communications code starts. In the\nfuture it would be nice to put this code into it's own task that loads on\nboot so ensure that it runs." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.RobotBase", + "functionName": "endCompetition", "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getComponents", - "returnType": "list[wpilib.shuffleboard.ShuffleboardComponentBase]", - "tooltip": "Gets the components that are direct children of this container." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.shuffleboard.BuiltInLayouts" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the layout with the given type and title, creating it if it does not\nalready exist at the time this method is called.\n\n:param title: the title of the layout\n:param type: the type of the layout, eg \"List\" or \"Grid\"\n\n:returns: the layout" + "tooltip": "Ends the main loop in StartCompetition()." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.shuffleboard.LayoutType" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the layout with the given type and title, creating it if it does not\nalready exist at the time this method is called.\n\n:param title: the title of the layout\n:param type: the type of the layout, eg \"List\" or \"Grid\"\n\n:returns: the layout" + "declaringClassName": "wpilib.RobotBase", + "functionName": "getControlState", + "returnType": "tuple[bool, bool, bool]", + "tooltip": "More efficient way to determine what state the robot is in.\n\n:returns: booleans representing enabled, isautonomous, istest\n\n.. versionadded:: 2019.2.1\n\n.. note:: This function only exists in RobotPy" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the layout with the given type and title, creating it if it does not\nalready exist at the time this method is called. Note: this method should\nonly be used to use a layout type that is not already built into\nShuffleboard. To use a layout built into Shuffleboard, use\nGetLayout(std::string_view, const LayoutType&) and the layouts in\nBuiltInLayouts.\n\n:param title: the title of the layout\n:param type: the type of the layout, eg \"List Layout\" or \"Grid Layout\"\n\n:returns: the layout\n @see GetLayout(std::string_view, const LayoutType&)" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isAutonomous", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Autonomous mode.\n\n:returns: True if the robot is currently operating Autonomously as determined\n by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the already-defined layout in this container with the given title.\n\n
{@code\nShuffleboard::GetTab(\"Example Tab\")->getLayout(\"My Layout\",\n&BuiltInLayouts.kList);\n\n// Later...\nShuffleboard::GetTab(\"Example Tab\")->GetLayout(\"My Layout\");\n}
\n\n:param title: the title of the layout to get\n\n:returns: the layout with the given title\n @throws if no layout has yet been defined with the given title" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isAutonomousEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Autonomous mode and enabled.\n\n:returns: True if the robot us currently operating Autonomously while enabled\n as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.ShuffleboardLayout", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.RobotBase", + "functionName": "isDisabled", + "returnType": "bool", + "tooltip": "Determine if the Robot is currently disabled.\n\n:returns: True if the Robot is currently disabled by the Driver Station." + }, { "args": [ { "defaultValue": "", - "name": "parent", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "name", - "type": "str" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "name": "self", + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardLayout", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.RobotBase", + "functionName": "isEnabled", + "returnType": "bool", + "tooltip": "Determine if the Robot is currently enabled.\n\n:returns: True if the Robot is currently enabled by the Driver Station." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "wpiutil.Sendable" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Adds a widget to this container to display the given sendable.\n\n:param title: the title of the widget\n:param defaultValue: the sendable to display\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTeleop", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Operator Control mode.\n\n:returns: True if the robot is currently operating in Tele-Op mode as\n determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "wpiutil.Sendable" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Adds a widget to this container to display the given sendable.\n\n:param defaultValue: the sendable to display\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title, or if the sendable's name has not been\n specified" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTeleopEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is current in Operator Control mode and enabled.\n\n:returns: True if the robot is currently operating in Tele-Op mode while\n enabled as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "ntcore.Value" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::shared_ptr)\n Add(std::string_view title, std::shared_ptr defaultValue)" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTest", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Test mode.\n\n:returns: True if the robot is currently running in Test mode as determined\n by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "bool" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, bool)\n Add(std::string_view title, bool defaultValue)" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTestEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is current in Test mode and enabled.\n\n:returns: True if the robot is currently operating in Test mode while\n enabled as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "float" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, double)\n Add(std::string_view title, double defaultValue)" + "declaringClassName": "wpilib.RobotBase", + "functionName": "startCompetition", + "returnType": "None", + "tooltip": "Start the main robot code. This function will be called once and should not\nexit until signalled by EndCompetition()" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.RobotBase", + "functionName": "getRuntimeType", + "returnType": "wpilib.RuntimeType", + "tooltip": "Get the current runtime type.\n\n:returns: Current runtime type." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotBase", + "functionName": "isReal", + "returnType": "bool", + "tooltip": "Get if the robot is real.\n\n:returns: If the robot is running in the real world." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotBase", + "functionName": "isSimulation", + "returnType": "bool", + "tooltip": "Get if the robot is a simulation.\n\n:returns: If the robot is running in simulation." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, + "name": "robot_cls", + "type": "object" + } + ], + "declaringClassName": "wpilib.RobotBase", + "functionName": "main", + "returnType": "object", + "tooltip": "Starting point for the application" + } + ] + }, + { + "className": "wpilib.RobotController", + "classVariables": [], + "constructors": [ + { + "args": [ { "defaultValue": "", - "name": "title", - "type": "str" + "name": "args", + "type": "tuple" }, { "defaultValue": "", - "name": "defaultValue", - "type": "float" + "name": "kwargs", + "type": "dict" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, double)\n Add(std::string_view title, double defaultValue)" + "declaringClassName": "wpilib.RobotController", + "functionName": "__init__", + "returnType": "wpilib.RobotController", + "tooltip": "Initialize self. See help(type(self)) for accurate signature." + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getBatteryVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Read the battery voltage.\n\n:returns: The battery voltage in Volts." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getBrownoutVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Get the current brownout voltage setting.\n\n:returns: The brownout voltage" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "int" + "name": "busId", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, int)\n Add(std::string_view title, int defaultValue)" + "declaringClassName": "wpilib.RobotController", + "functionName": "getCANStatus", + "returnType": "wpilib.CANStatus", + "tooltip": "Get the current status of the CAN bus.\n\n:param busId: The bus ID.\n\n:returns: The status of the CAN bus" + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getCPUTemp", + "returnType": "wpimath.units.celsius", + "tooltip": "Get the current CPU temperature.\n\n:returns: current CPU temperature" + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getComments", + "returnType": "str", + "tooltip": "Return the comments from the roboRIO web interface.\n\nThe comments string is cached after the first call to this function on the\nRoboRIO - restart the robot code to reload the comments string after\nchanging it in the web interface.\n\n:returns: The comments from the roboRIO web interface." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getCommsDisableCount", + "returnType": "int", + "tooltip": "Gets the number of times the system has been disabled due to communication\nerrors with the Driver Station.\n\n:returns: number of disables due to communication errors." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getCurrent3V3", + "returnType": "float", + "tooltip": "Get the current output of the 3.3V rail.\n\n:returns: The controller 3.3V rail output current value in Amps" + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getEnabled3V3", + "returnType": "bool", + "tooltip": "Get the enabled state of the 3.3V rail. The rail may be disabled due to\ncalling SetEnabled3V3(), a controller brownout, a short circuit on the\nrail, or controller over-voltage.\n\n:returns: The controller 3.3V rail enabled value. True for enabled." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getFPGARevision", + "returnType": "int", + "tooltip": "Return the FPGA Revision number.\n\nThe format of the revision is 3 numbers. The 12 most significant bits are\nthe Major Revision. The next 8 bits are the Minor Revision. The 12 least\nsignificant bits are the Build Number.\n\n:returns: FPGA Revision number." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getFPGATime", + "returnType": "int", + "tooltip": "Read the microsecond-resolution timer on the FPGA.\n\n:returns: The current time in microseconds according to the FPGA (since FPGA\n reset)." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getFPGAVersion", + "returnType": "int", + "tooltip": "Return the FPGA Version number.\n\nFor now, expect this to be competition year.\n\n:returns: FPGA Version number." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getFaultCount3V3", + "returnType": "int", + "tooltip": "Get the count of the total current faults on the 3.3V rail since the\ncode started.\n\n:returns: The number of faults" + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getInputVoltage", + "returnType": "float", + "tooltip": "Get the input voltage to the robot controller.\n\n:returns: The controller input voltage value in Volts" + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getRSLState", + "returnType": "bool", + "tooltip": "Gets the current state of the Robot Signal Light (RSL)\n\n:returns: The current state of the RSL- true if on, false if off" + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getSerialNumber", + "returnType": "str", + "tooltip": "Return the serial number of the roboRIO.\n\n:returns: The serial number of the roboRIO." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getTeamNumber", + "returnType": "int", + "tooltip": "Returns the team number configured for the robot controller.\n\n:returns: team number, or 0 if not found." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getTime", + "returnType": "int", + "tooltip": "Read the microsecond timestamp. By default, the time is based on the FPGA\nhardware clock in microseconds since the FPGA started. However, the return\nvalue of this method may be modified to use any time base, including\nnon-monotonic and non-continuous time bases.\n\n:returns: The current time in microseconds." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "getVoltage3V3", + "returnType": "float", + "tooltip": "Get the voltage of the 3.3V rail.\n\n:returns: The controller 3.3V rail voltage value in Volts" + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "isBrownedOut", + "returnType": "bool", + "tooltip": "Check if the system is browned out.\n\n:returns: True if the system is browned out" + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "isSysActive", + "returnType": "bool", + "tooltip": "Check if the FPGA outputs are enabled.\n\nThe outputs may be disabled if the robot is disabled or e-stopped, the\nwatchdog has expired, or if the roboRIO browns out.\n\n:returns: True if the FPGA outputs are enabled." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "isSystemTimeValid", + "returnType": "bool", + "tooltip": "Gets if the system time is valid.\n\n:returns: True if the system time is valid, false otherwise" + }, + { + "args": [], + "declaringClassName": "wpilib.RobotController", + "functionName": "resetRailFaultCounts", + "returnType": "None", + "tooltip": "Reset the overcurrent fault counters for all user rails to 0." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "str" + "name": "brownoutVoltage", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::string_view)\n Add(std::string_view title, std::string_view defaultValue)" + "declaringClassName": "wpilib.RobotController", + "functionName": "setBrownoutVoltage", + "returnType": "None", + "tooltip": "Set the voltage the roboRIO will brownout and disable all outputs.\n\nNote that this only does anything on the roboRIO 2.\nOn the roboRIO it is a no-op.\n\n:param brownoutVoltage: The brownout voltage" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[bool]" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.RobotController", + "functionName": "setEnabled3V3", + "returnType": "None", + "tooltip": "Enables or disables the 3.3V rail.\n\n:param enabled: whether to enable the 3.3V rail." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, + "name": "supplier", + "type": "Callable[[], int]" + } + ], + "declaringClassName": "wpilib.RobotController", + "functionName": "setTimeSource", + "returnType": "None", + "tooltip": "Sets a new source to provide the clock time in microseconds. Changing this\naffects the return value of ``GetTime``.\n\n:param supplier: Function to return the time in microseconds." + } + ] + }, + { + "className": "wpilib.RobotState", + "classVariables": [], + "constructors": [ + { + "args": [ { "defaultValue": "", - "name": "title", - "type": "str" + "name": "args", + "type": "tuple" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" + "name": "kwargs", + "type": "dict" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.RobotState", + "functionName": "__init__", + "returnType": "wpilib.RobotState", + "tooltip": "Initialize self. See help(type(self)) for accurate signature." + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.RobotState", + "functionName": "isAutonomous", + "returnType": "bool", + "tooltip": "Returns true if the robot is in autonomous mode.\n\n:returns: True if the robot is in autonomous mode." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotState", + "functionName": "isDisabled", + "returnType": "bool", + "tooltip": "Returns true if the robot is disabled.\n\n:returns: True if the robot is disabled." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotState", + "functionName": "isEStopped", + "returnType": "bool", + "tooltip": "Returns true if the robot is E-stopped.\n\n:returns: True if the robot is E-stopped." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotState", + "functionName": "isEnabled", + "returnType": "bool", + "tooltip": "Returns true if the robot is enabled.\n\n:returns: True if the robot is enabled." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotState", + "functionName": "isTeleop", + "returnType": "bool", + "tooltip": "Returns true if the robot is in teleop mode.\n\n:returns: True if the robot is in teleop mode." + }, + { + "args": [], + "declaringClassName": "wpilib.RobotState", + "functionName": "isTest", + "returnType": "bool", + "tooltip": "Returns true if the robot is in test mode.\n\n:returns: True if the robot is in test mode." + } + ] + }, + { + "className": "wpilib.RuntimeType", + "classVariables": [ + { + "name": "kRoboRIO", + "tooltip": "", + "type": "wpilib.RuntimeType", + "writable": false + }, + { + "name": "kRoboRIO2", + "tooltip": "", + "type": "wpilib.RuntimeType", + "writable": false + }, + { + "name": "kSimulation", + "tooltip": "", + "type": "wpilib.RuntimeType", + "writable": false }, + { + "name": "kSystemCore", + "tooltip": "", + "type": "wpilib.RuntimeType", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.RuntimeType", + "functionName": "__init__", + "returnType": "wpilib.RuntimeType", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.SD540", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[int]" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" - }, + "declaringClassName": "wpilib.SD540", + "functionName": "__init__", + "returnType": "wpilib.SD540", + "tooltip": "Constructor for a SD540 connected via PWM.\n\n:param channel: The PWM channel that the SD540 is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[str]" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], bool]" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addBoolean", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addBooleanArray", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], float]" + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addDouble", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", + "returnType": "None", + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[float]]" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addDoubleArray", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], float]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addFloat", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[float]]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addFloatArray", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], int]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addInteger", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addIntegerArray", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], float]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addNumber", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[float]]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addNumberArray", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "defaultValue", - "type": "ntcore.Value" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::shared_ptr), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(stdd::string_view, std::shared_ptr)\n Add(std::string_view title, std::shared_ptr defaultValue)" + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "bool" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, bool), the value in the widget will be saved\non the robot and will be used when the robot program next starts rather\nthan ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, bool)\n Add(std::string_view title, bool defaultValue)" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "float" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, double), the value in the widget will be saved\non the robot and will be used when the robot program next starts rather\nthan ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, double)\n Add(std::string_view title, double defaultValue)" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "defaultValue", - "type": "float" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, float), the value in the widget will be saved\non the robot and will be used when the robot program next starts rather\nthan ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, float)\n Add(std::string_view title, float defaultValue)" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "defaultValue", - "type": "int" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, int64_t), the value in the widget will be\nsaved on the robot and will be used when the robot program next starts\nrather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std:string_view, int64_t)\n Add(std::string_view title, int64_t defaultValue)" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "defaultValue", - "type": "str" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::string_view), the value in the widget\nwill be saved on the robot and will be used when the robot program next\nstarts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::string_view)\n Add(std::string_view title, std::string_view defaultValue)" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[bool]" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", + "returnType": "None", + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" - }, + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.SD540", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] + }, + { + "className": "wpilib.SendableBuilderImpl", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "__init__", + "returnType": "wpilib.SendableBuilderImpl", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[int]" + "name": "getter", + "type": "Callable[[], list[int]]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[List[typing.SupportsInt]], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addBooleanArrayProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[str]" + "name": "getter", + "type": "Callable[[], bool]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[bool], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in\nthe widget will be saved on the robot and will be used when the robot\nprogram next starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addBooleanProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" + "name": "getter", + "type": "Callable[[], list[float]]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[List[typing.SupportsFloat]], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addRaw", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addDoubleArrayProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "typeString", - "type": "str" + "name": "getter", + "type": "Callable[[], float]" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" + "name": "setter", + "type": "Callable[[typing.SupportsFloat], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addRaw", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param typeString: the NT type string\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addDoubleProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], str]" + "name": "getter", + "type": "Callable[[], list[float]]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[List[typing.SupportsFloat]], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addString", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addFloatArrayProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[str]]" + "name": "getter", + "type": "Callable[[], float]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[typing.SupportsFloat], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addStringArray", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addFloatProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardLayout" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "getter", + "type": "Callable[[], list[int]]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[List[typing.SupportsInt]], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardLayout", - "functionName": "buildInto", + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addIntegerArrayProperty", "returnType": "None", "tooltip": "" }, @@ -38962,42 +20976,26 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ + "name": "key", + "type": "str" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ + "name": "getter", + "type": "Callable[[], int]" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "name": "setter", + "type": "Callable[[typing.SupportsInt], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addIntegerProperty", "returnType": "None", "tooltip": "" }, @@ -39006,112 +21004,88 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getComponents", - "returnType": "list[wpilib.shuffleboard.ShuffleboardComponentBase]", - "tooltip": "Gets the components that are direct children of this container." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "type", - "type": "wpilib.shuffleboard.BuiltInLayouts" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the layout with the given type and title, creating it if it does not\nalready exist at the time this method is called.\n\n:param title: the title of the layout\n:param type: the type of the layout, eg \"List\" or \"Grid\"\n\n:returns: the layout" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "name": "typeString", + "type": "str" }, { "defaultValue": "", - "name": "title", - "type": "str" + "name": "getter", + "type": "Callable[[], list[int]]" }, { "defaultValue": "", - "name": "type", - "type": "wpilib.shuffleboard.LayoutType" + "name": "setter", + "type": "Callable[[Buffer], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the layout with the given type and title, creating it if it does not\nalready exist at the time this method is called.\n\n:param title: the title of the layout\n:param type: the type of the layout, eg \"List\" or \"Grid\"\n\n:returns: the layout" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addRawProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "getter", + "type": "Callable[[List[typing.SupportsInt]], List[int]]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[List[typing.SupportsInt]], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the layout with the given type and title, creating it if it does not\nalready exist at the time this method is called. Note: this method should\nonly be used to use a layout type that is not already built into\nShuffleboard. To use a layout built into Shuffleboard, use\nGetLayout(std::string_view, const LayoutType&) and the layouts in\nBuiltInLayouts.\n\n:param title: the title of the layout\n:param type: the type of the layout, eg \"List Layout\" or \"Grid Layout\"\n\n:returns: the layout\n @see GetLayout(std::string_view, const LayoutType&)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addSmallBooleanArrayProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the already-defined layout in this container with the given title.\n\n
{@code\nShuffleboard::GetTab(\"Example Tab\")->getLayout(\"My Layout\",\n&BuiltInLayouts.kList);\n\n// Later...\nShuffleboard::GetTab(\"Example Tab\")->GetLayout(\"My Layout\");\n}
\n\n:param title: the title of the layout to get\n\n:returns: the layout with the given title\n @throws if no layout has yet been defined with the given title" - }, - { - "args": [ + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "getter", + "type": "Callable[[List[typing.SupportsFloat]], List[float]]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[List[typing.SupportsFloat]], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addSmallDoubleArrayProperty", + "returnType": "None", "tooltip": "" }, { @@ -39119,42 +21093,26 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." - }, - { - "args": [ + "type": "wpilib.SendableBuilderImpl" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" - }, - { - "args": [ + "name": "key", + "type": "str" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "getter", + "type": "Callable[[List[typing.SupportsFloat]], List[float]]" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "setter", + "type": "Callable[[List[typing.SupportsFloat]], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addSmallFloatArrayProperty", "returnType": "None", "tooltip": "" }, @@ -39163,1818 +21121,1742 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._LayoutComponent" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "columnIndex", - "type": "int" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" - } - ], - "declaringClassName": "wpilib.shuffleboard._LayoutComponent", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._LayoutComponent" + "name": "getter", + "type": "Callable[[List[typing.SupportsInt]], List[int]]" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "setter", + "type": "Callable[[List[typing.SupportsInt]], None]" } ], - "declaringClassName": "wpilib.shuffleboard._LayoutComponent", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addSmallIntegerArrayProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._LayoutComponent" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "width", - "type": "int" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "height", - "type": "int" - } - ], - "declaringClassName": "wpilib.shuffleboard._LayoutComponent", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.ShuffleboardTab", - "classVariables": [], - "constructors": [ - { - "args": [ + "name": "typeString", + "type": "str" + }, { "defaultValue": "", - "name": "root", - "type": "wpilib.shuffleboard._ShuffleboardRoot" + "name": "getter", + "type": "Callable[[List[typing.SupportsInt]], Buffer]" }, { "defaultValue": "", - "name": "title", - "type": "str" + "name": "setter", + "type": "Callable[[Buffer], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardTab", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.ShuffleboardTab", + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addSmallRawProperty", + "returnType": "None", "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "wpiutil.Sendable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Adds a widget to this container to display the given sendable.\n\n:param title: the title of the widget\n:param defaultValue: the sendable to display\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "name": "getter", + "type": "Callable[[List[str]], List[str]]" }, { "defaultValue": "", - "name": "defaultValue", - "type": "wpiutil.Sendable" + "name": "setter", + "type": "Callable[[List[str]], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Adds a widget to this container to display the given sendable.\n\n:param defaultValue: the sendable to display\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title, or if the sendable's name has not been\n specified" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addSmallStringArrayProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "ntcore.Value" + "name": "getter", + "type": "Callable[[List[str]], str]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[str], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::shared_ptr)\n Add(std::string_view title, std::shared_ptr defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addSmallStringProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "bool" + "name": "getter", + "type": "Callable[[], list[str]]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[List[str]], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, bool)\n Add(std::string_view title, bool defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addStringArrayProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "float" + "name": "getter", + "type": "Callable[[], str]" + }, + { + "defaultValue": "", + "name": "setter", + "type": "Callable[[str], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, double)\n Add(std::string_view title, double defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "addStringProperty", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, + "type": "wpilib.SendableBuilderImpl" + } + ], + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "clearProperties", + "returnType": "None", + "tooltip": "Clear properties." + }, + { + "args": [ { "defaultValue": "", - "name": "title", - "type": "str" - }, + "name": "self", + "type": "ntcore.NTSendableBuilder" + } + ], + "declaringClassName": "ntcore.NTSendableBuilder", + "functionName": "getBackendKind", + "returnType": "wpiutil.SendableBuilder.BackendKind", + "tooltip": "Gets the kind of backend being used.\n\n:returns: Backend kind" + }, + { + "args": [ { "defaultValue": "", - "name": "defaultValue", - "type": "float" + "name": "self", + "type": "wpilib.SendableBuilderImpl" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, double)\n Add(std::string_view title, double defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "getTable", + "returnType": "ntcore.NetworkTable", + "tooltip": "Get the network table.\n\n:returns: The network table" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "int" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, int)\n Add(std::string_view title, int defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "getTopic", + "returnType": "ntcore.Topic", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, + "type": "wpilib.SendableBuilderImpl" + } + ], + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "isActuator", + "returnType": "bool", + "tooltip": "Return whether this sendable should be treated as an actuator.\n\n:returns: True if actuator, false if not." + }, + { + "args": [ { "defaultValue": "", - "name": "defaultValue", - "type": "str" + "name": "self", + "type": "wpilib.SendableBuilderImpl" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::string_view)\n Add(std::string_view title, std::string_view defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "isPublished", + "returnType": "bool", + "tooltip": "Return whether this sendable has an associated table.\n\n:returns: True if it has a table, false if not." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[bool]" + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstBoolean", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" + "name": "value", + "type": "List[typing.SupportsInt]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstBooleanArray", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstDouble", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[int]" + "name": "value", + "type": "List[typing.SupportsFloat]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstDoubleArray", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "List[str]" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "add", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display the given data.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @throws IllegalArgumentException if a widget already exists in this\n container with the given title\n @see AddPersistent(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstFloat", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], bool]" + "name": "value", + "type": "List[typing.SupportsFloat]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addBoolean", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstFloatArray", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addBooleanArray", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstInteger", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], float]" + "name": "value", + "type": "List[typing.SupportsInt]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addDouble", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstIntegerArray", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[float]]" + "name": "typeString", + "type": "str" + }, + { + "defaultValue": "", + "name": "value", + "type": "Buffer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addDoubleArray", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstRaw", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], float]" + "name": "value", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addFloat", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstString", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "key", "type": "str" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[float]]" + "name": "value", + "type": "List[str]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addFloatArray", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "publishConstStringArray", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], int]" + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addInteger", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "setActuator", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "title", + "name": "type", "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addIntegerArray", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "setSmartDashboardType", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], float]" + "name": "table", + "type": "ntcore.NetworkTable" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addNumber", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "setTable", + "returnType": "None", + "tooltip": "Set the network table. Must be called prior to any Add* functions being\ncalled.\n\n:param table: Network table" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.SendableBuilderImpl" }, { "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[float]]" + "name": "func", + "type": "Callable[[], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addNumberArray", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "setUpdateTable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, + "type": "wpilib.SendableBuilderImpl" + } + ], + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "startListeners", + "returnType": "None", + "tooltip": "Hook setters for all properties." + }, + { + "args": [ { "defaultValue": "", - "name": "title", - "type": "str" - }, + "name": "self", + "type": "wpilib.SendableBuilderImpl" + } + ], + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "stopListeners", + "returnType": "None", + "tooltip": "Unhook setters for all properties." + }, + { + "args": [ { "defaultValue": "", - "name": "defaultValue", - "type": "ntcore.Value" + "name": "self", + "type": "wpilib.SendableBuilderImpl" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::shared_ptr), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(stdd::string_view, std::shared_ptr)\n Add(std::string_view title, std::shared_ptr defaultValue)" - }, + "declaringClassName": "wpilib.SendableBuilderImpl", + "functionName": "update", + "returnType": "None", + "tooltip": "Synchronize with network table values by calling the getters for all\nproperties and setters when the network table value has changed." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.SendableChooser", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.SendableChooser", + "functionName": "__init__", + "returnType": "wpilib.SendableChooser", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableChooser" }, { "defaultValue": "", - "name": "title", + "name": "name", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "bool" + "name": "object", + "type": "object" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, bool), the value in the widget will be saved\non the robot and will be used when the robot program next starts rather\nthan ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, bool)\n Add(std::string_view title, bool defaultValue)" + "declaringClassName": "wpilib.SendableChooser", + "functionName": "addOption", + "returnType": "None", + "tooltip": "Adds the given object to the list of options.\n\nOn the SmartDashboard on the desktop, the object will appear as the given\nname.\n\n:param name: the name of the option\n:param object: the option" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, + "type": "wpilib.SendableChooser" + } + ], + "declaringClassName": "wpilib.SendableChooser", + "functionName": "getSelected", + "returnType": "object", + "tooltip": "Returns a copy of the selected option (a std::weak_ptr if T =\nstd::shared_ptr).\n\nIf there is none selected, it will return the default. If there is none\nselected and no default, then it will return a value-initialized instance.\nFor integer types, this is 0. For container types like std::string, this is\nan empty string.\n\n:returns: The option selected" + }, + { + "args": [ { "defaultValue": "", - "name": "title", - "type": "str" + "name": "self", + "type": "wpilib.SendableChooser" }, { "defaultValue": "", - "name": "defaultValue", - "type": "float" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, double), the value in the widget will be saved\non the robot and will be used when the robot program next starts rather\nthan ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, double)\n Add(std::string_view title, double defaultValue)" + "declaringClassName": "wpilib.SendableChooser", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.SendableChooser" }, { "defaultValue": "", - "name": "defaultValue", - "type": "float" + "name": "listener", + "type": "Callable[[object], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, float), the value in the widget will be saved\non the robot and will be used when the robot program next starts rather\nthan ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, float)\n Add(std::string_view title, float defaultValue)" + "declaringClassName": "wpilib.SendableChooser", + "functionName": "onChange", + "returnType": "None", + "tooltip": "Bind a listener that's called when the selected value changes.\nOnly one listener can be bound. Calling this function will replace the\nprevious listener.\n\n:param listener: The function to call that accepts the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SendableChooser" }, { "defaultValue": "", - "name": "title", + "name": "name", "type": "str" }, { "defaultValue": "", - "name": "defaultValue", - "type": "int" + "name": "object", + "type": "object" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, int64_t), the value in the widget will be\nsaved on the robot and will be used when the robot program next starts\nrather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std:string_view, int64_t)\n Add(std::string_view title, int64_t defaultValue)" - }, + "declaringClassName": "wpilib.SendableChooser", + "functionName": "setDefaultOption", + "returnType": "None", + "tooltip": "Add the given object to the list of options and marks it as the default.\n\nFunctionally, this is very close to AddOption() except that it will use\nthis as the default option if none other is explicitly selected.\n\n:param name: the name of the option\n:param object: the option" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.SendableChooserBase", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "name": "args", + "type": "tuple" }, { "defaultValue": "", - "name": "title", - "type": "str" + "name": "kwargs", + "type": "dict" + } + ], + "declaringClassName": "wpilib.SendableChooserBase", + "functionName": "__init__", + "returnType": "wpilib.SendableChooserBase", + "tooltip": "Initialize self. See help(type(self)) for accurate signature." + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "defaultValue", - "type": "str" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::string_view), the value in the widget\nwill be saved on the robot and will be used when the robot program next\nstarts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::string_view)\n Add(std::string_view title, std::string_view defaultValue)" - }, + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.SensorUtil", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "name": "args", + "type": "tuple" }, { "defaultValue": "", - "name": "title", - "type": "str" - }, + "name": "kwargs", + "type": "dict" + } + ], + "declaringClassName": "wpilib.SensorUtil", + "functionName": "__init__", + "returnType": "wpilib.SensorUtil", + "tooltip": "Initialize self. See help(type(self)) for accurate signature." + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [ { "defaultValue": "", - "name": "defaultValue", - "type": "List[bool]" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SensorUtil", + "functionName": "checkAnalogInputChannel", + "returnType": "bool", + "tooltip": "Check that the analog input number is value.\n\nVerify that the analog input number is one of the legal channel numbers.\nChannel numbers are 0-based.\n\n:returns: Analog channel is valid" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SensorUtil", + "functionName": "checkDigitalChannel", + "returnType": "bool", + "tooltip": "Check that the digital channel number is valid.\n\nVerify that the channel number is one of the legal channel numbers. Channel\nnumbers are 0-based.\n\n:returns: Digital channel is valid" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "defaultValue", - "type": "List[float]" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SensorUtil", + "functionName": "checkPWMChannel", + "returnType": "bool", + "tooltip": "Check that the PWM channel number is valid.\n\nVerify that the channel number is one of the legal channel numbers. Channel\nnumbers are 0-based.\n\n:returns: PWM channel is valid" + }, + { + "args": [], + "declaringClassName": "wpilib.SensorUtil", + "functionName": "getDefaultCTREPCMModule", + "returnType": "int", + "tooltip": "Get the number of the default solenoid module.\n\n:returns: The number of the default solenoid module." + }, + { + "args": [], + "declaringClassName": "wpilib.SensorUtil", + "functionName": "getDefaultREVPHModule", + "returnType": "int", + "tooltip": "Get the number of the default solenoid module.\n\n:returns: The number of the default solenoid module." + }, + { + "args": [], + "declaringClassName": "wpilib.SensorUtil", + "functionName": "getNumAnalogInputs", + "returnType": "int", + "tooltip": "" + }, + { + "args": [], + "declaringClassName": "wpilib.SensorUtil", + "functionName": "getNumDigitalChannels", + "returnType": "int", + "tooltip": "" }, + { + "args": [], + "declaringClassName": "wpilib.SensorUtil", + "functionName": "getNumPwmChannels", + "returnType": "int", + "tooltip": "" + } + ] + }, + { + "className": "wpilib.SerialPort", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "name": "baudRate", + "type": "typing.SupportsInt" }, { - "defaultValue": "", - "name": "title", - "type": "str" + "defaultValue": "", + "name": "port", + "type": "wpilib.SerialPort.Port" }, { - "defaultValue": "", - "name": "defaultValue", - "type": "List[int]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in the\nwidget will be saved on the robot and will be used when the robot program\nnext starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "defaultValue": "8", + "name": "dataBits", + "type": "typing.SupportsInt" }, { - "defaultValue": "", - "name": "title", - "type": "str" + "defaultValue": "", + "name": "parity", + "type": "wpilib.SerialPort.Parity" }, { - "defaultValue": "", - "name": "defaultValue", - "type": "List[str]" + "defaultValue": "", + "name": "stopBits", + "type": "wpilib.SerialPort.StopBits" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addPersistent", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Adds a widget to this container to display a simple piece of data.\n\nUnlike Add(std::string_view, std::span), the value in\nthe widget will be saved on the robot and will be used when the robot\nprogram next starts rather than ``defaultValue``.\n\n:param title: the title of the widget\n:param defaultValue: the default value of the widget\n\n:returns: a widget to display the sendable data\n @see Add(std::string_view, std::span)\n Add(std::string_view title, std::span defaultValue)" + "declaringClassName": "wpilib.SerialPort", + "functionName": "__init__", + "returnType": "wpilib.SerialPort", + "tooltip": "Create an instance of a Serial Port class.\n\n:param baudRate: The baud rate to configure the serial port.\n:param port: The physical port to use\n:param dataBits: The number of data bits per transfer. Valid values are\n between 5 and 8 bits.\n:param parity: Select the type of parity checking to use.\n:param stopBits: The number of stop bits to use as defined by the enum\n StopBits." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "name": "baudRate", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "title", + "name": "portName", "type": "str" }, { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addRaw", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "defaultValue": "", + "name": "port", + "type": "wpilib.SerialPort.Port" }, { - "defaultValue": "", - "name": "title", - "type": "str" + "defaultValue": "8", + "name": "dataBits", + "type": "typing.SupportsInt" }, { - "defaultValue": "", - "name": "typeString", - "type": "str" + "defaultValue": "", + "name": "parity", + "type": "wpilib.SerialPort.Parity" }, { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[int]]" + "defaultValue": "", + "name": "stopBits", + "type": "wpilib.SerialPort.StopBits" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addRaw", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param typeString: the NT type string\n:param supplier: the supplier for values\n\n:returns: a widget to display data" - }, + "declaringClassName": "wpilib.SerialPort", + "functionName": "__init__", + "returnType": "wpilib.SerialPort", + "tooltip": "Create an instance of a Serial Port class.\n\nPrefer to use the constructor that doesn't take a port name, but in some\ncases the automatic detection might not work correctly.\n\n:param baudRate: The baud rate to configure the serial port.\n:param port: The physical port to use\n:param portName: The direct port name to use\n:param dataBits: The number of data bits per transfer. Valid values are\n between 5 and 8 bits.\n:param parity: Select the type of parity checking to use.\n:param stopBits: The number of stop bits to use as defined by the enum\n StopBits." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], str]" + "type": "wpilib.SerialPort" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addString", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SerialPort", + "functionName": "disableTermination", + "returnType": "None", + "tooltip": "Disable termination behavior." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SerialPort" }, { - "defaultValue": "", - "name": "title", + "defaultValue": "'\\n'", + "name": "terminator", "type": "str" - }, - { - "defaultValue": "", - "name": "supplier", - "type": "Callable[[], list[str]]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "addStringArray", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Adds a widget to this container. The widget will display the data provided\nby the value supplier. Changes made on the dashboard will not propagate to\nthe widget object, and will be overridden by values from the value\nsupplier.\n\n:param title: the title of the widget\n:param supplier: the supplier for values\n\n:returns: a widget to display data" + "declaringClassName": "wpilib.SerialPort", + "functionName": "enableTermination", + "returnType": "None", + "tooltip": "Enable termination and specify the termination character.\n\nTermination is currently only implemented for receive.\nWhen the the terminator is received, the Read() or Scanf() will return\nfewer bytes than requested, stopping after the terminator.\n\n:param terminator: The character to use for termination." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardTab" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.SerialPort" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardTab", - "functionName": "buildInto", + "declaringClassName": "wpilib.SerialPort", + "functionName": "flush", "returnType": "None", - "tooltip": "" + "tooltip": "Force the output buffer to be written to the port.\n\nThis is used when SetWriteBufferMode() is set to kFlushWhenFull to force a\nflush before the buffer is full." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SerialPort" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.SerialPort", + "functionName": "getBytesReceived", + "returnType": "int", + "tooltip": "Get the number of bytes currently available to read from the serial port.\n\n:returns: The number of bytes available to read" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SerialPort" + }, + { + "defaultValue": "", + "name": "buffer", + "type": "Buffer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.SerialPort", + "functionName": "read", + "returnType": "int", + "tooltip": "Read raw bytes out of the buffer.\n\n:param buffer: Pointer to the buffer to store the bytes in.\n:param count: The maximum number of bytes to read.\n\n:returns: The number of bytes actually read into the buffer." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SerialPort" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getComponents", - "returnType": "list[wpilib.shuffleboard.ShuffleboardComponentBase]", - "tooltip": "Gets the components that are direct children of this container." + "declaringClassName": "wpilib.SerialPort", + "functionName": "reset", + "returnType": "None", + "tooltip": "Reset the serial port driver to a known state.\n\nEmpty the transmit and receive buffers in the device and formatted I/O." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.SerialPort" }, { "defaultValue": "", - "name": "type", - "type": "wpilib.shuffleboard.BuiltInLayouts" + "name": "flowControl", + "type": "wpilib.SerialPort.FlowControl" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the layout with the given type and title, creating it if it does not\nalready exist at the time this method is called.\n\n:param title: the title of the layout\n:param type: the type of the layout, eg \"List\" or \"Grid\"\n\n:returns: the layout" + "declaringClassName": "wpilib.SerialPort", + "functionName": "setFlowControl", + "returnType": "None", + "tooltip": "Set the type of flow control to enable on this port.\n\nBy default, flow control is disabled." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.SerialPort" }, { "defaultValue": "", - "name": "type", - "type": "wpilib.shuffleboard.LayoutType" + "name": "size", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the layout with the given type and title, creating it if it does not\nalready exist at the time this method is called.\n\n:param title: the title of the layout\n:param type: the type of the layout, eg \"List\" or \"Grid\"\n\n:returns: the layout" + "declaringClassName": "wpilib.SerialPort", + "functionName": "setReadBufferSize", + "returnType": "None", + "tooltip": "Specify the size of the input buffer.\n\nSpecify the amount of data that can be stored before data\nfrom the device is returned to Read or Scanf. If you want\ndata that is received to be returned immediately, set this to 1.\n\nIt the buffer is not filled before the read timeout expires, all\ndata that has been received so far will be returned.\n\n:param size: The read buffer size." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "type": "wpilib.SerialPort" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "timeout", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the layout with the given type and title, creating it if it does not\nalready exist at the time this method is called. Note: this method should\nonly be used to use a layout type that is not already built into\nShuffleboard. To use a layout built into Shuffleboard, use\nGetLayout(std::string_view, const LayoutType&) and the layouts in\nBuiltInLayouts.\n\n:param title: the title of the layout\n:param type: the type of the layout, eg \"List Layout\" or \"Grid Layout\"\n\n:returns: the layout\n @see GetLayout(std::string_view, const LayoutType&)" + "declaringClassName": "wpilib.SerialPort", + "functionName": "setTimeout", + "returnType": "None", + "tooltip": "Configure the timeout of the serial port.\n\nThis defines the timeout for transactions with the hardware.\nIt will affect reads and very large writes.\n\n:param timeout: The time to wait for I/O." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardContainer" + "type": "wpilib.SerialPort" }, { "defaultValue": "", - "name": "title", - "type": "str" + "name": "mode", + "type": "wpilib.SerialPort.WriteBufferMode" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer", - "functionName": "getLayout", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Gets the already-defined layout in this container with the given title.\n\n
{@code\nShuffleboard::GetTab(\"Example Tab\")->getLayout(\"My Layout\",\n&BuiltInLayouts.kList);\n\n// Later...\nShuffleboard::GetTab(\"Example Tab\")->GetLayout(\"My Layout\");\n}
\n\n:param title: the title of the layout to get\n\n:returns: the layout with the given title\n @throws if no layout has yet been defined with the given title" + "declaringClassName": "wpilib.SerialPort", + "functionName": "setWriteBufferMode", + "returnType": "None", + "tooltip": "Specify the flushing behavior of the output buffer.\n\nWhen set to kFlushOnAccess, data is synchronously written to the serial\nport after each call to either Printf() or Write().\n\nWhen set to kFlushWhenFull, data will only be written to the serial port\nwhen the buffer is full or when Flush() is called.\n\n:param mode: The write buffer mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardTab" + "type": "wpilib.SerialPort" + }, + { + "defaultValue": "", + "name": "size", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardTab", - "functionName": "getRoot", - "returnType": "wpilib.shuffleboard._ShuffleboardRoot", - "tooltip": "" + "declaringClassName": "wpilib.SerialPort", + "functionName": "setWriteBufferSize", + "returnType": "None", + "tooltip": "Specify the size of the output buffer.\n\nSpecify the amount of data that can be stored before being\ntransmitted to the device.\n\n:param size: The write buffer size." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.SerialPort" + }, + { + "defaultValue": "", + "name": "buffer", + "type": "Buffer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.SerialPort", + "functionName": "write", + "returnType": "int", + "tooltip": "Write raw bytes to the buffer.\n\n:param buffer: Pointer to the buffer to read the bytes from.\n:param count: The maximum number of bytes to write.\n\n:returns: The number of bytes actually written into the port." } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", + "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.shuffleboard.ShuffleboardValue", - "classVariables": [], + "className": "wpilib.SerialPort.FlowControl", + "classVariables": [ + { + "name": "kFlowControl_DtrDsr", + "tooltip": "", + "type": "wpilib.SerialPort.FlowControl", + "writable": false + }, + { + "name": "kFlowControl_None", + "tooltip": "", + "type": "wpilib.SerialPort.FlowControl", + "writable": false + }, + { + "name": "kFlowControl_RtsCts", + "tooltip": "", + "type": "wpilib.SerialPort.FlowControl", + "writable": false + }, + { + "name": "kFlowControl_XonXoff", + "tooltip": "", + "type": "wpilib.SerialPort.FlowControl", + "writable": false + } + ], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", + "declaringClassName": "wpilib.SerialPort.FlowControl", "functionName": "__init__", - "returnType": "wpilib.shuffleboard.ShuffleboardValue", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.SerialPort.FlowControl", + "tooltip": "" } ], "enums": [], - "instanceMethods": [ + "instanceMethods": [], + "instanceVariables": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.SerialPort.Parity", + "classVariables": [ + { + "name": "kParity_Even", + "tooltip": "", + "type": "wpilib.SerialPort.Parity", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "name": "kParity_Mark", + "tooltip": "", + "type": "wpilib.SerialPort.Parity", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "name": "kParity_None", + "tooltip": "", + "type": "wpilib.SerialPort.Parity", + "writable": false + }, + { + "name": "kParity_Odd", + "tooltip": "", + "type": "wpilib.SerialPort.Parity", + "writable": false + }, + { + "name": "kParity_Space", + "tooltip": "", + "type": "wpilib.SerialPort.Parity", + "writable": false } ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.SimpleWidget", - "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "parent", - "type": "wpilib.shuffleboard.ShuffleboardContainer" - }, - { - "defaultValue": "", - "name": "title", - "type": "str" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.SimpleWidget", + "declaringClassName": "wpilib.SerialPort.Parity", "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SimpleWidget", + "returnType": "wpilib.SerialPort.Parity", "tooltip": "" } ], "enums": [], - "instanceMethods": [ + "instanceMethods": [], + "instanceVariables": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.SimpleWidget" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" - } - ], - "declaringClassName": "wpilib.shuffleboard.SimpleWidget", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "" + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.SerialPort.Port", + "classVariables": [ + { + "name": "kMXP", + "tooltip": "", + "type": "wpilib.SerialPort.Port", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "name": "kOnboard", + "tooltip": "", + "type": "wpilib.SerialPort.Port", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "name": "kUSB", + "tooltip": "", + "type": "wpilib.SerialPort.Port", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.SimpleWidget" - } - ], - "declaringClassName": "wpilib.shuffleboard.SimpleWidget", - "functionName": "getEntry", - "returnType": "ntcore.GenericEntry", - "tooltip": "Gets the NetworkTable entry that contains the data for this widget.\nThe widget owns the entry; the returned pointer's lifetime is the same as\nthat of the widget." + "name": "kUSB1", + "tooltip": "", + "type": "wpilib.SerialPort.Port", + "writable": false }, + { + "name": "kUSB2", + "tooltip": "", + "type": "wpilib.SerialPort.Port", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.SimpleWidget" - }, - { - "defaultValue": "", - "name": "typeString", - "type": "str" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.SimpleWidget", - "functionName": "getEntry", - "returnType": "ntcore.GenericEntry", - "tooltip": "Gets the NetworkTable entry that contains the data for this widget.\nThe widget owns the entry; the returned pointer's lifetime is the same as\nthat of the widget.\n\n:param typeString: NT type string" + "declaringClassName": "wpilib.SerialPort.Port", + "functionName": "__init__", + "returnType": "wpilib.SerialPort.Port", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.SerialPort.StopBits", + "classVariables": [ + { + "name": "kStopBits_One", + "tooltip": "", + "type": "wpilib.SerialPort.StopBits", + "writable": false }, + { + "name": "kStopBits_OnePointFive", + "tooltip": "", + "type": "wpilib.SerialPort.StopBits", + "writable": false + }, + { + "name": "kStopBits_Two", + "tooltip": "", + "type": "wpilib.SerialPort.StopBits", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", + "declaringClassName": "wpilib.SerialPort.StopBits", + "functionName": "__init__", + "returnType": "wpilib.SerialPort.StopBits", "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.SerialPort.WriteBufferMode", + "classVariables": [ + { + "name": "kFlushOnAccess", + "tooltip": "", + "type": "wpilib.SerialPort.WriteBufferMode", + "writable": false }, + { + "name": "kFlushWhenFull", + "tooltip": "", + "type": "wpilib.SerialPort.WriteBufferMode", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", + "declaringClassName": "wpilib.SerialPort.WriteBufferMode", + "functionName": "__init__", + "returnType": "wpilib.SerialPort.WriteBufferMode", "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.Servo", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" - }, + "declaringClassName": "wpilib.Servo", + "functionName": "__init__", + "returnType": "wpilib.Servo", + "tooltip": "Constructor.\n\nBy default, 2.4 ms is used as the max PWM value and 0.6 ms is used as the\nmin PWM value.\n\n:param channel: The PWM channel to which the servo is attached. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleComponent" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.Servo" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleComponent", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.Servo", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the servo position.\n\nServo values range from 0.0 to 1.0 corresponding to the range of full left\nto full right. This returns the commanded position, not the position that\nthe servo is actually at, as the servo does not report its own position.\n\n:returns: Position from 0.0 to 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleComponent" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.Servo" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleComponent", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.Servo", + "functionName": "getAngle", + "returnType": "float", + "tooltip": "Get the servo angle.\n\nThis returns the commanded angle, not the angle that the servo is actually\nat, as the servo does not report its own angle.\n\n:returns: The angle in degrees to which the servo is set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleComponent" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.Servo" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleComponent", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.Servo", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleWidget" + "type": "wpilib.Servo" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.Servo", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleWidget" + "type": "wpilib.Servo" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.Servo", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the servo position.\n\nServo values range from 0.0 to 1.0 corresponding to the range of full left\nto full right.\n\n:param value: Position from 0.0 to 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleWidget" + "type": "wpilib.Servo" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "angle", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.Servo", + "functionName": "setAngle", + "returnType": "None", + "tooltip": "Set the servo angle.\n\nThe angles are based on the HS-322HD Servo, and have a range of 0 to 180\ndegrees.\n\nServo angles that are out of the supported range of the servo simply\n\"saturate\" in that direction. In other words, if the servo has a range of\n(X degrees to Y degrees) than angles of less than X result in an angle of\nX being set and angles of more than Y degrees result in an angle of Y being\nset.\n\n:param angle: The angle in degrees to set the servo." } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", + "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.shuffleboard.SuppliedBoolListValueWidget", + "className": "wpilib.SharpIR", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "channel", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.SuppliedBoolListValueWidget" + "name": "a", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "name": "b", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" - } - ], - "declaringClassName": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "min", + "type": "wpimath.units.meters" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "max", + "type": "wpimath.units.meters" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" - }, + "declaringClassName": "wpilib.SharpIR", + "functionName": "__init__", + "returnType": "wpilib.SharpIR", + "tooltip": "Manually construct a SharpIR object. The distance is computed using this\nformula: A*v ^ B. Prefer to use one of the static factories to create this\ndevice instead.\n\n:param channel: Analog input channel the sensor is connected to\n:param a: Constant A\n:param b: Constant B\n:param min: Minimum distance to report\n:param max: Maximum distance to report" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.SharpIR" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.SharpIR", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "Get the analog input channel number.\n\n:returns: analog input channel" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.SharpIR" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.SharpIR", + "functionName": "getRange", + "returnType": "wpimath.units.meters", + "tooltip": "Get the range from the distance sensor.\n\n:returns: range of the target returned by the sensor" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.SharpIR" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.SharpIR", + "functionName": "initSendable", "returnType": "None", "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" - }, + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.SharpIR", + "functionName": "GP2Y0A02YK0F", + "returnType": "wpilib.SharpIR", + "tooltip": "Sharp GP2Y0A02YK0F is an analog IR sensor capable of measuring\ndistances from 20cm to 150cm.\n\n:param channel: Analog input channel the sensor is connected to\n\n:returns: sensor object" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.SharpIR", + "functionName": "GP2Y0A21YK0F", + "returnType": "wpilib.SharpIR", + "tooltip": "Sharp GP2Y0A21YK0F is an analog IR sensor capable of measuring\ndistances from 10cm to 80cm.\n\n:param channel: Analog input channel the sensor is connected to\n\n:returns: sensor object" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.SharpIR", + "functionName": "GP2Y0A41SK0F", + "returnType": "wpilib.SharpIR", + "tooltip": "Sharp GP2Y0A41SK0F is an analog IR sensor capable of measuring\ndistances from 4cm to 30cm.\n\n:param channel: Analog input channel the sensor is connected to\n\n:returns: sensor object" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.SharpIR", + "functionName": "GP2Y0A51SK0F", + "returnType": "wpilib.SharpIR", + "tooltip": "Sharp GP2Y0A51SK0F is an analog IR sensor capable of measuring\ndistances from 2cm to 15cm.\n\n:param channel: Analog input channel the sensor is connected to\n\n:returns: sensor object" } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] + ] }, { - "className": "wpilib.shuffleboard.SuppliedBoolValueWidget", + "className": "wpilib.SmartDashboard", "classVariables": [], "constructors": [ { @@ -40990,826 +22872,793 @@ "type": "dict" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedBoolValueWidget", + "declaringClassName": "wpilib.SmartDashboard", "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", + "returnType": "wpilib.SmartDashboard", "tooltip": "Initialize self. See help(type(self)) for accurate signature." } ], "enums": [], - "instanceMethods": [ + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.SuppliedBoolValueWidget" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "key", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "functionName": "buildInto", + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "clearPersistent", "returnType": "None", - "tooltip": "" + "tooltip": "Stop making a key's value persistent through program restarts.\nThe key cannot be null.\n\n:param key: the key name" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "key", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "containsKey", + "returnType": "bool", + "tooltip": "Determines whether the given key is in this table.\n\n:param key: the key to search for\n\n:returns: true if the table as a value assigned to the given key" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "keyName", + "type": "str" + }, + { + "defaultValue": "", + "name": "defaultValue", + "type": "object" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getBoolean", + "returnType": "object", + "tooltip": "Returns the value at the specified key.\n\nIf the key is not found, returns the default value.\n\n:param keyName: the key\n:param defaultValue: the default value to return if key doesn't exist\n\n:returns: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "key", + "type": "str" + }, + { + "defaultValue": "", + "name": "defaultValue", + "type": "object" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getBooleanArray", + "returnType": "object", + "tooltip": "Returns the boolean array the key maps to.\n\nIf the key does not exist or is of different type, it will return the\ndefault value.\n\n:param key: The key to look up.\n:param defaultValue: The value to be returned if no value is found.\n\n:returns: the value associated with the given key or the given default value\n if there is no value associated with the key\n \n .. note:: This makes a copy of the array. If the overhead of this is a concern,\n use GetValue() instead.\n \n .. note:: The returned array is std::vector instead of std::vector\n because std::vector is special-cased in C++. 0 is false, any\n non-zero value is true." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "keyName", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getData", + "returnType": "wpiutil.Sendable", + "tooltip": "Returns the value at the specified key.\n\n:param keyName: the key\n\n:returns: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "key", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getEntry", + "returnType": "ntcore.NetworkTableEntry", + "tooltip": "Returns an NT Entry mapping to the specified key\n\nThis is useful if an entry is used often, or is read and then modified.\n\n:param key: the key\n\n:returns: the entry for the key" }, { "args": [ { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "defaultValue": "0", + "name": "types", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getKeys", + "returnType": "list[str]", + "tooltip": ":param types: bitmask of types; 0 is treated as a \"don't care\".\n\n:returns: keys currently in the table" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "keyName", + "type": "str" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "defaultValue", + "type": "object" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getNumber", + "returnType": "object", + "tooltip": "Returns the value at the specified key.\n\nIf the key is not found, returns the default value.\n\n:param keyName: the key\n:param defaultValue: the default value to return if the key doesn't exist\n\n:returns: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_bool" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "defaultValue", + "type": "object" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getNumberArray", + "returnType": "object", + "tooltip": "Returns the number array the key maps to.\n\nIf the key does not exist or is of different type, it will return the\ndefault value.\n\n:param key: The key to look up.\n:param defaultValue: The value to be returned if no value is found.\n\n:returns: the value associated with the given key or the given default value\n if there is no value associated with the key\n \n .. note:: This makes a copy of the array. If the overhead of this is a concern,\n use GetValue() instead." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_bool" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "defaultValue", + "type": "object" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getRaw", + "returnType": "object", + "tooltip": "Returns the raw value (byte array) the key maps to.\n\nIf the key does not exist or is of different type, it will return the\ndefault value.\n\n:param key: The key to look up.\n:param defaultValue: The value to be returned if no value is found.\n\n:returns: the value associated with the given key or the given default value\n if there is no value associated with the key\n \n .. note:: This makes a copy of the raw contents. If the overhead of this is a\n concern, use GetValue() instead." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_bool" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" + "name": "keyName", + "type": "str" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "defaultValue", + "type": "object" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getString", + "returnType": "object", + "tooltip": "Returns the value at the specified key.\n\nIf the key is not found, returns the default value.\n\n:param keyName: the key\n:param defaultValue: the default value to return if the key doesn't exist\n\n:returns: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_bool" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "defaultValue", + "type": "object" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getStringArray", + "returnType": "object", + "tooltip": "Returns the string array the key maps to.\n\nIf the key does not exist or is of different type, it will return the\ndefault value.\n\n:param key: The key to look up.\n:param defaultValue: The value to be returned if no value is found.\n\n:returns: the value associated with the given key or the given default value\n if there is no value associated with the key\n \n .. note:: This makes a copy of the array. If the overhead of this is a concern,\n use GetValue() instead." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_bool" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "keyName", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "getValue", + "returnType": "ntcore.Value", + "tooltip": "Retrieves the complex value (such as an array) in this table into the\ncomplex data object.\n\n:param keyName: the key" + }, + { + "args": [], + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "init", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_bool" - }, - { - "defaultValue": "", - "name": "widgetType", + "name": "key", "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "isPersistent", + "returnType": "bool", + "tooltip": "Returns whether the value is persistent through program restarts.\nThe key cannot be null.\n\n:param key: the key name" + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "task", + "type": "Callable[[], None]" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "postListenerTask", + "returnType": "None", + "tooltip": "Posts a task from a listener to the ListenerExecutor, so that it can be run\nsynchronously from the main loop on the next call to updateValues().\n\n:param task: The task to run synchronously from the main thread." + }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.SuppliedDoubleListValueWidget" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "name": "keyName", + "type": "str" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "putBoolean", + "returnType": "bool", + "tooltip": "Maps the specified key to the specified value in this table.\n\nThe value can be retrieved by calling the get method with a key that is\nequal to the original key.\n\n:param keyName: the key\n:param value: the value\n\n:returns: False if the table key already exists with a different type" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "value", + "type": "List[typing.SupportsInt]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "putBooleanArray", + "returnType": "bool", + "tooltip": "Put a boolean array in the table.\n\n:param key: the key to be assigned to\n:param value: the value that will be assigned\n\n:returns: False if the table key already exists with a different type\n \n .. note:: The array must be of int's rather than of bool's because\n std::vector is special-cased in C++. 0 is false, any\n non-zero value is true." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "key", + "type": "str" + }, + { + "defaultValue": "", + "name": "data", + "type": "wpiutil.Sendable" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "putData", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Maps the specified key to the specified value in this table.\n\nThe value can be retrieved by calling the get method with a key that is\nequal to the original key.\n\nIn order for the value to appear in the dashboard, it must be registered\nwith SendableRegistry. WPILib components do this automatically.\n\n:param key: the key\n:param data: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "value", + "type": "wpiutil.Sendable" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "putData", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Maps the specified key (where the key is the name of the Sendable)\nto the specified value in this table.\n\nThe value can be retrieved by calling the get method with a key that is\nequal to the original key.\n\nIn order for the value to appear in the dashboard, it must be registered\nwith SendableRegistry. WPILib components do this automatically.\n\n:param value: the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "keyName", + "type": "str" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "putNumber", + "returnType": "bool", + "tooltip": "Maps the specified key to the specified value in this table.\n\nThe value can be retrieved by calling the get method with a key that is\nequal to the original key.\n\n:param keyName: the key\n:param value: the value\n\n:returns: False if the table key already exists with a different type" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "key", + "type": "str" + }, + { + "defaultValue": "", + "name": "value", + "type": "List[typing.SupportsFloat]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "putNumberArray", + "returnType": "bool", + "tooltip": "Put a number array in the table.\n\n:param key: The key to be assigned to.\n:param value: The value that will be assigned.\n\n:returns: False if the table key already exists with a different type" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "key", + "type": "str" + }, + { + "defaultValue": "", + "name": "value", + "type": "Buffer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "putRaw", + "returnType": "bool", + "tooltip": "Put a raw value (byte array) in the table.\n\n:param key: The key to be assigned to.\n:param value: The value that will be assigned.\n\n:returns: False if the table key already exists with a different type" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "keyName", + "type": "str" }, { "defaultValue": "", - "name": "type", + "name": "value", "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "putString", + "returnType": "bool", + "tooltip": "Maps the specified key to the specified value in this table.\n\nThe value can be retrieved by calling the get method with a key that is\nequal to the original key.\n\n:param keyName: the key\n:param value: the value\n\n:returns: False if the table key already exists with a different type" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "value", + "type": "List[str]" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "putStringArray", + "returnType": "bool", + "tooltip": "Put a string array in the table.\n\n:param key: The key to be assigned to.\n:param value: The value that will be assigned.\n\n:returns: False if the table key already exists with a different type" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double" + "name": "keyName", + "type": "str" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "value", + "type": "ntcore.Value" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "putValue", + "returnType": "bool", + "tooltip": "Maps the specified key to the specified complex value (such as an array) in\nthis table.\n\nThe value can be retrieved by calling the RetrieveValue method with a key\nthat is equal to the original key.\n\n:param keyName: the key\n:param value: the value\n\n:returns: False if the table key already exists with a different type" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "defaultValue", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "setDefaultBoolean", + "returnType": "bool", + "tooltip": "Set the value in the table if key does not exist\n\n:param key: the key\n:param defaultValue: the value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "defaultValue", + "type": "List[typing.SupportsInt]" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "setDefaultBooleanArray", + "returnType": "bool", + "tooltip": "Set the value in the table if key does not exist.\n\n:param key: the key\n:param defaultValue: the value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "defaultValue", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "setDefaultNumber", + "returnType": "bool", + "tooltip": "Set the value in the table if key does not exist.\n\n:param key: The key.\n:param defaultValue: The value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "defaultValue", + "type": "List[typing.SupportsFloat]" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "setDefaultNumberArray", + "returnType": "bool", + "tooltip": "Set the value in the table if key does not exist.\n\n:param key: The key.\n:param defaultValue: The value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "defaultValue", + "type": "Buffer" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "setDefaultRaw", + "returnType": "bool", + "tooltip": "Set the value in the table if key does not exist.\n\n:param key: The key.\n:param defaultValue: The value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" + }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.SuppliedDoubleValueWidget" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "defaultValue", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "setDefaultString", + "returnType": "bool", + "tooltip": "Set the value in the table if key does not exist.\n\n:param key: the key\n:param defaultValue: the value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "key", + "type": "str" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "defaultValue", + "type": "List[str]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "setDefaultStringArray", + "returnType": "bool", + "tooltip": "Set the value in the table if key does not exist.\n\n:param key: The key.\n:param defaultValue: The value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "key", + "type": "str" + }, + { + "defaultValue": "", + "name": "defaultValue", + "type": "ntcore.Value" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "setDefaultValue", + "returnType": "bool", + "tooltip": "Set the value in the table if key does not exist.\n\n:param key: the key\n:param defaultValue: The value to set if key doesn't exist.\n\n:returns: True if the table key did not already exist, otherwise False" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "key", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "setPersistent", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Makes a key's value persistent through program restarts.\n\n:param key: the key to make persistent" }, + { + "args": [], + "declaringClassName": "wpilib.SmartDashboard", + "functionName": "updateValues", + "returnType": "None", + "tooltip": "Puts all sendable data to the dashboard." + } + ] + }, + { + "className": "wpilib.Solenoid", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "busId", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "module", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "moduleType", + "type": "wpilib.PneumaticsModuleType" + }, + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.Solenoid", + "functionName": "__init__", + "returnType": "wpilib.Solenoid", + "tooltip": "Constructs a solenoid for a specified module and type.\n\n:param busId: The bus ID.\n:param module: The module ID to use.\n:param moduleType: The module type to use.\n:param channel: The channel the solenoid is on." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "busId", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "moduleType", + "type": "wpilib.PneumaticsModuleType" + }, + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." - }, + "declaringClassName": "wpilib.Solenoid", + "functionName": "__init__", + "returnType": "wpilib.Solenoid", + "tooltip": "Constructs a solenoid for a default module and specified type.\n\n:param busId: The bus ID.\n:param moduleType: The module type to use.\n:param channel: The channel the solenoid is on." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.Solenoid" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.Solenoid", + "functionName": "get", + "returnType": "bool", + "tooltip": "Read the current value of the solenoid.\n\n:returns: The current value of the solenoid." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.Solenoid" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Solenoid", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "Get the channel this solenoid is connected to." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_double" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" + "type": "wpilib.Solenoid" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_double", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.Solenoid", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_double" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.Solenoid" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_double", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.Solenoid", + "functionName": "isDisabled", + "returnType": "bool", + "tooltip": "Check if solenoid is Disabled.\n\nIf a solenoid is shorted, it is added to the DisabledList and\ndisabled until power cycle, or until faults are cleared.\n\n@see ClearAllPCMStickyFaults()\n\n:returns: If solenoid is disabled due to short." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_double" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" + "type": "wpilib.Solenoid" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "on", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_double", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.Solenoid", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the value of a solenoid.\n\n:param on: Turn the solenoid output off or on." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_double" + "type": "wpilib.Solenoid" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "duration", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.Solenoid", + "functionName": "setPulseDuration", + "returnType": "None", + "tooltip": "Set the pulse duration in the pneumatics module. This is used in\nconjunction with the startPulse method to allow the pneumatics module to\ncontrol the timing of a pulse.\n\nOn the PCM, the timing can be controlled in 0.01 second increments, with a\nmaximum of 2.55 seconds. On the PH, the timing can be controlled in 0.001\nsecond increments, with a maximum of 65.534 seconds.\n\n@see startPulse()\n\n:param duration: The duration of the pulse." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_double" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "type": "wpilib.Solenoid" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.Solenoid", + "functionName": "startPulse", + "returnType": "None", + "tooltip": "%Trigger the pneumatics module to generate a pulse of the duration set in\nsetPulseDuration.\n\n@see setPulseDuration()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_double" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.Solenoid" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.Solenoid", + "functionName": "toggle", + "returnType": "None", + "tooltip": "Toggle the value of the solenoid.\n\nIf the solenoid is set to on, it'll be turned off. If the solenoid is set\nto off, it'll be turned on." } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", + "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.shuffleboard.SuppliedFloatListValueWidget", + "className": "wpilib.Spark", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedFloatListValueWidget", + "declaringClassName": "wpilib.Spark", "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.Spark", + "tooltip": "Constructor for a SPARK connected via PWM.\n\n:param channel: The PWM channel that the SPARK is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" } ], "enums": [], @@ -41819,21 +23668,42 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.SuppliedFloatListValueWidget" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, + "name": "follower", + "type": "wpilib.PWMMotorController" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." + }, + { + "args": [ { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "self", + "type": "wpilib.MotorSafety" + } + ], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "functionName": "buildInto", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", "returnType": "None", "tooltip": "" }, @@ -41842,56 +23712,56 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", "returnType": "None", - "tooltip": "" + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", "tooltip": "" }, { @@ -41899,189 +23769,229 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, + "type": "wpilib.PWMMotorController" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", + "tooltip": "" + }, + { + "args": [ { "defaultValue": "", - "name": "type", - "type": "str" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float" + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, + "name": "builder", + "type": "wpiutil.SendableBuilder" + } + ], + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.MotorSafety" + } + ], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." + }, + { + "args": [ { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "self", + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "width", - "type": "int" + "name": "expirationTime", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", + "returnType": "None", + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "" } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.Spark", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] }, { - "className": "wpilib.shuffleboard.SuppliedFloatValueWidget", + "className": "wpilib.SparkMini", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedFloatValueWidget", + "declaringClassName": "wpilib.SparkMini", "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.SparkMini", + "tooltip": "Constructor for a SPARKMini connected via PWM.\n\n:param channel: The PWM channel that the SPARKMini is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" } ], "enums": [], @@ -42091,105 +24001,100 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.SuppliedFloatValueWidget" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "functionName": "buildInto", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", "returnType": "None", - "tooltip": "" + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", "returnType": "None", - "tooltip": "" + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", "tooltip": "" }, { @@ -42197,17 +24102,12 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", "tooltip": "" }, { @@ -42215,187 +24115,135 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_float" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_float", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_float" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_float", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_float" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_float", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_float" + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_float" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_float" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "self", + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.SuppliedIntListValueWidget" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "functionName": "buildInto", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", "returnType": "None", - "tooltip": "" + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", "returnType": "None", "tooltip": "" }, @@ -42404,2043 +24252,1800 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, - { - "args": [ + "type": "wpilib.MotorSafety" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" - }, - { - "args": [ + "type": "wpilib.PWMMotorController" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", + "returnType": "None", "tooltip": "" - }, + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.SparkMini", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] + }, + { + "className": "wpilib.StadiaController", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "name": "port", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" - }, + "declaringClassName": "wpilib.StadiaController", + "functionName": "__init__", + "returnType": "wpilib.StadiaController", + "tooltip": "Construct an instance of a controller.\n\nThe controller index is the USB port on the Driver Station.\n\n:param port: The port on the Driver Station that the controller is plugged\n into (0-5)." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "A", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the A button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the A button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "B", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the B button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the B button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "width", - "type": "int" + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POV", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_int", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" - }, - { - "args": [ + "name": "pov", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int" + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_int", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POV", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_int", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVCenter", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the center (not pressed) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the center of a POV on the\n HID." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "self", + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDown", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down direction of a POV\n on the HID." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.SuppliedIntegerValueWidget" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDownLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down left direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDownRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, - { - "args": [ + "type": "wpilib.interfaces.GenericHID" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the left direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" - }, - { - "args": [ + "type": "wpilib.interfaces.GenericHID" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the right direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUp", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up direction of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up direction of a POV on\n the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUpLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up left direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_integer" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_integer", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUpRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_integer" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_integer", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "X", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the X button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the X button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_integer" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_integer", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "Y", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the Y button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the Y button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_integer" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_integer", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" - }, - { - "args": [ + "name": "axis", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_integer" + "name": "threshold", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_integer", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "axisGreaterThan", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance that is true when the axis value is greater\nthan threshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value above which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is greater than\n the provided threshold." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_integer" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_integer", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.SuppliedRawValueWidget", - "classVariables": [], - "constructors": [ - { - "args": [ + "name": "axis", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "threshold", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedRawValueWidget", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "axisLessThan", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance that is true when the axis value is less than\nthreshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value below which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is less than the\n provided threshold." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.SuppliedRawValueWidget" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "name": "button", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedRawValueWidget", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "button", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around this button's digital signal.\n\n:param button: the button index\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the button's digital signal attached\n to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "ellipses", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the ellipses button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the ellipses button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "frame", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the frame button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the frame button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getAButton", + "returnType": "bool", + "tooltip": "Read the value of the A button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getAButtonPressed", + "returnType": "bool", + "tooltip": "Whether the A button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getAButtonReleased", + "returnType": "bool", + "tooltip": "Whether the A button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getAxisCount", + "returnType": "int", + "tooltip": "Get the number of axes for the HID.\n\n:returns: the number of axis for the current HID" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getAxisType", + "returnType": "int", + "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getBButton", + "returnType": "bool", + "tooltip": "Read the value of the B button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getBButtonPressed", + "returnType": "bool", + "tooltip": "Whether the B button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getBButtonReleased", + "returnType": "bool", + "tooltip": "Whether the B button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getButtonCount", + "returnType": "int", + "tooltip": "Get the number of buttons for the HID.\n\n:returns: the number of buttons on the current HID" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getEllipsesButton", + "returnType": "bool", + "tooltip": "Read the value of the ellipses button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.StadiaController", + "functionName": "getEllipsesButtonPressed", + "returnType": "bool", + "tooltip": "Whether the ellipses button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.StadiaController", + "functionName": "getEllipsesButtonReleased", + "returnType": "bool", + "tooltip": "Whether the ellipses button was released since the last check.\n\n:returns: Whether the button was released since the last check." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.SuppliedStringListValueWidget" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getFrameButton", + "returnType": "bool", + "tooltip": "Read the value of the frame button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getFrameButtonPressed", + "returnType": "bool", + "tooltip": "Whether the frame button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getFrameButtonReleased", + "returnType": "bool", + "tooltip": "Whether the frame button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getGoogleButton", + "returnType": "bool", + "tooltip": "Read the value of the google button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getGoogleButtonPressed", + "returnType": "bool", + "tooltip": "Whether the google button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getGoogleButtonReleased", + "returnType": "bool", + "tooltip": "Whether the google button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getHamburgerButton", + "returnType": "bool", + "tooltip": "Read the value of the hamburger button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getHamburgerButtonPressed", + "returnType": "bool", + "tooltip": "Whether the hamburger button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getHamburgerButtonReleased", + "returnType": "bool", + "tooltip": "Whether the hamburger button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftBumper", + "returnType": "bool", + "tooltip": "Read the value of the left bumper (LB) button on the controller.\n\n:deprecated: Use GetLeftBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: the state of the button" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftBumperButton", + "returnType": "bool", + "tooltip": "Read the value of the left bumper button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftBumperButtonPressed", + "returnType": "bool", + "tooltip": "Whether the left bumper button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftBumperButtonReleased", + "returnType": "bool", + "tooltip": "Whether the left bumper button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.SuppliedStringValueWidget", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftBumperPressed", + "returnType": "bool", + "tooltip": "Whether the left bumper (LB) was pressed since the last check.\n\n:deprecated: Use GetLeftBumperButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was pressed since the last check" + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedStringValueWidget", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftBumperReleased", + "returnType": "bool", + "tooltip": "Whether the left bumper (LB) was released since the last check.\n\n:deprecated: Use GetLeftBumperButtonReleased instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was released since the last check." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.SuppliedStringValueWidget" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.SuppliedStringValueWidget", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftStickButton", + "returnType": "bool", + "tooltip": "Read the value of the left stick button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftStickButtonPressed", + "returnType": "bool", + "tooltip": "Whether the left stick button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftStickButtonReleased", + "returnType": "bool", + "tooltip": "Whether the left stick button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftTriggerButton", + "returnType": "bool", + "tooltip": "Read the value of the left trigger button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftTriggerButtonPressed", + "returnType": "bool", + "tooltip": "Whether the left trigger button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftTriggerButtonReleased", + "returnType": "bool", + "tooltip": "Whether the left trigger button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftX", + "returnType": "float", + "tooltip": "Get the X axis value of left side of the controller. Right is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getLeftY", + "returnType": "float", + "tooltip": "Get the Y axis value of left side of the controller. Back is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_string" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_string", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getName", + "returnType": "str", + "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_string" + "type": "wpilib.interfaces.GenericHID" }, { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "defaultValue": "0", + "name": "pov", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_string", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPOV", + "returnType": "wpilib.DriverStation.POVDirection", + "tooltip": "Get the angle of a POV on the HID.\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_string" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_string", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPOVCount", + "returnType": "int", + "tooltip": "Get the number of POVs for the HID.\n\n:returns: the number of POVs for the current HID" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_string" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPort", + "returnType": "int", + "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_string" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawAxis", + "returnType": "float", + "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_string" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard.WidgetType", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButton", + "returnType": "bool", + "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." + }, { "args": [ { "defaultValue": "", - "name": "widgetName", - "type": "str" - } - ], - "declaringClassName": "wpilib.shuffleboard.WidgetType", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard.WidgetType", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ + "name": "self", + "type": "wpilib.interfaces.GenericHID" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.WidgetType" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.WidgetType", - "functionName": "getWidgetName", - "returnType": "str", - "tooltip": "Gets the string type of the widget as defined by that widget in\nShuffleboard." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._ComplexComponent", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonPressed", + "returnType": "bool", + "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "self", + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexComponent", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._ComplexComponent", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonReleased", + "returnType": "bool", + "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, + "type": "wpilib.StadiaController" + } + ], + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightBumper", + "returnType": "bool", + "tooltip": "Read the value of the right bumper (RB) button on the controller.\n\n:deprecated: Use GetRightBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: the state of the button" + }, + { + "args": [ { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "self", + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightBumperButton", + "returnType": "bool", + "tooltip": "Read the value of the right bumper button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightBumperButtonPressed", + "returnType": "bool", + "tooltip": "Whether the right bumper button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightBumperButtonReleased", + "returnType": "bool", + "tooltip": "Whether the right bumper button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightBumperPressed", + "returnType": "bool", + "tooltip": "Whether the right bumper (RB) was pressed since the last check.\n\n:deprecated: Use GetRightBumperButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was pressed since the last check" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightBumperReleased", + "returnType": "bool", + "tooltip": "Whether the right bumper (RB) was released since the last check.\n\n:deprecated: Use GetRightBumperButtonReleased instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightStickButton", + "returnType": "bool", + "tooltip": "Read the value of the right stick button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightStickButtonPressed", + "returnType": "bool", + "tooltip": "Whether the right stick button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightStickButtonReleased", + "returnType": "bool", + "tooltip": "Whether the right stick button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexComponent" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexComponent", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightTriggerButton", + "returnType": "bool", + "tooltip": "Read the value of the right trigger button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexComponent" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexComponent", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightTriggerButtonPressed", + "returnType": "bool", + "tooltip": "Whether the right trigger button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexComponent" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexComponent", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._ComplexWidget", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightTriggerButtonReleased", + "returnType": "bool", + "tooltip": "Whether the right trigger button was released since the last check.\n\n:returns: Whether the button was released since the last check." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexWidget", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._ComplexWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightX", + "returnType": "float", + "tooltip": "Get the X axis value of right side of the controller. Right is positive.\n\n:returns: the axis value." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getRightY", + "returnType": "float", + "tooltip": "Get the Y axis value of right side of the controller. Back is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getStadiaButton", + "returnType": "bool", + "tooltip": "Read the value of the stadia button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getStadiaButtonPressed", + "returnType": "bool", + "tooltip": "Whether the stadia button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getStadiaButtonReleased", + "returnType": "bool", + "tooltip": "Whether the stadia button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getType", + "returnType": "wpilib.interfaces.GenericHID.HIDType", + "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.StadiaController", + "functionName": "getXButton", + "returnType": "bool", + "tooltip": "Read the value of the X button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getXButtonPressed", + "returnType": "bool", + "tooltip": "Whether the X button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getXButtonReleased", + "returnType": "bool", + "tooltip": "Whether the X button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexComponent" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexComponent", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getYButton", + "returnType": "bool", + "tooltip": "Read the value of the Y button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexComponent" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexComponent", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getYButtonPressed", + "returnType": "bool", + "tooltip": "Whether the Y button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexComponent" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.StadiaController" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexComponent", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "getYButtonReleased", + "returnType": "bool", + "tooltip": "Whether the Y button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexWidget" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.StadiaController", + "functionName": "google", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the google button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the google button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexWidget" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.StadiaController", + "functionName": "hamburger", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the hamburger button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the hamburger button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._ComplexWidget" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard._ComplexWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.ComplexWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._LayoutComponent", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.StadiaController", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard._LayoutComponent", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._LayoutComponent", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "isConnected", + "returnType": "bool", + "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.StadiaController", + "functionName": "leftBumper", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the left bumper button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left bumper button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "leftStick", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the left stick button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left stick button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "leftTrigger", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the left trigger button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left trigger button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.StadiaController", + "functionName": "rightBumper", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the right bumper button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right bumper button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.StadiaController" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.StadiaController", + "functionName": "rightStick", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the right stick button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right stick button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.StadiaController" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.StadiaController", + "functionName": "rightTrigger", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the right trigger button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right trigger button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "outputNumber", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setOutput", + "returnType": "None", + "tooltip": "Set a single HID output value for the HID.\n\n:param outputNumber: The index of the output to set (1-32)\n:param value: The value to set the output to" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setOutputs", "returnType": "None", - "tooltip": "" + "tooltip": "Set all output values for the HID.\n\n:param value: The 32 bit output value (1 bit for each output)" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._LayoutComponent" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "columnIndex", - "type": "int" + "name": "type", + "type": "wpilib.interfaces.GenericHID.RumbleType" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard._LayoutComponent", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setRumble", + "returnType": "None", + "tooltip": "Set the rumble output for the HID.\n\nThe DS currently supports 2 rumble values, left rumble and right rumble.\n\n:param type: Which rumble value to set\n:param value: The normalized value (0 to 1) to set the rumble to" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._LayoutComponent" + "type": "wpilib.StadiaController" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._LayoutComponent", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.StadiaController", + "functionName": "stadia", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the stadia button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the stadia button's\n digital signal attached to the given loop." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.StadiaController.Axis", + "classVariables": [ + { + "name": "kLeftX", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kLeftY", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightX", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightY", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.StadiaController.Axis", + "functionName": "__init__", + "returnType": "wpilib.StadiaController.Axis", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.StadiaController.Button", + "classVariables": [ + { + "name": "kA", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kB", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kEllipses", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kFrame", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kGoogle", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kHamburger", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kLeftBumper", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kLeftStick", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kLeftTrigger", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightBumper", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightStick", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightTrigger", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kStadia", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kX", + "tooltip": "", + "type": "int", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._LayoutComponent" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" - } - ], - "declaringClassName": "wpilib.shuffleboard._LayoutComponent", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.ShuffleboardLayout", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "name": "kY", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.StadiaController.Button", + "functionName": "__init__", + "returnType": "wpilib.StadiaController.Button", + "tooltip": "" } ], + "enums": [], + "instanceMethods": [], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", + "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.shuffleboard._SimpleComponent", + "className": "wpilib.SystemServer", "classVariables": [], "constructors": [ { @@ -44456,92 +26061,88 @@ "type": "dict" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleComponent", + "declaringClassName": "wpilib.SystemServer", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SimpleComponent", + "returnType": "wpilib.SystemServer", "tooltip": "Initialize self. See help(type(self)) for accurate signature." } ], "enums": [], - "instanceMethods": [ + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.SystemServer", + "functionName": "getSystemServer", + "returnType": "ntcore.NetworkTableInstance", + "tooltip": "" + } + ] + }, + { + "className": "wpilib.Talon", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" - }, + "declaringClassName": "wpilib.Talon", + "functionName": "__init__", + "returnType": "wpilib.Talon", + "tooltip": "Constructor for a Talon connected via PWM.\n\n:param channel: The PWM channel that the Talon is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", "returnType": "None", - "tooltip": "" + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", "tooltip": "" }, { @@ -44549,178 +26150,95 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." - }, - { - "args": [ + "type": "wpilib.PWMMotorController" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", + "returnType": "None", + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", "returnType": "None", - "tooltip": "" + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleComponent" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleComponent", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleComponent" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleComponent", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleComponent" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" - } - ], - "declaringClassName": "wpilib.shuffleboard._SimpleComponent", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SimpleWidget", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleWidget", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SimpleWidget", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", "tooltip": "" }, { @@ -44728,228 +26246,197 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, - { - "args": [ + "type": "wpiutil.Sendable" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SimpleComponent" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" - } - ], - "declaringClassName": "wpilib.shuffleboard._SimpleComponent", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleComponent" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleComponent", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleComponent" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleComponent", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleWidget" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", + "returnType": "None", + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleWidget" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SimpleWidget" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SimpleWidget", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SimpleWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "" } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.Talon", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] }, { - "className": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "classVariables": [], + "className": "wpilib.TimedRobot", + "classVariables": [ + { + "name": "kDefaultPeriod", + "tooltip": "", + "type": "float", + "writable": false + } + ], "constructors": [ { "args": [ { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "defaultValue": "0.02", + "name": "period", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_bool", + "declaringClassName": "wpilib.TimedRobot", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.TimedRobot", + "tooltip": "Constructor for TimedRobot.\n\n:param period: Period." } ], "enums": [], @@ -44959,651 +26446,474 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.TimedRobot" }, { "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "name": "callback", + "type": "Callable[[], None]" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "period", + "type": "wpimath.units.seconds" }, { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "defaultValue": "0.0", + "name": "offset", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.TimedRobot", + "functionName": "addPeriodic", "returnType": "None", - "tooltip": "" + "tooltip": "Add a callback to run at a specific period with a starting time offset.\n\nThis is scheduled on TimedRobot's Notifier, so TimedRobot and the callback\nrun synchronously. Interactions between them are thread-safe.\n\n:param callback: The callback to run.\n:param period: The period at which to run the callback.\n:param offset: The offset from the common starting time. This is useful\n for scheduling a callback in a different timeslot relative\n to TimedRobot." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "autonomousExit", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Exit code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits autonomous mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "autonomousInit", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Initialization code for autonomous mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters autonomous mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "autonomousPeriodic", + "returnType": "None", + "tooltip": "Periodic code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in\nautonomous mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "disabledExit", + "returnType": "None", + "tooltip": "Exit code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits disabled mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "disabledInit", + "returnType": "None", + "tooltip": "Initialization code for disabled mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time\nthe robot enters disabled mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "disabledPeriodic", "returnType": "None", - "tooltip": "" + "tooltip": "Periodic code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in disabled\nmode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_bool" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "driverStationConnected", + "returnType": "None", + "tooltip": "Code that needs to know the DS state should go here.\n\nUsers should override this method for initialization that needs to occur\nafter the DS is connected, such as needing the alliance information." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_bool" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.TimedRobot" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.TimedRobot", + "functionName": "endCompetition", + "returnType": "None", + "tooltip": "Ends the main loop in StartCompetition()." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_bool" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueComponent_double", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_double", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_double", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.RobotBase", + "functionName": "getControlState", + "returnType": "tuple[bool, bool, bool]", + "tooltip": "More efficient way to determine what state the robot is in.\n\n:returns: booleans representing enabled, isautonomous, istest\n\n.. versionadded:: 2019.2.1\n\n.. note:: This function only exists in RobotPy" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.TimedRobot" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.TimedRobot", + "functionName": "getLoopStartTime", + "returnType": "int", + "tooltip": "Return the system clock time in micrseconds for the start of the current\nperiodic loop. This is in the same time base as Timer.GetFPGATimestamp(),\nbut is stable through a loop. It is updated at the beginning of every\nperiodic callback (including the normal periodic loop).\n\n:returns: Robot running time in microseconds, as of the start of the current\n periodic function." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "getPeriod", + "returnType": "wpimath.units.seconds", + "tooltip": "Gets time period between calls to Periodic() functions." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.RobotBase", + "functionName": "isAutonomous", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Autonomous mode.\n\n:returns: True if the robot is currently operating Autonomously as determined\n by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.RobotBase", + "functionName": "isAutonomousEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Autonomous mode and enabled.\n\n:returns: True if the robot us currently operating Autonomously while enabled\n as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isDisabled", + "returnType": "bool", + "tooltip": "Determine if the Robot is currently disabled.\n\n:returns: True if the Robot is currently disabled by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.RobotBase", + "functionName": "isEnabled", + "returnType": "bool", + "tooltip": "Determine if the Robot is currently enabled.\n\n:returns: True if the Robot is currently enabled by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTeleop", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Operator Control mode.\n\n:returns: True if the robot is currently operating in Tele-Op mode as\n determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTeleopEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is current in Operator Control mode and enabled.\n\n:returns: True if the robot is currently operating in Tele-Op mode while\n enabled as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_double" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_double", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTest", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Test mode.\n\n:returns: True if the robot is currently running in Test mode as determined\n by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_double" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_double", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTestEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is current in Test mode and enabled.\n\n:returns: True if the robot is currently operating in Test mode while\n enabled as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_double" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_double", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueComponent_float", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "printWatchdogEpochs", + "returnType": "None", + "tooltip": "Prints list of epochs added so far and their times." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_float", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_float", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "robotInit", + "returnType": "None", + "tooltip": "Robot-wide initialization code should go here.\n\nUsers should override this method for default Robot-wide initialization\nwhich will be called when the robot is first powered on. It will be called\nexactly one time.\n\nNote: This method is functionally identical to the class constructor so\nthat should be used instead." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "robotPeriodic", "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "tooltip": "Periodic code for all modes should go here.\n\nThis function is called each time a new packet is received from the driver\nstation." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.IterativeRobotBase" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "setNetworkTablesFlushEnabled", "returnType": "None", - "tooltip": "" + "tooltip": "Enables or disables flushing NetworkTables every loop iteration.\nBy default, this is enabled.\n\n:deprecated: Deprecated without replacement.\n\n:param enabled: True to enable, false to disable" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.TimedRobot" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.TimedRobot", + "functionName": "startCompetition", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Provide an alternate \"main loop\" via StartCompetition()." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "teleopExit", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Exit code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits teleop mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "teleopInit", + "returnType": "None", + "tooltip": "Initialization code for teleop mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters teleop mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "teleopPeriodic", + "returnType": "None", + "tooltip": "Periodic code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in teleop\nmode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "testExit", + "returnType": "None", + "tooltip": "Exit code for test mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits test mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "testInit", "returnType": "None", - "tooltip": "" + "tooltip": "Initialization code for test mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters test mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_float" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_float", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "testPeriodic", + "returnType": "None", + "tooltip": "Periodic code for test mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in test\nmode." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.TimedRobot", + "functionName": "getRuntimeType", + "returnType": "wpilib.RuntimeType", + "tooltip": "Get the current runtime type.\n\n:returns: Current runtime type." }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_float" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_float", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "args": [], + "declaringClassName": "wpilib.TimedRobot", + "functionName": "isReal", + "returnType": "bool", + "tooltip": "Get if the robot is real.\n\n:returns: If the robot is running in the real world." + }, + { + "args": [], + "declaringClassName": "wpilib.TimedRobot", + "functionName": "isSimulation", + "returnType": "bool", + "tooltip": "Get if the robot is a simulation.\n\n:returns: If the robot is running in simulation." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_float" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "name": "robot_cls", + "type": "object" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_float", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.TimedRobot", + "functionName": "main", + "returnType": "object", + "tooltip": "Starting point for the application" } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] + ] }, { - "className": "wpilib.shuffleboard._SuppliedValueComponent_integer", + "className": "wpilib.Timer", "classVariables": [], "constructors": [ { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_integer", + "args": [], + "declaringClassName": "wpilib.Timer", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_integer", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.Timer", + "tooltip": "Create a new timer object.\n\nCreate a new timer object and reset the time to zero. The timer is\ninitially not running and must be started." } ], "enums": [], @@ -45613,215 +26923,170 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.Timer" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "period", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.Timer", + "functionName": "advanceIfElapsed", + "returnType": "bool", + "tooltip": "Check if the period specified has passed and if it has, advance the start\ntime by that period. This is useful to decide if it's time to do periodic\nwork without drifting later by the time it took to get around to checking.\n\n:param period: The period to check for.\n\n:returns: True if the period has passed." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.Timer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.Timer", + "functionName": "get", + "returnType": "wpimath.units.seconds", + "tooltip": "Get the current time from the timer. If the clock is running it is derived\nfrom the current system clock the start time stored in the timer class. If\nthe clock is not running, then return the time when it was last stopped.\n\n:returns: Current time value for this timer in seconds" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, - { - "args": [ + "type": "wpilib.Timer" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "period", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.Timer", + "functionName": "hasElapsed", + "returnType": "bool", + "tooltip": "Check if the period specified has passed.\n\n:param period: The period to check.\n\n:returns: True if the period has passed." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.Timer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.Timer", + "functionName": "isRunning", + "returnType": "bool", + "tooltip": "Whether the timer is currently running.\n\n:returns: true if running." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.Timer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.Timer", + "functionName": "reset", + "returnType": "None", + "tooltip": "Reset the timer by setting the time to 0.\n\nMake the timer startTime the current time so new requests will be relative\nto now." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.Timer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.Timer", + "functionName": "restart", + "returnType": "None", + "tooltip": "Restart the timer by stopping the timer, if it is not already stopped,\nresetting the accumulated time, then starting the timer again. If you\nwant an event to periodically reoccur at some time interval from the\nstart time, consider using AdvanceIfElapsed() instead." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.Timer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.Timer", + "functionName": "start", "returnType": "None", - "tooltip": "" + "tooltip": "Start the timer running.\n\nJust set the running flag to true indicating that all time requests should\nbe relative to the system clock. Note that this method is a no-op if the\ntimer is already running." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_integer" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.Timer" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_integer", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.Timer", + "functionName": "stop", + "returnType": "None", + "tooltip": "Stop the timer.\n\nThis computes the time as of now and clears the running flag, causing all\nsubsequent time requests to be read from the accumulated time rather than\nlooking at the system clock." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.Timer", + "functionName": "getFPGATimestamp", + "returnType": "wpimath.units.seconds", + "tooltip": "Return the FPGA system clock time in seconds.\n\nReturn the time from the FPGA hardware clock in seconds since the FPGA\nstarted. Rolls over after 71 minutes.\n\n:returns: Robot running time in seconds." }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_integer" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_integer", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "args": [], + "declaringClassName": "wpilib.Timer", + "functionName": "getMatchTime", + "returnType": "wpimath.units.seconds", + "tooltip": "Return the approximate match time.\n\nThe FMS does not send an official match time to the robots, but does send\nan approximate match time. The value will count down the time remaining in\nthe current period (auto or teleop).\n\nWarning: This is not an official time (so it cannot be used to dispute ref\ncalls or guarantee that a function will trigger before the match ends).\n\nThe Practice Match function of the DS approximates the behavior seen on the\nfield.\n\n:returns: Time remaining in current match period (auto or teleop)" }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_integer" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_integer", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "args": [], + "declaringClassName": "wpilib.Timer", + "functionName": "getTimestamp", + "returnType": "wpimath.units.seconds", + "tooltip": "Return the clock time in seconds. By default, the time is based on the FPGA\nhardware clock in seconds since the FPGA started. However, the return value\nof this method may be modified to use any time base, including\nnon-monotonic time bases.\n\n:returns: Robot running time in seconds." } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] + ] }, { - "className": "wpilib.shuffleboard._SuppliedValueComponent_string", - "classVariables": [], + "className": "wpilib.TimesliceRobot", + "classVariables": [ + { + "name": "kDefaultPeriod", + "tooltip": "", + "type": "float", + "writable": false + } + ], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "robotPeriodicAllocation", + "type": "wpimath.units.seconds" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "controllerPeriod", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_string", + "declaringClassName": "wpilib.TimesliceRobot", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_string", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.TimesliceRobot", + "tooltip": "Constructor for TimesliceRobot.\n\n:param robotPeriodicAllocation: The allocation to give the TimesliceRobot\n periodic functions.\n:param controllerPeriod: The controller period. The sum of all scheduler\n allocations should be less than or equal to this\n value." } ], "enums": [], @@ -45831,651 +27096,592 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.TimedRobot" }, { "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "name": "callback", + "type": "Callable[[], None]" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "period", + "type": "wpimath.units.seconds" + }, + { + "defaultValue": "0.0", + "name": "offset", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", + "declaringClassName": "wpilib.TimedRobot", + "functionName": "addPeriodic", "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "tooltip": "Add a callback to run at a specific period with a starting time offset.\n\nThis is scheduled on TimedRobot's Notifier, so TimedRobot and the callback\nrun synchronously. Interactions between them are thread-safe.\n\n:param callback: The callback to run.\n:param period: The period at which to run the callback.\n:param offset: The offset from the common starting time. This is useful\n for scheduling a callback in a different timeslot relative\n to TimedRobot." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "autonomousExit", "returnType": "None", - "tooltip": "" + "tooltip": "Exit code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits autonomous mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "autonomousInit", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Initialization code for autonomous mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters autonomous mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "autonomousPeriodic", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Periodic code for autonomous mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in\nautonomous mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "disabledExit", + "returnType": "None", + "tooltip": "Exit code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits disabled mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "disabledInit", + "returnType": "None", + "tooltip": "Initialization code for disabled mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time\nthe robot enters disabled mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "disabledPeriodic", + "returnType": "None", + "tooltip": "Periodic code for disabled mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in disabled\nmode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "driverStationConnected", "returnType": "None", - "tooltip": "" + "tooltip": "Code that needs to know the DS state should go here.\n\nUsers should override this method for initialization that needs to occur\nafter the DS is connected, such as needing the alliance information." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_string" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.TimedRobot" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_string", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.TimedRobot", + "functionName": "endCompetition", + "returnType": "None", + "tooltip": "Ends the main loop in StartCompetition()." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_string" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_string", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.RobotBase", + "functionName": "getControlState", + "returnType": "tuple[bool, bool, bool]", + "tooltip": "More efficient way to determine what state the robot is in.\n\n:returns: booleans representing enabled, isautonomous, istest\n\n.. versionadded:: 2019.2.1\n\n.. note:: This function only exists in RobotPy" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_string" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.TimedRobot" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_string", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.TimedRobot", + "functionName": "getLoopStartTime", + "returnType": "int", + "tooltip": "Return the system clock time in micrseconds for the start of the current\nperiodic loop. This is in the same time base as Timer.GetFPGATimestamp(),\nbut is stable through a loop. It is updated at the beginning of every\nperiodic callback (including the normal periodic loop).\n\n:returns: Robot running time in microseconds, as of the start of the current\n periodic function." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "getPeriod", + "returnType": "wpimath.units.seconds", + "tooltip": "Gets time period between calls to Periodic() functions." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, + "type": "wpilib.RobotBase" + } + ], + "declaringClassName": "wpilib.RobotBase", + "functionName": "isAutonomous", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Autonomous mode.\n\n:returns: True if the robot is currently operating Autonomously as determined\n by the Driver Station." + }, + { + "args": [ { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "self", + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isAutonomousEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Autonomous mode and enabled.\n\n:returns: True if the robot us currently operating Autonomously while enabled\n as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isDisabled", + "returnType": "bool", + "tooltip": "Determine if the Robot is currently disabled.\n\n:returns: True if the Robot is currently disabled by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.RobotBase", + "functionName": "isEnabled", + "returnType": "bool", + "tooltip": "Determine if the Robot is currently enabled.\n\n:returns: True if the Robot is currently enabled by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTeleop", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Operator Control mode.\n\n:returns: True if the robot is currently operating in Tele-Op mode as\n determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTeleopEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is current in Operator Control mode and enabled.\n\n:returns: True if the robot is currently operating in Tele-Op mode while\n enabled as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTest", + "returnType": "bool", + "tooltip": "Determine if the robot is currently in Test mode.\n\n:returns: True if the robot is currently running in Test mode as determined\n by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.RobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.RobotBase", + "functionName": "isTestEnabled", + "returnType": "bool", + "tooltip": "Determine if the robot is current in Test mode and enabled.\n\n:returns: True if the robot is currently operating in Test mode while\n enabled as determined by the Driver Station." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "printWatchdogEpochs", "returnType": "None", - "tooltip": "" + "tooltip": "Prints list of epochs added so far and their times." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "robotInit", + "returnType": "None", + "tooltip": "Robot-wide initialization code should go here.\n\nUsers should override this method for default Robot-wide initialization\nwhich will be called when the robot is first powered on. It will be called\nexactly one time.\n\nNote: This method is functionally identical to the class constructor so\nthat should be used instead." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "robotPeriodic", + "returnType": "None", + "tooltip": "Periodic code for all modes should go here.\n\nThis function is called each time a new packet is received from the driver\nstation." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool" + "type": "wpilib.TimesliceRobot" }, { "defaultValue": "", - "name": "width", - "type": "int" + "name": "func", + "type": "Callable[[], None]" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "allocation", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.TimesliceRobot", + "functionName": "schedule", + "returnType": "None", + "tooltip": "Schedule a periodic function with the constructor's controller period and\nthe given allocation. The function's runtime allocation will be placed\nafter the end of the previous one's.\n\nIf a call to this function makes the allocations exceed the controller\nperiod, an exception will be thrown since that means the TimesliceRobot\nperiodic functions and the given function will have conflicting\ntimeslices.\n\n:param func: Function to schedule.\n:param allocation: The function's runtime allocation out of the controller\n period." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "self", + "type": "wpilib.IterativeRobotBase" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "setNetworkTablesFlushEnabled", + "returnType": "None", + "tooltip": "Enables or disables flushing NetworkTables every loop iteration.\nBy default, this is enabled.\n\n:deprecated: Deprecated without replacement.\n\n:param enabled: True to enable, false to disable" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.TimedRobot" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", + "declaringClassName": "wpilib.TimedRobot", + "functionName": "startCompetition", "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "tooltip": "Provide an alternate \"main loop\" via StartCompetition()." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "teleopExit", "returnType": "None", - "tooltip": "" + "tooltip": "Exit code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits teleop mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "teleopInit", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Initialization code for teleop mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters teleop mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "teleopPeriodic", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Periodic code for teleop mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in teleop\nmode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "testExit", + "returnType": "None", + "tooltip": "Exit code for test mode should go here.\n\nUsers should override this method for code which will be called each time\nthe robot exits test mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "testInit", + "returnType": "None", + "tooltip": "Initialization code for test mode should go here.\n\nUsers should override this method for initialization code which will be\ncalled each time the robot enters test mode." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.IterativeRobotBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.IterativeRobotBase", + "functionName": "testPeriodic", + "returnType": "None", + "tooltip": "Periodic code for test mode should go here.\n\nUsers should override this method for code which will be called each time a\nnew packet is received from the driver station and the robot is in test\nmode." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.TimesliceRobot", + "functionName": "getRuntimeType", + "returnType": "wpilib.RuntimeType", + "tooltip": "Get the current runtime type.\n\n:returns: Current runtime type." + }, + { + "args": [], + "declaringClassName": "wpilib.TimesliceRobot", + "functionName": "isReal", + "returnType": "bool", + "tooltip": "Get if the robot is real.\n\n:returns: If the robot is running in the real world." + }, + { + "args": [], + "declaringClassName": "wpilib.TimesliceRobot", + "functionName": "isSimulation", + "returnType": "bool", + "tooltip": "Get if the robot is a simulation.\n\n:returns: If the robot is running in simulation." }, + { + "args": [ + { + "defaultValue": "", + "name": "robot_cls", + "type": "object" + } + ], + "declaringClassName": "wpilib.TimesliceRobot", + "functionName": "main", + "returnType": "object", + "tooltip": "Starting point for the application" + } + ] + }, + { + "className": "wpilib.Tracer", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.Tracer", + "functionName": "__init__", + "returnType": "wpilib.Tracer", + "tooltip": "Constructs a Tracer instance." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.Tracer" }, { "defaultValue": "", - "name": "type", + "name": "epochName", "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.Tracer", + "functionName": "addEpoch", "returnType": "None", - "tooltip": "" + "tooltip": "Adds time since last epoch to the list printed by PrintEpochs().\n\nEpochs are a way to partition the time elapsed so that when overruns occur,\none can determine which parts of an operation consumed the most time.\n\n:param epochName: The name to associate with the epoch." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.Tracer" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.Tracer", + "functionName": "clearEpochs", + "returnType": "None", + "tooltip": "Clears all epochs." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.Tracer" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.Tracer", + "functionName": "getEpochs", + "returnType": "str", + "tooltip": "Retreives list of epochs added so far as a string\n\n.. versionadded:: 2021.1.2\n\n.. note:: This function only exists in RobotPy" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, + "type": "wpilib.Tracer" + } + ], + "declaringClassName": "wpilib.Tracer", + "functionName": "printEpochs", + "returnType": "None", + "tooltip": "Prints list of epochs added so far and their times to the DriverStation." + }, + { + "args": [ { "defaultValue": "", - "name": "height", - "type": "int" + "name": "self", + "type": "wpilib.Tracer" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.Tracer", + "functionName": "resetTimer", + "returnType": "None", + "tooltip": "Restarts the epoch timer." } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", + "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", + "className": "wpilib.Victor", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", + "declaringClassName": "wpilib.Victor", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.Victor", + "tooltip": "Constructor for a Victor 888 connected via PWM.\n\n:param channel: The PWM channel that the Victor 888 is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" } ], "enums": [], @@ -46485,39 +27691,42 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, + "type": "wpilib.MotorSafety" + } + ], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + }, + { + "args": [ { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", "returnType": "None", "tooltip": "" }, @@ -46526,63 +27735,68 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", "returnType": "str", "tooltip": "" }, @@ -46591,17 +27805,25 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, + "type": "wpilib.MotorSafety" + } + ], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + }, + { + "args": [ { "defaultValue": "", - "name": "type", - "type": "str" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", "tooltip": "" }, { @@ -46609,199 +27831,236 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float" - }, + "type": "wpilib.PWMMotorController" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." + }, + { + "args": [ { "defaultValue": "", - "name": "columnIndex", - "type": "int" + "name": "self", + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float" - }, + "type": "wpilib.MotorSafety" + } + ], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." + }, + { + "args": [ { "defaultValue": "", - "name": "width", - "type": "int" + "name": "self", + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "self", + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", "returnType": "None", - "tooltip": "" + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.Victor", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] + }, + { + "className": "wpilib.VictorSP", + "classVariables": [], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.VictorSP", + "functionName": "__init__", + "returnType": "wpilib.VictorSP", + "tooltip": "Constructor for a Victor SP connected via PWM.\n\n:param channel: The PWM channel that the Victor SP is attached to. 0-9 are\n on-board, 10-19 are on the MXP port" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "follower", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "addFollower", + "returnType": "None", + "tooltip": "Make the given PWM motor controller follow the output of this one.\n\n:param follower: The motor controller follower." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "disable", + "returnType": "None", "tooltip": "" }, { @@ -46809,152 +28068,95 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "eliminateDeadband", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "enableDeadbandElimination", "returnType": "None", - "tooltip": "" + "tooltip": "Optionally eliminate the deadband from a motor controller.\n\n:param eliminateDeadband: If true, set the motor curve on the motor\n controller to eliminate the deadband in the middle\n of the range. Otherwise, keep the full range\n without modifying any values." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the recently set value of the PWM. This value is affected by the\ninversion property. If you want the value that is sent directly to the\nMotorController, use PWM::GetSpeed() instead.\n\n:returns: The most recently set value for the PWM between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getChannel", + "returnType": "int", + "tooltip": "" + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getInverted", + "returnType": "bool", "tooltip": "" }, { @@ -46962,174 +28164,195 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "getVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the voltage output of the motor controller, nominally between -12 V\nand 12 V.\n\n:returns: The voltage of the motor controller, nominally between -12 V and 12\n V." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpiutil.Sendable" + }, + { + "defaultValue": "", + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.PWMMotorController" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Set the PWM value.\n\nThe PWM value is set using a range of -1.0 to 1.0, appropriately scaling\nthe value for the FPGA.\n\n:param value: The speed value between -1.0 and 1.0 to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", "returnType": "None", - "tooltip": "" + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setInverted", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", + "returnType": "None", + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw" + "type": "wpilib.PWMMotorController" }, { "defaultValue": "", - "name": "width", - "type": "int" - }, + "name": "output", + "type": "wpimath.units.volts" + } + ], + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the PWMMotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." + }, + { + "args": [ { "defaultValue": "", - "name": "height", - "type": "int" + "name": "self", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.PWMMotorController", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "" } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] + "moduleName": "wpilib", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.VictorSP", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] }, { - "className": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", + "className": "wpilib.Watchdog", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "timeout", + "type": "wpimath.units.seconds" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "callback", + "type": "Callable[[], None]" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", + "declaringClassName": "wpilib.Watchdog", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.Watchdog", + "tooltip": "Watchdog constructor.\n\n:param timeout: The watchdog's timeout in seconds with microsecond\n resolution.\n:param callback: This function is called when the timeout expires." } ], "enums": [], @@ -47139,215 +28362,167 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.Watchdog" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "epochName", + "type": "str" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.Watchdog", + "functionName": "addEpoch", "returnType": "None", - "tooltip": "" + "tooltip": "Adds time since last epoch to the list printed by PrintEpochs().\n\nEpochs are a way to partition the time elapsed so that when overruns occur,\none can determine which parts of an operation consumed the most time.\n\n:param epochName: The name to associate with the epoch." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.Watchdog" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.Watchdog", + "functionName": "disable", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Disables the watchdog timer." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.Watchdog" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.Watchdog", + "functionName": "enable", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Enables the watchdog timer." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.Watchdog" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.Watchdog", + "functionName": "getTime", + "returnType": "wpimath.units.seconds", + "tooltip": "Returns the time since the watchdog was last fed." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.Watchdog" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.Watchdog", + "functionName": "getTimeout", + "returnType": "wpimath.units.seconds", + "tooltip": "Returns the watchdog's timeout." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.Watchdog" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.Watchdog", + "functionName": "isExpired", + "returnType": "bool", + "tooltip": "Returns true if the watchdog timer has expired." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.Watchdog" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.Watchdog", + "functionName": "printEpochs", "returnType": "None", - "tooltip": "" + "tooltip": "Prints list of epochs added so far and their times." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.Watchdog" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.Watchdog", + "functionName": "reset", + "returnType": "None", + "tooltip": "Resets the watchdog timer.\n\nThis also enables the timer if it was previously disabled." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string" + "type": "wpilib.Watchdog" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "timeout", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.Watchdog", + "functionName": "setTimeout", + "returnType": "None", + "tooltip": "Sets the watchdog's timeout.\n\n:param timeout: The watchdog's timeout in seconds with microsecond\n resolution." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" + "type": "wpilib.Watchdog" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "suppress", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.Watchdog", + "functionName": "suppressTimeoutMessage", + "returnType": "None", + "tooltip": "Enable or disable suppression of the generic timeout message.\n\nThis may be desirable if the user-provided callback already prints a more\nspecific message.\n\n:param suppress: Whether to suppress generic timeout message." } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", + "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.shuffleboard._SuppliedValueWidget_bool", + "className": "wpilib.XboxController", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "port", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_bool", + "declaringClassName": "wpilib.XboxController", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_bool", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.XboxController", + "tooltip": "Construct an instance of a controller.\n\nThe controller index is the USB port on the Driver Station.\n\n:param port: The port on the Driver Station that the controller is plugged\n into (0-5)." } ], "enums": [], @@ -47357,1610 +28532,1523 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.XboxController", + "functionName": "A", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the A button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the A button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "B", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the B button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the B button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POV", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "pov", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POV", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVCenter", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the center (not pressed) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the center of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDown", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDownLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down left direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDownRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_bool" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the left direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_bool" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the right direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_bool" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "width", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" + } + ], + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUp", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up direction of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up direction of a POV on\n the HID." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_bool", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUpLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up left direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_bool" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUpRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_bool" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.XboxController", + "functionName": "X", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the X button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the X button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_bool" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueWidget_double", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.XboxController", + "functionName": "Y", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the Y button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the Y button's\n digital signal attached to the given loop." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "self", + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "axis", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "threshold", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_double", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_double", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "axisGreaterThan", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance that is true when the axis value is greater\nthan threshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value above which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is greater than\n the provided threshold." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "name": "axis", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "threshold", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "axisLessThan", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance that is true when the axis value is less than\nthreshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value below which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is less than the\n provided threshold." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "back", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the back button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the back button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "button", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "button", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around this button's digital signal.\n\n:param button: the button index\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the button's digital signal attached\n to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.XboxController", + "functionName": "getAButton", + "returnType": "bool", + "tooltip": "Read the value of the A button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getAButtonPressed", + "returnType": "bool", + "tooltip": "Whether the A button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.XboxController", + "functionName": "getAButtonReleased", + "returnType": "bool", + "tooltip": "Whether the A button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getAxisCount", + "returnType": "int", + "tooltip": "Get the number of axes for the HID.\n\n:returns: the number of axis for the current HID" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getAxisType", + "returnType": "int", + "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_double" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_double", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getBButton", + "returnType": "bool", + "tooltip": "Read the value of the B button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_double" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_double", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getBButtonPressed", + "returnType": "bool", + "tooltip": "Whether the B button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_double" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_double", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getBButtonReleased", + "returnType": "bool", + "tooltip": "Whether the B button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_double" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.XboxController", + "functionName": "getBackButton", + "returnType": "bool", + "tooltip": "Read the value of the back button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_double" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.XboxController", + "functionName": "getBackButtonPressed", + "returnType": "bool", + "tooltip": "Whether the back button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_double" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueWidget_float", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.XboxController", + "functionName": "getBackButtonReleased", + "returnType": "bool", + "tooltip": "Whether the back button was released since the last check.\n\n:returns: Whether the button was released since the last check." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_float", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_float", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getButtonCount", + "returnType": "int", + "tooltip": "Get the number of buttons for the HID.\n\n:returns: the number of buttons on the current HID" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftBumper", + "returnType": "bool", + "tooltip": "Read the value of the left bumper (LB) button on the controller.\n\n:deprecated: Use GetLeftBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: the state of the button" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftBumperButton", + "returnType": "bool", + "tooltip": "Read the value of the left bumper button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftBumperButtonPressed", + "returnType": "bool", + "tooltip": "Whether the left bumper button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftBumperButtonReleased", + "returnType": "bool", + "tooltip": "Whether the left bumper button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftBumperPressed", + "returnType": "bool", + "tooltip": "Whether the left bumper (LB) was pressed since the last check.\n\n:deprecated: Use GetLeftBumperButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was pressed since the last check" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftBumperReleased", + "returnType": "bool", + "tooltip": "Whether the left bumper (LB) was released since the last check.\n\n:deprecated: Use GetLeftBumperButtonReleased instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftStickButton", + "returnType": "bool", + "tooltip": "Read the value of the left stick button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftStickButtonPressed", + "returnType": "bool", + "tooltip": "Whether the left stick button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_float" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_float", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftStickButtonReleased", + "returnType": "bool", + "tooltip": "Whether the left stick button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_float" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_float", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftTriggerAxis", + "returnType": "float", + "tooltip": "Get the left trigger axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_float" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_float", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftX", + "returnType": "float", + "tooltip": "Get the X axis value of left side of the controller. Right is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_float" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.XboxController", + "functionName": "getLeftY", + "returnType": "float", + "tooltip": "Get the Y axis value of left side of the controller. Back is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_float" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getName", + "returnType": "str", + "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_float" + "type": "wpilib.interfaces.GenericHID" }, { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "defaultValue": "0", + "name": "pov", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueWidget_integer", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPOV", + "returnType": "wpilib.DriverStation.POVDirection", + "tooltip": "Get the angle of a POV on the HID.\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_integer", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_integer", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPOVCount", + "returnType": "int", + "tooltip": "Get the number of POVs for the HID.\n\n:returns: the number of POVs for the current HID" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPort", + "returnType": "int", + "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawAxis", + "returnType": "float", + "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButton", + "returnType": "bool", + "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonPressed", + "returnType": "bool", + "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonReleased", + "returnType": "bool", + "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightBumper", + "returnType": "bool", + "tooltip": "Read the value of the right bumper (RB) button on the controller.\n\n:deprecated: Use GetRightBumperButton instead. This function is deprecated\n for removal to make function names consistent to allow the HID classes to\n be automatically generated.\n\n:returns: the state of the button" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightBumperButton", + "returnType": "bool", + "tooltip": "Read the value of the right bumper button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightBumperButtonPressed", + "returnType": "bool", + "tooltip": "Whether the right bumper button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_integer" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_integer", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightBumperButtonReleased", + "returnType": "bool", + "tooltip": "Whether the right bumper button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_integer" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_integer", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightBumperPressed", + "returnType": "bool", + "tooltip": "Whether the right bumper (RB) was pressed since the last check.\n\n:deprecated: Use GetRightBumperButtonPressed instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was pressed since the last check" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_integer" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_integer", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightBumperReleased", + "returnType": "bool", + "tooltip": "Whether the right bumper (RB) was released since the last check.\n\n:deprecated: Use GetRightBumperButtonReleased instead. This function is\n deprecated for removal to make function names consistent to allow the HID\n classes to be automatically generated.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_integer" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_integer", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightStickButton", + "returnType": "bool", + "tooltip": "Read the value of the right stick button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_integer" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_integer", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightStickButtonPressed", + "returnType": "bool", + "tooltip": "Whether the right stick button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_integer" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_integer", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntegerValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueWidget_string", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightStickButtonReleased", + "returnType": "bool", + "tooltip": "Whether the right stick button was released since the last check.\n\n:returns: Whether the button was released since the last check." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_string", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_string", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightTriggerAxis", + "returnType": "float", + "tooltip": "Get the right trigger axis value of the controller. Note that this axis\nis bound to the range of [0, 1] as opposed to the usual [-1, 1].\n\n:returns: the axis value." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightX", + "returnType": "float", + "tooltip": "Get the X axis value of right side of the controller. Right is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getRightY", + "returnType": "float", + "tooltip": "Get the Y axis value of right side of the controller. Back is positive.\n\n:returns: the axis value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.XboxController", + "functionName": "getStartButton", + "returnType": "bool", + "tooltip": "Read the value of the start button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.XboxController", + "functionName": "getStartButtonPressed", + "returnType": "bool", + "tooltip": "Whether the start button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getStartButtonReleased", + "returnType": "bool", + "tooltip": "Whether the start button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getType", + "returnType": "wpilib.interfaces.GenericHID.HIDType", + "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getXButton", + "returnType": "bool", + "tooltip": "Read the value of the X button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "getXButtonPressed", + "returnType": "bool", + "tooltip": "Whether the X button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_string" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_string", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getXButtonReleased", + "returnType": "bool", + "tooltip": "Whether the X button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_string" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_string", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getYButton", + "returnType": "bool", + "tooltip": "Read the value of the Y button on the controller.\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_string" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" - }, - { - "defaultValue": "", - "name": "height", - "type": "int" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_string", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "getYButtonPressed", + "returnType": "bool", + "tooltip": "Whether the Y button was pressed since the last check.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_string" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "type": "wpilib.XboxController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.XboxController", + "functionName": "getYButtonReleased", + "returnType": "bool", + "tooltip": "Whether the Y button was released since the last check.\n\n:returns: Whether the button was released since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_string" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.XboxController", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_string" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "isConnected", + "returnType": "bool", + "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "self", + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.XboxController", + "functionName": "leftBumper", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the left bumper button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left bumper button's\n digital signal attached to the given loop." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.XboxController", + "functionName": "leftStick", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the left stick button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the left stick button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" - }, - { - "args": [ + "name": "threshold", + "type": "typing.SupportsFloat" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.XboxController", + "functionName": "leftTrigger", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the axis value of the left trigger.\nThe returned trigger will be true when the axis value is greater than\n``threshold``.\n\n:param threshold: the minimum axis value for the returned event to be true.\n This value should be in the range [0, 1] where 0 is the unpressed state of\n the axis.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the left trigger's axis\n exceeds the provided threshold, attached to the given event loop" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, - { - "args": [ + "type": "wpilib.XboxController" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "leftTrigger", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the axis value of the left trigger.\nThe returned trigger will be true when the axis value is greater than 0.5.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the left trigger's axis\n exceeds 0.5, attached to the given event loop" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." - }, - { - "args": [ + "type": "wpilib.XboxController" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "rightBumper", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the right bumper button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right bumper button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.XboxController", + "functionName": "rightStick", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the right stick button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the right stick button's\n digital signal attached to the given loop." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "columnIndex", - "type": "int" + "name": "threshold", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "rightTrigger", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the axis value of the right trigger.\nThe returned trigger will be true when the axis value is greater than\n``threshold``.\n\n:param threshold: the minimum axis value for the returned event to be true.\n This value should be in the range [0, 1] where 0 is the unpressed state of\n the axis.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the right trigger's axis\n exceeds the provided threshold, attached to the given event loop" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.XboxController", + "functionName": "rightTrigger", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the axis value of the right trigger.\nThe returned trigger will be true when the axis value is greater than 0.5.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the right trigger's axis\n exceeds 0.5, attached to the given event loop" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "width", - "type": "int" + "name": "outputNumber", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setOutput", + "returnType": "None", + "tooltip": "Set a single HID output value for the HID.\n\n:param outputNumber: The index of the output to set (1-32)\n:param value: The value to set the output to" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setOutputs", + "returnType": "None", + "tooltip": "Set all output values for the HID.\n\n:param value: The 32 bit output value (1 bit for each output)" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "type", + "type": "wpilib.interfaces.GenericHID.RumbleType" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setRumble", + "returnType": "None", + "tooltip": "Set the rumble output for the HID.\n\nThe DS currently supports 2 rumble values, left rumble and right rumble.\n\n:param type: Which rumble value to set\n:param value: The normalized value (0 to 1) to set the rumble to" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool" + "type": "wpilib.XboxController" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedBoolListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.XboxController", + "functionName": "start", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around the start button's\ndigital signal.\n\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the start button's\n digital signal attached to the given loop." + } + ], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.XboxController.Axis", + "classVariables": [ + { + "name": "kLeftTrigger", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kLeftX", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kLeftY", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightTrigger", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightX", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightY", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.XboxController.Axis", + "functionName": "__init__", + "returnType": "wpilib.XboxController.Axis", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib", + "staticMethods": [] + }, + { + "className": "wpilib.XboxController.Button", + "classVariables": [ + { + "name": "kA", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kB", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kBack", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kLeftBumper", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kLeftStick", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightBumper", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kRightStick", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kStart", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kX", + "tooltip": "", + "type": "int", + "writable": false + }, + { + "name": "kY", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.XboxController.Button", + "functionName": "__init__", + "returnType": "wpilib.XboxController.Button", + "tooltip": "" } ], + "enums": [], + "instanceMethods": [], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", + "moduleName": "wpilib", "staticMethods": [] }, { - "className": "wpilib.shuffleboard._SuppliedValueWidget_vector_double", + "className": "wpilib.cameraserver.CameraServer", "classVariables": [], "constructors": [ { @@ -48976,282 +30064,290 @@ "type": "dict" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_double", + "declaringClassName": "wpilib.cameraserver.CameraServer", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_vector_double", + "returnType": "wpilib.cameraserver.CameraServer", "tooltip": "Initialize self. See help(type(self)) for accurate signature." } ], "enums": [], - "instanceMethods": [ + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib.cameraserver", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.cameraserver.CameraServer", + "functionName": "is_alive", + "returnType": "bool", + "tooltip": ":returns: True if the CameraServer is still alive" + }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "vision_py", + "type": "typing.Optional[str]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", + "declaringClassName": "wpilib.cameraserver.CameraServer", + "functionName": "launch", "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "tooltip": "\n Launches the CameraServer process in autocapture mode or\n using a user-specified python script\n\n :param vision_py: If specified, this is the relative path to\n a filename with a function in it\n\n Example usage::\n\n wpilib.CameraServer.launch(\"vision.py:main\")\n\n .. warning:: You must have robotpy-cscore installed, or this\n function will fail without returning an error\n (you will see an error in the console).\n\n " + } + ] + }, + { + "className": "wpilib.counter.EdgeConfiguration", + "classVariables": [ + { + "name": "kFallingEdge", + "tooltip": "", + "type": "wpilib.counter.EdgeConfiguration", + "writable": false }, + { + "name": "kRisingEdge", + "tooltip": "", + "type": "wpilib.counter.EdgeConfiguration", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", + "declaringClassName": "wpilib.counter.EdgeConfiguration", + "functionName": "__init__", + "returnType": "wpilib.counter.EdgeConfiguration", "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib.counter", + "staticMethods": [] + }, + { + "className": "wpilib.counter.Tachometer", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, - { - "args": [ + "name": "channel", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "name": "configuration", + "type": "wpilib.counter.EdgeConfiguration" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, + "declaringClassName": "wpilib.counter.Tachometer", + "functionName": "__init__", + "returnType": "wpilib.counter.Tachometer", + "tooltip": "Constructs a new tachometer.\n\n:param channel: The DIO Channel.\n:param configuration: Edge configuration" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.counter.Tachometer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.counter.Tachometer", + "functionName": "getEdgesPerRevolution", + "returnType": "int", + "tooltip": "Gets the number of edges per revolution.\n\n:returns: Edges per revolution." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.counter.Tachometer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.counter.Tachometer", + "functionName": "getFrequency", + "returnType": "wpimath.units.hertz", + "tooltip": "Gets the tachometer frequency.\n\n:returns: Current frequency." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.counter.Tachometer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.counter.Tachometer", + "functionName": "getPeriod", + "returnType": "wpimath.units.seconds", + "tooltip": "Gets the tachometer period.\n\n:returns: Current period." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "name": "self", + "type": "wpilib.counter.Tachometer" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.counter.Tachometer", + "functionName": "getRevolutionsPerMinute", + "returnType": "wpimath.units.revolutions_per_minute", + "tooltip": "Gets the current tachometer revolutions per minute.\n\nSetEdgesPerRevolution must be set with a non 0 value for this to work.\n\n:returns: Current RPM." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.counter.Tachometer" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.counter.Tachometer", + "functionName": "getRevolutionsPerSecond", + "returnType": "wpimath.units.turns_per_second", + "tooltip": "Gets the current tachometer revolutions per second.\n\nSetEdgesPerRevolution must be set with a non 0 value for this to work.\n\n:returns: Current RPS." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.counter.Tachometer" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.counter.Tachometer", + "functionName": "getStopped", + "returnType": "bool", + "tooltip": "Gets if the tachometer is stopped.\n\n:returns: True if the tachometer is stopped." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", + "returnType": "None", + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double" + "type": "wpilib.counter.Tachometer" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "configuration", + "type": "wpilib.counter.EdgeConfiguration" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.counter.Tachometer", + "functionName": "setEdgeConfiguration", + "returnType": "None", + "tooltip": "Sets the configuration for the channel.\n\n:param configuration: The channel configuration." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double" + "type": "wpilib.counter.Tachometer" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "edges", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.counter.Tachometer", + "functionName": "setEdgesPerRevolution", + "returnType": "None", + "tooltip": "Sets the number of edges per revolution.\n\n:param edges: Edges per revolution." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double" + "type": "wpilib.counter.Tachometer" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "maxPeriod", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_double", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedDoubleListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.counter.Tachometer", + "functionName": "setMaxPeriod", + "returnType": "None", + "tooltip": "Sets the maximum period before the tachometer is considered stopped.\n\n:param maxPeriod: The max period." } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", + "moduleName": "wpilib.counter", "staticMethods": [] }, { - "className": "wpilib.shuffleboard._SuppliedValueWidget_vector_float", + "className": "wpilib.counter.UpDownCounter", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "channel", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "configuration", + "type": "wpilib.counter.EdgeConfiguration" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_float", + "declaringClassName": "wpilib.counter.UpDownCounter", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_vector_float", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.counter.UpDownCounter", + "tooltip": "Constructs a new UpDown Counter.\n\n:param channel: The DIO channel\n:param configuration: Edge configuration" } ], "enums": [], @@ -49261,394 +30357,358 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.counter.UpDownCounter" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", - "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "declaringClassName": "wpilib.counter.UpDownCounter", + "functionName": "getCount", + "returnType": "int", + "tooltip": "Gets the current count.\n\n:returns: The current count." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpiutil.Sendable" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpiutil.Sendable", + "functionName": "initSendable", "returnType": "None", - "tooltip": "" + "tooltip": "Initializes this Sendable object.\n\n:param builder: sendable builder" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.counter.UpDownCounter" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.counter.UpDownCounter", + "functionName": "reset", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Resets the current count." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." - }, - { - "args": [ + "type": "wpilib.counter.UpDownCounter" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "configuration", + "type": "wpilib.counter.EdgeConfiguration" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" - }, + "declaringClassName": "wpilib.counter.UpDownCounter", + "functionName": "setEdgeConfiguration", + "returnType": "None", + "tooltip": "Sets the configuration for the channel.\n\n:param configuration: The channel configuration." + } + ], + "instanceVariables": [], + "moduleName": "wpilib.counter", + "staticMethods": [] + }, + { + "className": "wpilib.drive.DifferentialDrive", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - } - ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." - }, - { - "args": [ + "name": "leftMotor", + "type": "wpilib.interfaces.MotorController" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "rightMotor", + "type": "wpilib.interfaces.MotorController" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "__init__", + "returnType": "wpilib.drive.DifferentialDrive", + "tooltip": "Construct a DifferentialDrive.\n\nTo pass multiple motors per side, use CAN motor controller followers or\nPWMSpeedController::AddFollower(). If a motor needs to be inverted, do so\nbefore passing it in.\n\n:param leftMotor: Left motor.\n:param rightMotor: Right motor." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "name": "leftMotor", + "type": "Callable[[typing.SupportsFloat], None]" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "rightMotor", + "type": "Callable[[typing.SupportsFloat], None]" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" - }, + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "__init__", + "returnType": "wpilib.drive.DifferentialDrive", + "tooltip": "Construct a DifferentialDrive.\n\nTo pass multiple motors per side, use CAN motor controller followers or\nPWMSpeedController::AddFollower(). If a motor needs to be inverted, do so\nbefore passing it in.\n\n:param leftMotor: Left motor setter.\n:param rightMotor: Right motor setter." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float" + "type": "wpilib.drive.DifferentialDrive" }, { "defaultValue": "", - "name": "columnIndex", - "type": "int" + "name": "xSpeed", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "zRotation", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "True", + "name": "squareInputs", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "arcadeDrive", + "returnType": "None", + "tooltip": "Arcade drive method for differential drive platform.\n\nNote: Some drivers may prefer inverted rotation controls. This can be done\nby negating the value passed for rotation.\n\n:param xSpeed: The speed at which the robot should drive along the X\n axis [-1.0..1.0]. Forward is positive.\n:param zRotation: The rotation rate of the robot around the Z axis\n [-1.0..1.0]. Counterclockwise is positive.\n:param squareInputs: If set, decreases the input sensitivity at low speeds." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float" - }, - { - "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float" + "type": "wpilib.drive.DifferentialDrive" }, { "defaultValue": "", - "name": "width", - "type": "int" + "name": "xSpeed", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "zRotation", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "allowTurnInPlace", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "curvatureDrive", + "returnType": "None", + "tooltip": "Curvature drive method for differential drive platform.\n\nThe rotation argument controls the curvature of the robot's path rather\nthan its rate of heading change. This makes the robot more controllable at\nhigh speeds.\n\n:param xSpeed: The robot's speed along the X axis [-1.0..1.0].\n Forward is positive.\n:param zRotation: The normalized curvature [-1.0..1.0].\n Counterclockwise is positive.\n:param allowTurnInPlace: If set, overrides constant-curvature turning for\n turn-in-place maneuvers. zRotation will control\n turning rate instead of curvature." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", + "returnType": "None", + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "type": "wpilib.drive.RobotDriveBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "feedWatchdog", + "returnType": "None", + "tooltip": "Feed the motor safety object. Resets the timer that will stop the motors if\nit completes.\n\n@see MotorSafetyHelper::Feed()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.drive.DifferentialDrive" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_float", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedFloatListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueWidget_vector_int", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "self", + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_int", - "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_vector_int", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.drive.DifferentialDrive" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "initSendable", "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", - "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.drive.RobotDriveBase" + }, + { + "defaultValue": "", + "name": "deadband", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "setDeadband", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Sets the deadband applied to the drive inputs (e.g., joystick values).\n\nThe default value is 0.02. Inputs smaller than the deadband are set to 0.0\nwhile inputs larger than the deadband are scaled from 0.0 to 1.0. See\nfrc::ApplyDeadband().\n\n:param deadband: The deadband to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.MotorSafety" + }, + { + "defaultValue": "", + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.drive.RobotDriveBase" + }, + { + "defaultValue": "", + "name": "maxOutput", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "setMaxOutput", + "returnType": "None", + "tooltip": "Configure the scaling factor for using RobotDrive with motor controllers in\na mode other than PercentVbus or to limit the maximum output.\n\n:param maxOutput: Multiplied with the output percentage computed by the\n drive functions." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.MotorSafety" + }, + { + "defaultValue": "", + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", + "returnType": "None", + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.drive.DifferentialDrive" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "stopMotor", "returnType": "None", "tooltip": "" }, @@ -49657,145 +30717,201 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int" + "type": "wpilib.drive.DifferentialDrive" }, { "defaultValue": "", - "name": "columnIndex", - "type": "int" + "name": "leftSpeed", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "rightSpeed", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "True", + "name": "squareInputs", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" - }, + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "tankDrive", + "returnType": "None", + "tooltip": "Tank drive method for differential drive platform.\n\n:param leftSpeed: The robot left side's speed along the X axis\n [-1.0..1.0]. Forward is positive.\n:param rightSpeed: The robot right side's speed along the X axis\n [-1.0..1.0]. Forward is positive.\n:param squareInputs: If set, decreases the input sensitivity at low speeds." + } + ], + "instanceVariables": [], + "moduleName": "wpilib.drive", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int" + "name": "xSpeed", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "zRotation", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "True", + "name": "squareInputs", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "arcadeDriveIK", + "returnType": "wpilib.drive.DifferentialDrive.WheelSpeeds", + "tooltip": "Arcade drive inverse kinematics for differential drive platform.\n\nNote: Some drivers may prefer inverted rotation controls. This can be done\nby negating the value passed for rotation.\n\n:param xSpeed: The speed at which the robot should drive along the X\n axis [-1.0..1.0]. Forward is positive.\n:param zRotation: The rotation rate of the robot around the Z axis\n [-1.0..1.0]. Clockwise is positive.\n:param squareInputs: If set, decreases the input sensitivity at low speeds.\n\n:returns: Wheel speeds [-1.0..1.0]." + }, + { + "args": [], + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int" + "name": "xSpeed", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "width", - "type": "int" + "name": "zRotation", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "allowTurnInPlace", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "curvatureDriveIK", + "returnType": "wpilib.drive.DifferentialDrive.WheelSpeeds", + "tooltip": "Curvature drive inverse kinematics for differential drive platform.\n\nThe rotation argument controls the curvature of the robot's path rather\nthan its rate of heading change. This makes the robot more controllable at\nhigh speeds.\n\n:param xSpeed: The robot's speed along the X axis [-1.0..1.0].\n Forward is positive.\n:param zRotation: The normalized curvature [-1.0..1.0]. Clockwise is\n positive.\n:param allowTurnInPlace: If set, overrides constant-curvature turning for\n turn-in-place maneuvers. zRotation will control\n turning rate instead of curvature.\n\n:returns: Wheel speeds [-1.0..1.0]." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int" + "name": "leftSpeed", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "rightSpeed", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "True", + "name": "squareInputs", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_int", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.drive.DifferentialDrive", + "functionName": "tankDriveIK", + "returnType": "wpilib.drive.DifferentialDrive.WheelSpeeds", + "tooltip": "Tank drive inverse kinematics for differential drive platform.\n\n:param leftSpeed: The robot left side's speed along the X axis\n [-1.0..1.0]. Forward is positive.\n:param rightSpeed: The robot right side's speed along the X axis\n [-1.0..1.0]. Forward is positive.\n:param squareInputs: If set, decreases the input sensitivity at low speeds.\n\n:returns: Wheel speeds [-1.0..1.0]." + } + ] + }, + { + "className": "wpilib.drive.DifferentialDrive.WheelSpeeds", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.drive.DifferentialDrive.WheelSpeeds", + "functionName": "__init__", + "returnType": "wpilib.drive.DifferentialDrive.WheelSpeeds", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "left", + "tooltip": "Left wheel speed.", + "type": "float", + "writable": true }, + { + "name": "right", + "tooltip": "Right wheel speed.", + "type": "float", + "writable": true + } + ], + "moduleName": "wpilib.drive", + "staticMethods": [] + }, + { + "className": "wpilib.drive.MecanumDrive", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int" + "name": "frontLeftMotor", + "type": "wpilib.interfaces.MotorController" + }, + { + "defaultValue": "", + "name": "rearLeftMotor", + "type": "wpilib.interfaces.MotorController" + }, + { + "defaultValue": "", + "name": "frontRightMotor", + "type": "wpilib.interfaces.MotorController" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "rearRightMotor", + "type": "wpilib.interfaces.MotorController" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_int", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.drive.MecanumDrive", + "functionName": "__init__", + "returnType": "wpilib.drive.MecanumDrive", + "tooltip": "Construct a MecanumDrive.\n\nIf a motor needs to be inverted, do so before passing it in.\n\n:param frontLeftMotor: Front-left motor.\n:param rearLeftMotor: Rear-left motor.\n:param frontRightMotor: Front-right motor.\n:param rearRightMotor: Rear-right motor." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int" + "name": "frontLeftMotor", + "type": "Callable[[typing.SupportsFloat], None]" }, { "defaultValue": "", - "name": "widgetType", - "type": "str" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_int", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedIntListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw", - "classVariables": [], - "constructors": [ - { - "args": [ + "name": "rearLeftMotor", + "type": "Callable[[typing.SupportsFloat], None]" + }, { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "frontRightMotor", + "type": "Callable[[typing.SupportsFloat], None]" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "rearRightMotor", + "type": "Callable[[typing.SupportsFloat], None]" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw", + "declaringClassName": "wpilib.drive.MecanumDrive", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.drive.MecanumDrive", + "tooltip": "Construct a MecanumDrive.\n\nIf a motor needs to be inverted, do so before passing it in.\n\n:param frontLeftMotor: Front-left motor setter.\n:param rearLeftMotor: Rear-left motor setter.\n:param frontRightMotor: Front-right motor setter.\n:param rearRightMotor: Rear-right motor setter." } ], "enums": [], @@ -49805,79 +30921,112 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" + } + ], + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", + "returnType": "None", + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.drive.MecanumDrive" }, { "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" + "name": "xSpeed", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "ySpeed", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "zRotation", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "Rotation2d(0.000000)", + "name": "gyroAngle", + "type": "wpimath.geometry.Rotation2d" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", + "declaringClassName": "wpilib.drive.MecanumDrive", + "functionName": "driveCartesian", "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "tooltip": "Drive method for Mecanum platform.\n\nAngles are measured counterclockwise from the positive X axis. The robot's\nspeed is independent from its angle or rotation rate.\n\n:param xSpeed: The robot's speed along the X axis [-1.0..1.0]. Forward is\n positive.\n:param ySpeed: The robot's speed along the Y axis [-1.0..1.0]. Left is\n positive.\n:param zRotation: The robot's rotation rate around the Z axis [-1.0..1.0].\n Counterclockwise is positive.\n:param gyroAngle: The gyro heading around the Z axis. Use this to implement\n field-oriented controls." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.drive.MecanumDrive" + }, + { + "defaultValue": "", + "name": "magnitude", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "angle", + "type": "wpimath.geometry.Rotation2d" }, { "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "name": "zRotation", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.drive.MecanumDrive", + "functionName": "drivePolar", "returnType": "None", - "tooltip": "" + "tooltip": "Drive method for Mecanum platform.\n\nAngles are measured counterclockwise from the positive X axis. The robot's\nspeed is independent from its angle or rotation rate.\n\n:param magnitude: The robot's speed at a given angle [-1.0..1.0]. Forward is\n positive.\n:param angle: The angle around the Z axis at which the robot drives.\n:param zRotation: The robot's rotation rate around the Z axis [-1.0..1.0].\n Counterclockwise is positive." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.drive.RobotDriveBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "feedWatchdog", "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Feed the motor safety object. Resets the timer that will stop the motors if\nit completes.\n\n@see MotorSafetyHelper::Feed()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.drive.MecanumDrive" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", + "declaringClassName": "wpilib.drive.MecanumDrive", + "functionName": "getDescription", + "returnType": "str", "tooltip": "" }, { @@ -49885,25 +31034,30 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.drive.MecanumDrive" + }, + { + "defaultValue": "", + "name": "builder", + "type": "wpiutil.SendableBuilder" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", + "declaringClassName": "wpilib.drive.MecanumDrive", + "functionName": "initSendable", + "returnType": "None", "tooltip": "" }, { @@ -49911,163 +31065,206 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "type", - "type": "str" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", - "returnType": "None", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" - }, - { - "defaultValue": "", - "name": "rowIndex", - "type": "int" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw" + "type": "wpilib.drive.RobotDriveBase" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "deadband", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "setDeadband", + "returnType": "None", + "tooltip": "Sets the deadband applied to the drive inputs (e.g., joystick values).\n\nThe default value is 0.02. Inputs smaller than the deadband are set to 0.0\nwhile inputs larger than the deadband are scaled from 0.0 to 1.0. See\nfrc::ApplyDeadband().\n\n:param deadband: The deadband to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw" + "type": "wpilib.drive.RobotDriveBase" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "name": "maxOutput", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "setMaxOutput", + "returnType": "None", + "tooltip": "Configure the scaling factor for using RobotDrive with motor controllers in\na mode other than PercentVbus or to limit the maximum output.\n\n:param maxOutput: Multiplied with the output percentage computed by the\n drive functions." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", + "returnType": "None", + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "type": "wpilib.drive.MecanumDrive" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedRawValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.drive.MecanumDrive", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "" } ], "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", - "staticMethods": [] - }, - { - "className": "wpilib.shuffleboard._SuppliedValueWidget_vector_string", - "classVariables": [], - "constructors": [ + "moduleName": "wpilib.drive", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.drive.MecanumDrive", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "xSpeed", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "ySpeed", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "", + "name": "zRotation", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "Rotation2d(0.000000)", + "name": "gyroAngle", + "type": "wpimath.geometry.Rotation2d" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_string", + "declaringClassName": "wpilib.drive.MecanumDrive", + "functionName": "driveCartesianIK", + "returnType": "wpilib.drive.MecanumDrive.WheelSpeeds", + "tooltip": "Cartesian inverse kinematics for Mecanum platform.\n\nAngles are measured counterclockwise from the positive X axis. The robot's\nspeed is independent from its angle or rotation rate.\n\n:param xSpeed: The robot's speed along the X axis [-1.0..1.0]. Forward is\n positive.\n:param ySpeed: The robot's speed along the Y axis [-1.0..1.0]. Left is\n positive.\n:param zRotation: The robot's rotation rate around the Z axis [-1.0..1.0].\n Counterclockwise is positive.\n:param gyroAngle: The gyro heading around the Z axis. Use this to implement\n field-oriented controls.\n\n:returns: Wheel speeds [-1.0..1.0]." + } + ] + }, + { + "className": "wpilib.drive.MecanumDrive.WheelSpeeds", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.drive.MecanumDrive.WheelSpeeds", "functionName": "__init__", - "returnType": "wpilib.shuffleboard._SuppliedValueWidget_vector_string", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." + "returnType": "wpilib.drive.MecanumDrive.WheelSpeeds", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "frontLeft", + "tooltip": "Front-left wheel speed.", + "type": "float", + "writable": true + }, + { + "name": "frontRight", + "tooltip": "Front-right wheel speed.", + "type": "float", + "writable": true + }, + { + "name": "rearLeft", + "tooltip": "Rear-left wheel speed.", + "type": "float", + "writable": true + }, + { + "name": "rearRight", + "tooltip": "Rear-right wheel speed.", + "type": "float", + "writable": true + } + ], + "moduleName": "wpilib.drive", + "staticMethods": [] + }, + { + "className": "wpilib.drive.RobotDriveBase", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "__init__", + "returnType": "wpilib.drive.RobotDriveBase", + "tooltip": "" } ], "enums": [], @@ -50077,264 +31274,291 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" - }, - { - "defaultValue": "", - "name": "parentTable", - "type": "ntcore.NetworkTable" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "buildInto", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "check", "returnType": "None", - "tooltip": "Builds the entries for this value.\n\n:param parentTable: The table containing all the data for the parent. Values\n that require a complex entry or table structure should\n call ``parentTable.getSubtable(getTitle())`` to get\n the table to put data into. Values that only use a\n single entry should call\n ``parentTable.getEntry(getTitle())`` to get that\n entry.\n:param metaTable: The table containing all the metadata for this value and\n its sub-values" + "tooltip": "Check if this motor has exceeded its timeout.\n\nThis method is called periodically to determine if this motor has exceeded\nits timeout value. If it has, the stop method is called, and the motor is\nshut down until its value is updated again." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" - }, - { - "defaultValue": "", - "name": "metaTable", - "type": "ntcore.NetworkTable" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "buildMetadata", + "declaringClassName": "wpilib.MotorSafety", + "functionName": "feed", "returnType": "None", - "tooltip": "" + "tooltip": "Feed the motor safety object.\n\nResets the timer on this object that is used to do the timeouts." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.drive.RobotDriveBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "disableIfActuator", + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "feedWatchdog", "returnType": "None", - "tooltip": "Disables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "tooltip": "Feed the motor safety object. Resets the timer that will stop the motors if\nit completes.\n\n@see MotorSafetyHelper::Feed()" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.drive.RobotDriveBase" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "enableIfActuator", - "returnType": "None", - "tooltip": "Enables user control of this widget in the Shuffleboard application.\n\nThis method is package-private to prevent users from enabling control\nthemselves. Has no effect if the sendable is not marked as an actuator with\nSendableBuilder::SetActuator()." + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "getDescription", + "returnType": "str", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getParent", - "returnType": "wpilib.shuffleboard.ShuffleboardContainer", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "getExpiration", + "returnType": "wpimath.units.seconds", + "tooltip": "Retrieve the timeout value for the corresponding motor safety object.\n\n:returns: the timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardValue" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue", - "functionName": "getTitle", - "returnType": "str", - "tooltip": "Gets the title of this Shuffleboard value." + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isAlive", + "returnType": "bool", + "tooltip": "Determine if the motor is still operating or has timed out.\n\n:returns: true if the motor is still operating normally and hasn't timed out." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.MotorSafety" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "getType", - "returnType": "str", - "tooltip": "" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "isSafetyEnabled", + "returnType": "bool", + "tooltip": "Return the state of the motor safety enabled flag.\n\nReturn if the motor safety is currently enabled for this device.\n\n:returns: True if motor safety is enforced for this device." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard.ShuffleboardComponentBase" + "type": "wpilib.drive.RobotDriveBase" }, { "defaultValue": "", - "name": "type", - "type": "str" + "name": "deadband", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase", - "functionName": "setType", + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "setDeadband", "returnType": "None", - "tooltip": "" + "tooltip": "Sets the deadband applied to the drive inputs (e.g., joystick values).\n\nThe default value is 0.02. Inputs smaller than the deadband are set to 0.0\nwhile inputs larger than the deadband are scaled from 0.0 to 1.0. See\nfrc::ApplyDeadband().\n\n:param deadband: The deadband to set." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string" - }, - { - "defaultValue": "", - "name": "columnIndex", - "type": "int" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "rowIndex", - "type": "int" + "name": "expirationTime", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", - "functionName": "withPosition", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the position of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\nIf the position of a single component is set, it is recommended to set the\npositions of *all* components inside a tab to prevent Shuffleboard\nfrom automatically placing another component there before the one with the\nspecific position is sent.\n\n:param columnIndex: the column in the tab to place this component\n:param rowIndex: the row in the tab to place this component\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setExpiration", + "returnType": "None", + "tooltip": "Set the expiration time for the corresponding motor safety object.\n\n:param expirationTime: The timeout value." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string" + "type": "wpilib.drive.RobotDriveBase" }, { "defaultValue": "", - "name": "properties", - "type": "dict[str, ntcore.Value]" + "name": "maxOutput", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", - "functionName": "withProperties", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets custom properties for this component. Property names are\ncase-sensitive and whitespace-insensitive (capitalization and spaces do not\nmatter).\n\n:param properties: the properties for this component\n\n:returns: this component" + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "setMaxOutput", + "returnType": "None", + "tooltip": "Configure the scaling factor for using RobotDrive with motor controllers in\na mode other than PercentVbus or to limit the maximum output.\n\n:param maxOutput: Multiplied with the output percentage computed by the\n drive functions." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string" - }, - { - "defaultValue": "", - "name": "width", - "type": "int" + "type": "wpilib.MotorSafety" }, { "defaultValue": "", - "name": "height", - "type": "int" + "name": "enabled", + "type": "bool" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueComponent_vector_string", - "functionName": "withSize", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the size of this component in the tab. This has no effect if this\ncomponent is inside a layout.\n\n:param width: how many columns wide the component should be\n:param height: how many rows high the component should be\n\n:returns: this component" + "declaringClassName": "wpilib.MotorSafety", + "functionName": "setSafetyEnabled", + "returnType": "None", + "tooltip": "Enable/disable motor safety for this device.\n\nTurn on and off the motor safety option for this PWM object.\n\n:param enabled: True if motor safety is enforced for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.BuiltInWidgets" + "type": "wpilib.drive.RobotDriveBase" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object\n @see BuiltInWidgets" + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib.drive", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.drive.RobotDriveBase", + "functionName": "checkMotors", + "returnType": "None", + "tooltip": "Check the motors to see if any have timed out.\n\nThis static method is called periodically to poll all the motors and stop\nany that have timed out." + } + ] + }, + { + "className": "wpilib.drive.RobotDriveBase.MotorType", + "classVariables": [ + { + "name": "kBack", + "tooltip": "", + "type": "wpilib.drive.RobotDriveBase.MotorType", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "wpilib.shuffleboard.WidgetType" - } - ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "name": "kFrontLeft", + "tooltip": "", + "type": "wpilib.drive.RobotDriveBase.MotorType", + "writable": false + }, + { + "name": "kFrontRight", + "tooltip": "", + "type": "wpilib.drive.RobotDriveBase.MotorType", + "writable": false }, + { + "name": "kLeft", + "tooltip": "", + "type": "wpilib.drive.RobotDriveBase.MotorType", + "writable": false + }, + { + "name": "kRearLeft", + "tooltip": "", + "type": "wpilib.drive.RobotDriveBase.MotorType", + "writable": false + }, + { + "name": "kRearRight", + "tooltip": "", + "type": "wpilib.drive.RobotDriveBase.MotorType", + "writable": false + }, + { + "name": "kRight", + "tooltip": "", + "type": "wpilib.drive.RobotDriveBase.MotorType", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string" - }, - { - "defaultValue": "", - "name": "widgetType", - "type": "str" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.shuffleboard._SuppliedValueWidget_vector_string", - "functionName": "withWidget", - "returnType": "wpilib.shuffleboard.SuppliedStringListValueWidget", - "tooltip": "Sets the type of widget used to display the data. If not set, the default\nwidget type will be used. This method should only be used to use a widget\nthat does not come built into Shuffleboard (i.e. one that comes with a\ncustom or third-party plugin). To use a widget that is built into\nShuffleboard, use WithWidget(WidgetType) and BuiltInWidgets.\n\n:param widgetType: the type of the widget used to display the data\n\n:returns: this widget object" + "declaringClassName": "wpilib.drive.RobotDriveBase.MotorType", + "functionName": "__init__", + "returnType": "wpilib.drive.RobotDriveBase.MotorType", + "tooltip": "" } ], - "instanceVariables": [], - "moduleName": "wpilib.shuffleboard", + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib.drive", "staticMethods": [] }, { - "className": "wpilib.simulation.ADIS16448_IMUSim", + "className": "wpilib.event.BooleanEvent", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "imu", - "type": "wpilib.ADIS16448_IMU" + "name": "loop", + "type": "wpilib.event.EventLoop" + }, + { + "defaultValue": "", + "name": "signal", + "type": "Callable[[], bool]" } ], - "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim", + "declaringClassName": "wpilib.event.BooleanEvent", "functionName": "__init__", - "returnType": "wpilib.simulation.ADIS16448_IMUSim", - "tooltip": "Constructs from a ADIS16448_IMU object.\n\n:param imu: ADIS16448_IMU to simulate" + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Creates a new event that is active when the condition is true.\n\n:param loop: the loop that polls this event\n:param signal: the digital signal represented by this object." } ], "enums": [], @@ -50344,384 +31568,397 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16448_IMUSim" + "type": "wpilib.event.BooleanEvent" }, { "defaultValue": "", - "name": "accel", - "type": "wpimath.units.meters_per_second_squared" + "name": "ctor", + "type": "Callable" } ], - "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim", - "functionName": "setAccelX", - "returnType": "None", - "tooltip": "Sets the X axis acceleration.\n\n:param accel: The acceleration." + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "castTo", + "returnType": "object", + "tooltip": "A method to \"downcast\" a BooleanEvent instance to a subclass (for example,\nto a command-based version of this class).\n\n:param ctor: a method reference to the constructor of the subclass that\n accepts the loop as the first parameter and the condition/signal as the\n second.\n\n:returns: an instance of the subclass." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16448_IMUSim" + "type": "wpilib.event.BooleanEvent" }, { "defaultValue": "", - "name": "accel", - "type": "wpimath.units.meters_per_second_squared" + "name": "debounceTime", + "type": "wpimath.units.seconds" + }, + { + "defaultValue": "", + "name": "type", + "type": "wpimath.filter.Debouncer.DebounceType" } ], - "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim", - "functionName": "setAccelY", - "returnType": "None", - "tooltip": "Sets the Y axis acceleration.\n\n:param accel: The acceleration." + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "debounce", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Creates a new debounced event from this event - it will become active when\nthis event has been active for longer than the specified period.\n\n:param debounceTime: The debounce period.\n:param type: The debounce type.\n\n:returns: The debounced event." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16448_IMUSim" - }, - { - "defaultValue": "", - "name": "accel", - "type": "wpimath.units.meters_per_second_squared" + "type": "wpilib.event.BooleanEvent" } ], - "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim", - "functionName": "setAccelZ", - "returnType": "None", - "tooltip": "Sets the Z axis acceleration.\n\n:param accel: The acceleration." + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "falling", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Creates a new event that triggers when this one changes from true to false.\n\n:returns: the event." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16448_IMUSim" - }, - { - "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" + "type": "wpilib.event.BooleanEvent" } ], - "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim", - "functionName": "setGyroAngleX", - "returnType": "None", - "tooltip": "Sets the X axis angle (CCW positive).\n\n:param angle: The angle." + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "getAsBoolean", + "returnType": "bool", + "tooltip": "Returns the state of this signal (high or low) as of the last loop poll.\n\n:returns: true for the high state, false for the low state. If the event was\n never polled, it returns the state at event construction." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16448_IMUSim" + "type": "wpilib.event.BooleanEvent" }, { "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" + "name": "action", + "type": "Callable[[], None]" } ], - "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim", - "functionName": "setGyroAngleY", + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "ifHigh", "returnType": "None", - "tooltip": "Sets the Y axis angle (CCW positive).\n\n:param angle: The angle." + "tooltip": "Bind an action to this event.\n\n:param action: the action to run if this event is active." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16448_IMUSim" - }, - { - "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" + "type": "wpilib.event.BooleanEvent" } ], - "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim", - "functionName": "setGyroAngleZ", - "returnType": "None", - "tooltip": "Sets the Z axis angle (CCW positive).\n\n:param angle: The angle." - }, + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "rising", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Creates a new event that triggers when this one changes from false to true.\n\n:returns: the new event." + } + ], + "instanceVariables": [], + "moduleName": "wpilib.event", + "staticMethods": [] + }, + { + "className": "wpilib.event.EventLoop", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.event.EventLoop", + "functionName": "__init__", + "returnType": "wpilib.event.EventLoop", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16448_IMUSim" + "type": "wpilib.event.EventLoop" }, { "defaultValue": "", - "name": "angularRate", - "type": "wpimath.units.degrees_per_second" + "name": "action", + "type": "Callable[[], None]" } ], - "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim", - "functionName": "setGyroRateX", + "declaringClassName": "wpilib.event.EventLoop", + "functionName": "bind", "returnType": "None", - "tooltip": "Sets the X axis angular rate (CCW positive).\n\n:param angularRate: The angular rate." + "tooltip": "Bind a new action to run when the loop is polled.\n\n:param action: the action to run." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16448_IMUSim" - }, - { - "defaultValue": "", - "name": "angularRate", - "type": "wpimath.units.degrees_per_second" + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim", - "functionName": "setGyroRateY", + "declaringClassName": "wpilib.event.EventLoop", + "functionName": "clear", "returnType": "None", - "tooltip": "Sets the Y axis angular rate (CCW positive).\n\n:param angularRate: The angular rate." + "tooltip": "Clear all bindings." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16448_IMUSim" - }, - { - "defaultValue": "", - "name": "angularRate", - "type": "wpimath.units.degrees_per_second" + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim", - "functionName": "setGyroRateZ", + "declaringClassName": "wpilib.event.EventLoop", + "functionName": "poll", "returnType": "None", - "tooltip": "Sets the Z axis angular rate (CCW positive).\n\n:param angularRate: The angular rate." + "tooltip": "Poll all bindings." } ], "instanceVariables": [], - "moduleName": "wpilib.simulation", + "moduleName": "wpilib.event", "staticMethods": [] }, { - "className": "wpilib.simulation.ADIS16470_IMUSim", + "className": "wpilib.event.NetworkBooleanEvent", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "imu", - "type": "wpilib.ADIS16470_IMU" + "name": "loop", + "type": "wpilib.event.EventLoop" + }, + { + "defaultValue": "", + "name": "topic", + "type": "ntcore.BooleanTopic" } ], - "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim", + "declaringClassName": "wpilib.event.NetworkBooleanEvent", "functionName": "__init__", - "returnType": "wpilib.simulation.ADIS16470_IMUSim", - "tooltip": "Constructs from a ADIS16470_IMU object.\n\n:param imu: ADIS16470_IMU to simulate" - } - ], - "enums": [], - "instanceMethods": [ + "returnType": "wpilib.event.NetworkBooleanEvent", + "tooltip": "Creates a new event with the given boolean topic determining whether it is\nactive.\n\n:param loop: the loop that polls this event\n:param topic: The boolean topic that contains the value" + }, + { + "args": [ + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" + }, + { + "defaultValue": "", + "name": "sub", + "type": "ntcore.BooleanSubscriber" + } + ], + "declaringClassName": "wpilib.event.NetworkBooleanEvent", + "functionName": "__init__", + "returnType": "wpilib.event.NetworkBooleanEvent", + "tooltip": "Creates a new event with the given boolean subscriber determining whether\nit is active.\n\n:param loop: the loop that polls this event\n:param sub: The boolean subscriber that provides the value" + }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.ADIS16470_IMUSim" + "name": "loop", + "type": "wpilib.event.EventLoop" }, { "defaultValue": "", - "name": "accel", - "type": "wpimath.units.meters_per_second_squared" + "name": "table", + "type": "ntcore.NetworkTable" + }, + { + "defaultValue": "", + "name": "topicName", + "type": "str" } ], - "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim", - "functionName": "setAccelX", - "returnType": "None", - "tooltip": "Sets the X axis acceleration.\n\n:param accel: The acceleration." + "declaringClassName": "wpilib.event.NetworkBooleanEvent", + "functionName": "__init__", + "returnType": "wpilib.event.NetworkBooleanEvent", + "tooltip": "Creates a new event with the given boolean topic determining whether it is\nactive.\n\n:param loop: the loop that polls this event\n:param table: The NetworkTable that contains the topic\n:param topicName: The topic name within the table that contains the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.ADIS16470_IMUSim" + "name": "loop", + "type": "wpilib.event.EventLoop" }, { "defaultValue": "", - "name": "accel", - "type": "wpimath.units.meters_per_second_squared" + "name": "tableName", + "type": "str" + }, + { + "defaultValue": "", + "name": "topicName", + "type": "str" } ], - "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim", - "functionName": "setAccelY", - "returnType": "None", - "tooltip": "Sets the Y axis acceleration.\n\n:param accel: The acceleration." + "declaringClassName": "wpilib.event.NetworkBooleanEvent", + "functionName": "__init__", + "returnType": "wpilib.event.NetworkBooleanEvent", + "tooltip": "Creates a new event with the given boolean topic determining whether it is\nactive.\n\n:param loop: the loop that polls this event\n:param tableName: The NetworkTable name that contains the topic\n:param topicName: The topic name within the table that contains the value" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.ADIS16470_IMUSim" + "name": "loop", + "type": "wpilib.event.EventLoop" }, { "defaultValue": "", - "name": "accel", - "type": "wpimath.units.meters_per_second_squared" + "name": "inst", + "type": "ntcore.NetworkTableInstance" + }, + { + "defaultValue": "", + "name": "tableName", + "type": "str" + }, + { + "defaultValue": "", + "name": "topicName", + "type": "str" } ], - "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim", - "functionName": "setAccelZ", - "returnType": "None", - "tooltip": "Sets the Z axis acceleration.\n\n:param accel: The acceleration." - }, + "declaringClassName": "wpilib.event.NetworkBooleanEvent", + "functionName": "__init__", + "returnType": "wpilib.event.NetworkBooleanEvent", + "tooltip": "Creates a new event with the given boolean topic determining whether it is\nactive.\n\n:param loop: the loop that polls this event\n:param inst: The NetworkTable instance to use\n:param tableName: The NetworkTable that contains the topic\n:param topicName: The topic name within the table that contains the value" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16470_IMUSim" + "type": "wpilib.event.BooleanEvent" }, { "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" + "name": "ctor", + "type": "Callable" } ], - "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim", - "functionName": "setGyroAngleX", - "returnType": "None", - "tooltip": "Sets the X axis angle (CCW positive).\n\n:param angle: The angle." + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "castTo", + "returnType": "object", + "tooltip": "A method to \"downcast\" a BooleanEvent instance to a subclass (for example,\nto a command-based version of this class).\n\n:param ctor: a method reference to the constructor of the subclass that\n accepts the loop as the first parameter and the condition/signal as the\n second.\n\n:returns: an instance of the subclass." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16470_IMUSim" + "type": "wpilib.event.BooleanEvent" }, { "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" + "name": "debounceTime", + "type": "wpimath.units.seconds" + }, + { + "defaultValue": "", + "name": "type", + "type": "wpimath.filter.Debouncer.DebounceType" } ], - "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim", - "functionName": "setGyroAngleY", - "returnType": "None", - "tooltip": "Sets the Y axis angle (CCW positive).\n\n:param angle: The angle." + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "debounce", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Creates a new debounced event from this event - it will become active when\nthis event has been active for longer than the specified period.\n\n:param debounceTime: The debounce period.\n:param type: The debounce type.\n\n:returns: The debounced event." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16470_IMUSim" - }, - { - "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" + "type": "wpilib.event.BooleanEvent" } ], - "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim", - "functionName": "setGyroAngleZ", - "returnType": "None", - "tooltip": "Sets the Z axis angle (CCW positive).\n\n:param angle: The angle." + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "falling", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Creates a new event that triggers when this one changes from true to false.\n\n:returns: the event." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16470_IMUSim" - }, - { - "defaultValue": "", - "name": "angularRate", - "type": "wpimath.units.degrees_per_second" + "type": "wpilib.event.BooleanEvent" } ], - "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim", - "functionName": "setGyroRateX", - "returnType": "None", - "tooltip": "Sets the X axis angular rate (CCW positive).\n\n:param angularRate: The angular rate." + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "getAsBoolean", + "returnType": "bool", + "tooltip": "Returns the state of this signal (high or low) as of the last loop poll.\n\n:returns: true for the high state, false for the low state. If the event was\n never polled, it returns the state at event construction." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16470_IMUSim" + "type": "wpilib.event.BooleanEvent" }, { "defaultValue": "", - "name": "angularRate", - "type": "wpimath.units.degrees_per_second" + "name": "action", + "type": "Callable[[], None]" } ], - "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim", - "functionName": "setGyroRateY", + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "ifHigh", "returnType": "None", - "tooltip": "Sets the Y axis angular rate (CCW positive).\n\n:param angularRate: The angular rate." + "tooltip": "Bind an action to this event.\n\n:param action: the action to run if this event is active." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADIS16470_IMUSim" - }, - { - "defaultValue": "", - "name": "angularRate", - "type": "wpimath.units.degrees_per_second" + "type": "wpilib.event.BooleanEvent" } ], - "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim", - "functionName": "setGyroRateZ", - "returnType": "None", - "tooltip": "Sets the Z axis angular rate (CCW positive).\n\n:param angularRate: The angular rate." + "declaringClassName": "wpilib.event.BooleanEvent", + "functionName": "rising", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Creates a new event that triggers when this one changes from false to true.\n\n:returns: the new event." } ], "instanceVariables": [], - "moduleName": "wpilib.simulation", + "moduleName": "wpilib.event", "staticMethods": [] }, { - "className": "wpilib.simulation.ADXL345Sim", + "className": "wpilib.interfaces.CounterBase", "classVariables": [], "constructors": [ { - "args": [ - { - "defaultValue": "", - "name": "accel", - "type": "wpilib.ADXL345_I2C" - } - ], - "declaringClassName": "wpilib.simulation.ADXL345Sim", - "functionName": "__init__", - "returnType": "wpilib.simulation.ADXL345Sim", - "tooltip": "Constructs from a ADXL345_I2C object.\n\n:param accel: ADXL345 accel to simulate" - }, - { - "args": [ - { - "defaultValue": "", - "name": "accel", - "type": "wpilib.ADXL345_SPI" - } - ], - "declaringClassName": "wpilib.simulation.ADXL345Sim", + "args": [], + "declaringClassName": "wpilib.interfaces.CounterBase", "functionName": "__init__", - "returnType": "wpilib.simulation.ADXL345Sim", - "tooltip": "Constructs from a ADXL345_SPI object.\n\n:param accel: ADXL345 accel to simulate" + "returnType": "wpilib.interfaces.CounterBase", + "tooltip": "" } ], "enums": [], @@ -50731,223 +31968,161 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADXL345Sim" - }, - { - "defaultValue": "", - "name": "accel", - "type": "float" + "type": "wpilib.interfaces.CounterBase" } ], - "declaringClassName": "wpilib.simulation.ADXL345Sim", - "functionName": "setX", - "returnType": "None", - "tooltip": "Sets the X acceleration.\n\n:param accel: The X acceleration." + "declaringClassName": "wpilib.interfaces.CounterBase", + "functionName": "get", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADXL345Sim" - }, - { - "defaultValue": "", - "name": "accel", - "type": "float" + "type": "wpilib.interfaces.CounterBase" } ], - "declaringClassName": "wpilib.simulation.ADXL345Sim", - "functionName": "setY", - "returnType": "None", - "tooltip": "Sets the Y acceleration.\n\n:param accel: The Y acceleration." + "declaringClassName": "wpilib.interfaces.CounterBase", + "functionName": "getDirection", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADXL345Sim" - }, - { - "defaultValue": "", - "name": "accel", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.ADXL345Sim", - "functionName": "setZ", - "returnType": "None", - "tooltip": "Sets the Z acceleration.\n\n:param accel: The Z acceleration." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, - { - "className": "wpilib.simulation.ADXL362Sim", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "accel", - "type": "wpilib.ADXL362" + "type": "wpilib.interfaces.CounterBase" } ], - "declaringClassName": "wpilib.simulation.ADXL362Sim", - "functionName": "__init__", - "returnType": "wpilib.simulation.ADXL362Sim", - "tooltip": "Constructs from a ADXL362 object.\n\n:param accel: ADXL362 accel to simulate" - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.CounterBase", + "functionName": "getPeriod", + "returnType": "wpimath.units.seconds", + "tooltip": "" + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADXL362Sim" - }, - { - "defaultValue": "", - "name": "accel", - "type": "float" + "type": "wpilib.interfaces.CounterBase" } ], - "declaringClassName": "wpilib.simulation.ADXL362Sim", - "functionName": "setX", - "returnType": "None", - "tooltip": "Sets the X acceleration.\n\n:param accel: The X acceleration." + "declaringClassName": "wpilib.interfaces.CounterBase", + "functionName": "getStopped", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADXL362Sim" - }, - { - "defaultValue": "", - "name": "accel", - "type": "float" + "type": "wpilib.interfaces.CounterBase" } ], - "declaringClassName": "wpilib.simulation.ADXL362Sim", - "functionName": "setY", + "declaringClassName": "wpilib.interfaces.CounterBase", + "functionName": "reset", "returnType": "None", - "tooltip": "Sets the Y acceleration.\n\n:param accel: The Y acceleration." + "tooltip": "" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.ADXL362Sim" + "type": "wpilib.interfaces.CounterBase" }, { "defaultValue": "", - "name": "accel", - "type": "float" + "name": "maxPeriod", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.simulation.ADXL362Sim", - "functionName": "setZ", + "declaringClassName": "wpilib.interfaces.CounterBase", + "functionName": "setMaxPeriod", "returnType": "None", - "tooltip": "Sets the Z acceleration.\n\n:param accel: The Z acceleration." + "tooltip": "" } ], "instanceVariables": [], - "moduleName": "wpilib.simulation", + "moduleName": "wpilib._wpilib.interfaces", "staticMethods": [] }, { - "className": "wpilib.simulation.ADXRS450_GyroSim", - "classVariables": [], + "className": "wpilib.interfaces.CounterBase.EncodingType", + "classVariables": [ + { + "name": "k1X", + "tooltip": "", + "type": "wpilib.interfaces.CounterBase.EncodingType", + "writable": true + }, + { + "name": "k2X", + "tooltip": "", + "type": "wpilib.interfaces.CounterBase.EncodingType", + "writable": true + }, + { + "name": "k4X", + "tooltip": "", + "type": "wpilib.interfaces.CounterBase.EncodingType", + "writable": true + } + ], "constructors": [ { "args": [ { "defaultValue": "", - "name": "gyro", - "type": "wpilib.ADXRS450_Gyro" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.ADXRS450_GyroSim", + "declaringClassName": "wpilib.interfaces.CounterBase.EncodingType", "functionName": "__init__", - "returnType": "wpilib.simulation.ADXRS450_GyroSim", - "tooltip": "Constructs from a ADXRS450_Gyro object.\n\n:param gyro: ADXRS450_Gyro to simulate" + "returnType": "wpilib.interfaces.CounterBase.EncodingType", + "tooltip": "" } ], "enums": [], - "instanceMethods": [ + "instanceMethods": [], + "instanceVariables": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.ADXRS450_GyroSim" - }, - { - "defaultValue": "", - "name": "angle", - "type": "wpimath.units.degrees" - } - ], - "declaringClassName": "wpilib.simulation.ADXRS450_GyroSim", - "functionName": "setAngle", - "returnType": "None", - "tooltip": "Sets the angle.\n\n:param angle: The angle (clockwise positive)." + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.ADXRS450_GyroSim" - }, - { - "defaultValue": "", - "name": "rate", - "type": "wpimath.units.degrees_per_second" - } - ], - "declaringClassName": "wpilib.simulation.ADXRS450_GyroSim", - "functionName": "setRate", - "returnType": "None", - "tooltip": "Sets the angular rate (clockwise positive).\n\n:param rate: The angular rate." + "name": "value", + "tooltip": "", + "type": "int", + "writable": false } ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", + "moduleName": "wpilib._wpilib.interfaces", "staticMethods": [] }, { - "className": "wpilib.simulation.AddressableLEDSim", + "className": "wpilib.interfaces.GenericHID", "classVariables": [], "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.AddressableLEDSim", - "tooltip": "Constructs for the first addressable LED." - }, { "args": [ { "defaultValue": "", - "name": "addressableLED", - "type": "wpilib.AddressableLED" + "name": "port", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "declaringClassName": "wpilib.interfaces.GenericHID", "functionName": "__init__", - "returnType": "wpilib.simulation.AddressableLEDSim", - "tooltip": "Constructs from an AddressableLED object.\n\n:param addressableLED: AddressableLED to simulate" + "returnType": "wpilib.interfaces.GenericHID", + "tooltip": "" } ], "enums": [], @@ -50957,876 +32132,1057 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "data", - "type": "hal.AddressableLEDData" + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "getData", - "returnType": "int", - "tooltip": "Get the LED data.\n\n:param data: output parameter to fill with LED data\n\n:returns: the length of the LED data" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POV", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "pov", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "angle", + "type": "wpilib.DriverStation.POVDirection" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "getInitialized", - "returnType": "bool", - "tooltip": "Check if initialized.\n\n:returns: true if initialized" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POV", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around this angle of a POV on the\nHID.\n\n:param loop: the event loop instance to attach the event to.\n:param pov: index of the POV to read (starting at 0). Defaults to 0.\n:param angle: POV angle.\n\n:returns: a BooleanEvent instance based around this angle of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "getLength", - "returnType": "int", - "tooltip": "Get the length of the LED strip.\n\n:returns: the length" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVCenter", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the center (not pressed) of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the center of a POV on the\n HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "getOutputPort", - "returnType": "int", - "tooltip": "Get the output port.\n\n:returns: the output port" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDown", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "getRunning", - "returnType": "int", - "tooltip": "Check if the LEDs are running.\n\n:returns: true if they are" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDownLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down left direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, int, int], None]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "registerDataCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the LED data.\n\n:param callback: the callback that will be called whenever the LED data is\n changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVDownRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the down right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the down right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "registerInitializedCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the Initialized property.\n\n:param callback: the callback that will be called whenever the Initialized\n property is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object storing this callback" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the left direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "registerLengthCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the length.\n\n:param callback: the callback that will be called whenever the length is\n changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the right direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "registerOutputPortCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the output port.\n\n:param callback: the callback that will be called whenever the output port\n is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUp", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up direction of\nthe default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up direction of a POV on\n the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "registerRunningCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on whether the LEDs are running.\n\n:param callback: the callback that will be called whenever the LED state is\n changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUpLeft", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up left direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up left direction of a POV\n on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" - }, - { - "defaultValue": "", - "name": "data", - "type": "hal.AddressableLEDData" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "length", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "setData", - "returnType": "None", - "tooltip": "Change the LED data.\n\n:param data: the new data\n:param length: the length of the LED data" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "POVUpRight", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs a BooleanEvent instance based around the up right direction\nof the default (index 0) POV on the HID.\n\n:returns: a BooleanEvent instance based around the up right direction of a\n POV on the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "axis", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "threshold", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "initialized", - "type": "bool" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "setInitialized", - "returnType": "None", - "tooltip": "Change the Initialized value of the LED strip.\n\n:param initialized: the new value" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "axisGreaterThan", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance that is true when the axis value is greater\nthan threshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value above which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is greater than\n the provided threshold." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "length", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "setLength", - "returnType": "None", - "tooltip": "Change the length of the LED strip.\n\n:param length: the new value" - }, - { - "args": [ + "name": "axis", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" + "name": "threshold", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "outputPort", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "setOutputPort", - "returnType": "None", - "tooltip": "Change the output port.\n\n:param outputPort: the new output port" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "axisLessThan", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance that is true when the axis value is less than\nthreshold\n\n:param axis: The axis to read, starting at 0.\n:param threshold: The value below which this trigger should return true.\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance that is true when the axis value is less than the\n provided threshold." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AddressableLEDSim" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "running", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "setRunning", - "returnType": "None", - "tooltip": "Change whether the LEDs are active.\n\n:param running: the new value" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [ - { - "args": [ + "name": "button", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "pwmChannel", - "type": "int" + "name": "loop", + "type": "wpilib.event.EventLoop" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "createForChannel", - "returnType": "wpilib.simulation.AddressableLEDSim", - "tooltip": "Creates an AddressableLEDSim for a PWM channel.\n\n:param pwmChannel: PWM channel\n\n:returns: Simulated object\n @throws std::out_of_range if no AddressableLED is configured for that\n channel" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "button", + "returnType": "wpilib.event.BooleanEvent", + "tooltip": "Constructs an event instance around this button's digital signal.\n\n:param button: the button index\n:param loop: the event loop instance to attach the event to.\n\n:returns: an event instance representing the button's digital signal attached\n to the given loop." }, { "args": [ { "defaultValue": "", - "name": "index", - "type": "int" + "name": "self", + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.simulation.AddressableLEDSim", - "functionName": "createForIndex", - "returnType": "wpilib.simulation.AddressableLEDSim", - "tooltip": "Creates an AddressableLEDSim for a simulated index.\nThe index is incremented for each simulated AddressableLED.\n\n:param index: simulator index\n\n:returns: Simulated object" - } - ] - }, - { - "className": "wpilib.simulation.AnalogEncoderSim", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getAxisCount", + "returnType": "int", + "tooltip": "Get the number of axes for the HID.\n\n:returns: the number of axis for the current HID" + }, { "args": [ { "defaultValue": "", - "name": "encoder", - "type": "wpilib.AnalogEncoder" - } - ], - "declaringClassName": "wpilib.simulation.AnalogEncoderSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.AnalogEncoderSim", - "tooltip": "Constructs from an AnalogEncoder object.\n\n:param encoder: AnalogEncoder to simulate" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ + "name": "self", + "type": "wpilib.interfaces.GenericHID" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogEncoderSim" + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogEncoderSim", - "functionName": "get", - "returnType": "float", - "tooltip": "Get the simulated position." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getAxisType", + "returnType": "int", + "tooltip": "Get the axis type of a joystick axis.\n\n:returns: the axis type of a joystick axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogEncoderSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.simulation.AnalogEncoderSim", - "functionName": "set", - "returnType": "None", - "tooltip": "Set the position.\n\n:param value: The position." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, - { - "className": "wpilib.simulation.AnalogGyroSim", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getButtonCount", + "returnType": "int", + "tooltip": "Get the number of buttons for the HID.\n\n:returns: the number of buttons on the current HID" + }, { "args": [ { "defaultValue": "", - "name": "gyro", - "type": "wpilib.AnalogGyro" + "name": "self", + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.AnalogGyroSim", - "tooltip": "Constructs from an AnalogGyro object.\n\n:param gyro: AnalogGyro to simulate" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getName", + "returnType": "str", + "tooltip": "Get the name of the HID.\n\n:returns: the name of the HID." }, { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "self", + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "0", + "name": "pov", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.AnalogGyroSim", - "tooltip": "Constructs from an analog input channel number.\n\n:param channel: Channel number" - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPOV", + "returnType": "wpilib.DriverStation.POVDirection", + "tooltip": "Get the angle of a POV on the HID.\n\n:param pov: The index of the POV to read (starting at 0)\n\n:returns: the angle of the POV." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogGyroSim" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "getAngle", - "returnType": "float", - "tooltip": "Get the current angle of the gyro.\n\n:returns: the angle measured by the gyro" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPOVCount", + "returnType": "int", + "tooltip": "Get the number of POVs for the HID.\n\n:returns: the number of POVs for the current HID" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogGyroSim" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "getInitialized", - "returnType": "bool", - "tooltip": "Check if the gyro is initialized.\n\n:returns: true if initialized" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getPort", + "returnType": "int", + "tooltip": "Get the port number of the HID.\n\n:returns: The port number of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogGyroSim" + "type": "wpilib.interfaces.GenericHID" + }, + { + "defaultValue": "", + "name": "axis", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "getRate", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawAxis", "returnType": "float", - "tooltip": "Get the rate of angle change on this gyro.\n\n:returns: the rate" + "tooltip": "Get the value of the axis.\n\n:param axis: The axis to read, starting at 0.\n\n:returns: The value of the axis." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogGyroSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "registerAngleCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the angle.\n\n:param callback: the callback that will be called whenever the angle changes\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButton", + "returnType": "bool", + "tooltip": "Get the button value (starting at button 1).\n\nThe buttons are returned in a single 16 bit value with one bit representing\nthe state of each button. The appropriate button is returned as a boolean\nvalue.\n\nThis method returns true if the button is being held down at the time\nthat this method is being called.\n\n:param button: The button number to be read (starting at 1)\n\n:returns: The state of the button." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogGyroSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "button", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "registerInitializedCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on whether the gyro is initialized.\n\n:param callback: the callback that will be called whenever the gyro is\n initialized\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonPressed", + "returnType": "bool", + "tooltip": "Whether the button was pressed since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from not pressed to held down\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you press the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was pressed since the last check." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogGyroSim" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, + "name": "button", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getRawButtonReleased", + "returnType": "bool", + "tooltip": "Whether the button was released since the last check. %Button indexes begin\nat 1.\n\nThis method returns true if the button went from held down to not pressed\nsince the last time this method was called. This is useful if you only\nwant to call a function once when you release the button.\n\n:param button: The button index, beginning at 1.\n\n:returns: Whether the button was released since the last check." + }, + { + "args": [ { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "self", + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "registerRateCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the rate.\n\n:param callback: the callback that will be called whenever the rate changes\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "getType", + "returnType": "wpilib.interfaces.GenericHID.HIDType", + "tooltip": "Get the type of the HID.\n\n:returns: the type of the HID." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogGyroSim" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "resetData", - "returnType": "None", - "tooltip": "Reset all simulation data for this object." + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "isConnected", + "returnType": "bool", + "tooltip": "Get if the HID is connected.\n\n:returns: true if the HID is connected" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogGyroSim" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "angle", - "type": "float" + "name": "outputNumber", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "setAngle", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setOutput", "returnType": "None", - "tooltip": "Change the angle measured by the gyro.\n\n:param angle: the new value" + "tooltip": "Set a single HID output value for the HID.\n\n:param outputNumber: The index of the output to set (1-32)\n:param value: The value to set the output to" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogGyroSim" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "initialized", - "type": "bool" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "setInitialized", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setOutputs", "returnType": "None", - "tooltip": "Set whether this gyro is initialized.\n\n:param initialized: the new value" + "tooltip": "Set all output values for the HID.\n\n:param value: The 32 bit output value (1 bit for each output)" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogGyroSim" + "type": "wpilib.interfaces.GenericHID" }, { "defaultValue": "", - "name": "rate", - "type": "float" + "name": "type", + "type": "wpilib.interfaces.GenericHID.RumbleType" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.AnalogGyroSim", - "functionName": "setRate", + "declaringClassName": "wpilib.interfaces.GenericHID", + "functionName": "setRumble", "returnType": "None", - "tooltip": "Change the rate of the gyro.\n\n:param rate: the new rate" + "tooltip": "Set the rumble output for the HID.\n\nThe DS currently supports 2 rumble values, left rumble and right rumble.\n\n:param type: Which rumble value to set\n:param value: The normalized value (0 to 1) to set the rumble to" } ], "instanceVariables": [], - "moduleName": "wpilib.simulation", + "moduleName": "wpilib._wpilib.interfaces", "staticMethods": [] }, { - "className": "wpilib.simulation.AnalogInputSim", - "classVariables": [], + "className": "wpilib.interfaces.GenericHID.HIDType", + "classVariables": [ + { + "name": "kHID1stPerson", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kHIDDriving", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kHIDFlight", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kHIDGamepad", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kHIDJoystick", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kUnknown", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputArcadePad", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputArcadeStick", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputDancePad", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputDrumKit", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputFlightStick", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputGamepad", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputGuitar", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputGuitar2", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputGuitar3", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputUnknown", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + }, + { + "name": "kXInputWheel", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.HIDType", + "writable": false + } + ], "constructors": [ { "args": [ { "defaultValue": "", - "name": "analogInput", - "type": "wpilib.AnalogInput" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", + "declaringClassName": "wpilib.interfaces.GenericHID.HIDType", "functionName": "__init__", - "returnType": "wpilib.simulation.AnalogInputSim", - "tooltip": "Constructs from an AnalogInput object.\n\n:param analogInput: AnalogInput to simulate" + "returnType": "wpilib.interfaces.GenericHID.HIDType", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib._wpilib.interfaces", + "staticMethods": [] + }, + { + "className": "wpilib.interfaces.GenericHID.RumbleType", + "classVariables": [ + { + "name": "kBothRumble", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.RumbleType", + "writable": false + }, + { + "name": "kLeftRumble", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.RumbleType", + "writable": false }, + { + "name": "kRightRumble", + "tooltip": "", + "type": "wpilib.interfaces.GenericHID.RumbleType", + "writable": false + } + ], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "value", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", + "declaringClassName": "wpilib.interfaces.GenericHID.RumbleType", "functionName": "__init__", - "returnType": "wpilib.simulation.AnalogInputSim", - "tooltip": "Constructs from an analog input channel number.\n\n:param channel: Channel number" + "returnType": "wpilib.interfaces.GenericHID.RumbleType", + "tooltip": "" } ], "enums": [], - "instanceMethods": [ + "instanceMethods": [], + "instanceVariables": [ { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogInputSim" - } - ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "getAccumulatorCenter", - "returnType": "int", - "tooltip": "Get the accumulator center.\n\n:returns: the accumulator center" + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib._wpilib.interfaces", + "staticMethods": [] + }, + { + "className": "wpilib.interfaces.MotorController", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.interfaces.MotorController", + "functionName": "__init__", + "returnType": "wpilib.interfaces.MotorController", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.interfaces.MotorController" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "getAccumulatorCount", - "returnType": "int", - "tooltip": "Get the accumulator count.\n\n:returns: the accumulator count." + "declaringClassName": "wpilib.interfaces.MotorController", + "functionName": "disable", + "returnType": "None", + "tooltip": "Common interface for disabling a motor." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.interfaces.MotorController" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "getAccumulatorDeadband", - "returnType": "int", - "tooltip": "Get the accumulator deadband.\n\n:returns: the accumulator deadband" + "declaringClassName": "wpilib.interfaces.MotorController", + "functionName": "get", + "returnType": "float", + "tooltip": "Common interface for getting the current set speed of a motor controller.\n\n:returns: The current set speed. Value is between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.interfaces.MotorController" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "getAccumulatorInitialized", + "declaringClassName": "wpilib.interfaces.MotorController", + "functionName": "getInverted", "returnType": "bool", - "tooltip": "Check if the accumulator has been initialized.\n\n:returns: true if initialized" + "tooltip": "Common interface for returning the inversion state of a motor controller.\n\n:returns: isInverted The state of inversion, true is inverted." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.interfaces.MotorController" + }, + { + "defaultValue": "", + "name": "speed", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "getAccumulatorValue", - "returnType": "int", - "tooltip": "Get the accumulator value.\n\n:returns: the accumulator value" + "declaringClassName": "wpilib.interfaces.MotorController", + "functionName": "set", + "returnType": "None", + "tooltip": "Common interface for setting the speed of a motor controller.\n\n:param speed: The speed to set. Value should be between -1.0 and 1.0." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.interfaces.MotorController" + }, + { + "defaultValue": "", + "name": "isInverted", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "getAverageBits", - "returnType": "int", - "tooltip": "Get the number of average bits.\n\n:returns: the number of average bits" + "declaringClassName": "wpilib.interfaces.MotorController", + "functionName": "setInverted", + "returnType": "None", + "tooltip": "Common interface for inverting direction of a motor controller.\n\n:param isInverted: The state of inversion, true is inverted." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.interfaces.MotorController" + }, + { + "defaultValue": "", + "name": "output", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "getInitialized", - "returnType": "bool", - "tooltip": "Check if this analog input has been initialized.\n\n:returns: true if initialized" + "declaringClassName": "wpilib.interfaces.MotorController", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Sets the voltage output of the MotorController. Compensates for\nthe current bus voltage to ensure that the desired voltage is output even\nif the battery voltage is below 12V - highly useful when the voltage\noutputs are \"meaningful\" (e.g. they come from a feedforward calculation).\n\nNOTE: This function *must* be called regularly in order for voltage\ncompensation to work properly - unlike the ordinary set function, it is not\n\"set it and forget it.\"\n\n:param output: The voltage to output." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.interfaces.MotorController" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "getOversampleBits", - "returnType": "int", - "tooltip": "Get the amount of oversampling bits.\n\n:returns: the amount of oversampling bits" - }, + "declaringClassName": "wpilib.interfaces.MotorController", + "functionName": "stopMotor", + "returnType": "None", + "tooltip": "Common interface to stop the motor until Set is called again." + } + ], + "instanceVariables": [], + "moduleName": "wpilib._wpilib.interfaces", + "staticMethods": [] + }, + { + "className": "wpilib.simulation.ADXL345Sim", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "name": "accel", + "type": "wpilib.ADXL345_I2C" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "getVoltage", - "returnType": "float", - "tooltip": "Get the voltage.\n\n:returns: the voltage" - }, + "declaringClassName": "wpilib.simulation.ADXL345Sim", + "functionName": "__init__", + "returnType": "wpilib.simulation.ADXL345Sim", + "tooltip": "Constructs from a ADXL345_I2C object.\n\n:param accel: ADXL345 accel to simulate" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.simulation.ADXL345Sim" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "accel", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "registerAccumulatorCenterCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the accumulator center.\n\n:param callback: the callback that will be called whenever the accumulator\n center is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.ADXL345Sim", + "functionName": "setX", + "returnType": "None", + "tooltip": "Sets the X acceleration.\n\n:param accel: The X acceleration." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.simulation.ADXL345Sim" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "accel", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "registerAccumulatorCountCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the accumulator count.\n\n:param callback: the callback that will be called whenever the accumulator\n count is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.ADXL345Sim", + "functionName": "setY", + "returnType": "None", + "tooltip": "Sets the Y acceleration.\n\n:param accel: The Y acceleration." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.simulation.ADXL345Sim" }, { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, + "name": "accel", + "type": "typing.SupportsFloat" + } + ], + "declaringClassName": "wpilib.simulation.ADXL345Sim", + "functionName": "setZ", + "returnType": "None", + "tooltip": "Sets the Z acceleration.\n\n:param accel: The Z acceleration." + } + ], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [] + }, + { + "className": "wpilib.simulation.AddressableLEDSim", + "classVariables": [], + "constructors": [ + { + "args": [ { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "registerAccumulatorDeadbandCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the accumulator deadband.\n\n:param callback: the callback that will be called whenever the accumulator\n deadband is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "__init__", + "returnType": "wpilib.simulation.AddressableLEDSim", + "tooltip": "Constructs an addressable LED for a specific channel.\n\n:param channel: output channel" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogInputSim" - }, + "name": "addressableLED", + "type": "wpilib.AddressableLED" + } + ], + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "__init__", + "returnType": "wpilib.simulation.AddressableLEDSim", + "tooltip": "Constructs from an AddressableLED object.\n\n:param addressableLED: AddressableLED to simulate" + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "name": "self", + "type": "wpilib.simulation.AddressableLEDSim" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "data", + "type": "hal.AddressableLEDData" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "registerAccumulatorInitializedCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on whether the accumulator is initialized.\n\n:param callback: the callback that will be called whenever the accumulator\n is initialized\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "getData", + "returnType": "int", + "tooltip": "Get the LED data.\n\n:param data: output parameter to fill with LED data\n\n:returns: the length of the LED data" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "type": "wpilib.simulation.AddressableLEDSim" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "registerAccumulatorValueCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the accumulator value.\n\n:param callback: the callback that will be called whenever the accumulator\n value is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "getInitialized", + "returnType": "bool", + "tooltip": "Check if initialized.\n\n:returns: true if initialized" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, + "type": "wpilib.simulation.AddressableLEDSim" + } + ], + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "getLength", + "returnType": "int", + "tooltip": "Get the length of the LED strip.\n\n:returns: the length" + }, + { + "args": [ { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "self", + "type": "wpilib.simulation.AddressableLEDSim" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "registerAverageBitsCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the number of average bits.\n\n:param callback: the callback that will be called whenever the number of\n average bits is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "getStart", + "returnType": "int", + "tooltip": "Get the start.\n\n:returns: the start" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.simulation.AddressableLEDSim" }, { "defaultValue": "", @@ -51839,17 +33195,17 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", + "declaringClassName": "wpilib.simulation.AddressableLEDSim", "functionName": "registerInitializedCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on whether the analog input is initialized.\n\n:param callback: the callback that will be called whenever the analog input\n is initialized\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback on the Initialized property.\n\n:param callback: the callback that will be called whenever the Initialized\n property is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object storing this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.simulation.AddressableLEDSim" }, { "defaultValue": "", @@ -51862,17 +33218,17 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "registerOversampleBitsCallback", + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "registerLengthCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the amount of oversampling bits.\n\n:param callback: the callback that will be called whenever the oversampling\n bits are changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback on the length.\n\n:param callback: the callback that will be called whenever the length is\n changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.simulation.AddressableLEDSim" }, { "defaultValue": "", @@ -51885,185 +33241,203 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "registerVoltageCallback", + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "registerStartCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the voltage.\n\n:param callback: the callback that will be called whenever the voltage is\n changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback on the start.\n\n:param callback: the callback that will be called whenever the start\n is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.simulation.AddressableLEDSim" + }, + { + "defaultValue": "", + "name": "data", + "type": "hal.AddressableLEDData" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "resetData", + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "setData", "returnType": "None", - "tooltip": "Reset all simulation data for this object." + "tooltip": "Change the LED data.\n\n:param data: the new data" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.simulation.AddressableLEDSim" }, { "defaultValue": "", - "name": "accumulatorCenter", - "type": "int" + "name": "initialized", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "setAccumulatorCenter", + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "setInitialized", "returnType": "None", - "tooltip": "Change the accumulator center.\n\n:param accumulatorCenter: the new center" + "tooltip": "Change the Initialized value of the LED strip.\n\n:param initialized: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.simulation.AddressableLEDSim" }, { "defaultValue": "", - "name": "accumulatorCount", - "type": "int" + "name": "length", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "setAccumulatorCount", + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "setLength", "returnType": "None", - "tooltip": "Change the accumulator count.\n\n:param accumulatorCount: the new count." + "tooltip": "Change the length of the LED strip.\n\n:param length: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.simulation.AddressableLEDSim" }, { "defaultValue": "", - "name": "accumulatorDeadband", - "type": "int" + "name": "start", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "setAccumulatorDeadband", + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "setStart", "returnType": "None", - "tooltip": "Change the accumulator deadband.\n\n:param accumulatorDeadband: the new deadband" - }, + "tooltip": "Change the start.\n\n:param start: the new start" + } + ], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "name": "start", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "accumulatorInitialized", - "type": "bool" + "name": "length", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "data", + "type": "hal.AddressableLEDData" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "setAccumulatorInitialized", - "returnType": "None", - "tooltip": "Change whether the accumulator has been initialized.\n\n:param accumulatorInitialized: the new value" + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "getGlobalData", + "returnType": "int", + "tooltip": "Get the global LED data.\n\n:param start: the start of the LED data\n:param length: the length of the LED data\n:param data: output parameter to fill with LED data\n\n:returns: the length of the LED data" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "name": "callback", + "type": "Callable[[str, typing.SupportsInt, typing.SupportsInt], None]" }, { "defaultValue": "", - "name": "accumulatorValue", - "type": "int" + "name": "initialNotify", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "setAccumulatorValue", - "returnType": "None", - "tooltip": "Change the accumulator value.\n\n:param accumulatorValue: the new value" + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "registerDataCallback", + "returnType": "wpilib.simulation.CallbackStore", + "tooltip": "Register a callback on the LED data.\n\n:param callback: the callback that will be called whenever the LED data is\n changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "name": "start", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "averageBits", - "type": "int" + "name": "length", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "data", + "type": "hal.AddressableLEDData" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "setAverageBits", + "declaringClassName": "wpilib.simulation.AddressableLEDSim", + "functionName": "setGlobalData", "returnType": "None", - "tooltip": "Change the number of average bits.\n\n:param averageBits: the new value" - }, + "tooltip": "Change the global LED data.\n\n:param start: the start of the LED data\n:param length: the length of the LED data\n:param data: the new data" + } + ] + }, + { + "className": "wpilib.simulation.AnalogEncoderSim", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogInputSim" - }, - { - "defaultValue": "", - "name": "initialized", - "type": "bool" + "name": "encoder", + "type": "wpilib.AnalogEncoder" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "setInitialized", - "returnType": "None", - "tooltip": "Change whether this analog input has been initialized.\n\n:param initialized: the new value" - }, + "declaringClassName": "wpilib.simulation.AnalogEncoderSim", + "functionName": "__init__", + "returnType": "wpilib.simulation.AnalogEncoderSim", + "tooltip": "Constructs from an AnalogEncoder object.\n\n:param encoder: AnalogEncoder to simulate" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" - }, - { - "defaultValue": "", - "name": "oversampleBits", - "type": "int" + "type": "wpilib.simulation.AnalogEncoderSim" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "setOversampleBits", - "returnType": "None", - "tooltip": "Change the amount of oversampling bits.\n\n:param oversampleBits: the new value" + "declaringClassName": "wpilib.simulation.AnalogEncoderSim", + "functionName": "get", + "returnType": "float", + "tooltip": "Get the simulated position." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogInputSim" + "type": "wpilib.simulation.AnalogEncoderSim" }, { "defaultValue": "", - "name": "voltage", - "type": "float" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.AnalogInputSim", - "functionName": "setVoltage", + "declaringClassName": "wpilib.simulation.AnalogEncoderSim", + "functionName": "set", "returnType": "None", - "tooltip": "Change the voltage.\n\n:param voltage: the new value" + "tooltip": "Set the position.\n\n:param value: The position." } ], "instanceVariables": [], @@ -52071,34 +33445,34 @@ "staticMethods": [] }, { - "className": "wpilib.simulation.AnalogOutputSim", + "className": "wpilib.simulation.AnalogInputSim", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "analogOutput", - "type": "wpilib.AnalogOutput" + "name": "analogInput", + "type": "wpilib.AnalogInput" } ], - "declaringClassName": "wpilib.simulation.AnalogOutputSim", + "declaringClassName": "wpilib.simulation.AnalogInputSim", "functionName": "__init__", - "returnType": "wpilib.simulation.AnalogOutputSim", - "tooltip": "Constructs from an AnalogOutput object.\n\n:param analogOutput: AnalogOutput to simulate" + "returnType": "wpilib.simulation.AnalogInputSim", + "tooltip": "Constructs from an AnalogInput object.\n\n:param analogInput: AnalogInput to simulate" }, { "args": [ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogOutputSim", + "declaringClassName": "wpilib.simulation.AnalogInputSim", "functionName": "__init__", - "returnType": "wpilib.simulation.AnalogOutputSim", - "tooltip": "Constructs from an analog output channel number.\n\n:param channel: Channel number" + "returnType": "wpilib.simulation.AnalogInputSim", + "tooltip": "Constructs from an analog input channel number.\n\n:param channel: Channel number" } ], "enums": [], @@ -52108,192 +33482,82 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogOutputSim" - } - ], - "declaringClassName": "wpilib.simulation.AnalogOutputSim", - "functionName": "getInitialized", - "returnType": "bool", - "tooltip": "Check whether this analog output has been initialized.\n\n:returns: true if initialized" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogOutputSim" + "type": "wpilib.simulation.AnalogInputSim" } ], - "declaringClassName": "wpilib.simulation.AnalogOutputSim", - "functionName": "getVoltage", - "returnType": "float", - "tooltip": "Read the analog output voltage.\n\n:returns: the voltage on this analog output" + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "getAverageBits", + "returnType": "int", + "tooltip": "Get the number of average bits.\n\n:returns: the number of average bits" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogOutputSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "type": "wpilib.simulation.AnalogInputSim" } ], - "declaringClassName": "wpilib.simulation.AnalogOutputSim", - "functionName": "registerInitializedCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when this analog output is initialized.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "getInitialized", + "returnType": "bool", + "tooltip": "Check if this analog input has been initialized.\n\n:returns: true if initialized" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogOutputSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "type": "wpilib.simulation.AnalogInputSim" } ], - "declaringClassName": "wpilib.simulation.AnalogOutputSim", - "functionName": "registerVoltageCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the voltage changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "getOversampleBits", + "returnType": "int", + "tooltip": "Get the amount of oversampling bits.\n\n:returns: the amount of oversampling bits" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogOutputSim" + "type": "wpilib.simulation.AnalogInputSim" } ], - "declaringClassName": "wpilib.simulation.AnalogOutputSim", - "functionName": "resetData", - "returnType": "None", - "tooltip": "Reset all simulation data on this object." + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "getVoltage", + "returnType": "float", + "tooltip": "Get the voltage.\n\n:returns: the voltage" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogOutputSim" + "type": "wpilib.simulation.AnalogInputSim" }, { "defaultValue": "", - "name": "initialized", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.AnalogOutputSim", - "functionName": "setInitialized", - "returnType": "None", - "tooltip": "Define whether this analog output has been initialized.\n\n:param initialized: whether this object is initialized" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogOutputSim" + "name": "callback", + "type": "Callable[[str, hal.Value], None]" }, { "defaultValue": "", - "name": "voltage", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.AnalogOutputSim", - "functionName": "setVoltage", - "returnType": "None", - "tooltip": "Set the analog output voltage.\n\n:param voltage: the new voltage on this analog output" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, - { - "className": "wpilib.simulation.AnalogTriggerSim", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "analogTrigger", - "type": "wpilib.AnalogTrigger" - } - ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.AnalogTriggerSim", - "tooltip": "Constructs from an AnalogTrigger object.\n\n:param analogTrigger: AnalogTrigger to simulate" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogTriggerSim" - } - ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "getInitialized", - "returnType": "bool", - "tooltip": "Check if this analog trigger has been initialized.\n\n:returns: true if initialized" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogTriggerSim" - } - ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "getTriggerLowerBound", - "returnType": "float", - "tooltip": "Get the lower bound.\n\n:returns: the lower bound" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.AnalogTriggerSim" + "name": "initialNotify", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "getTriggerUpperBound", - "returnType": "float", - "tooltip": "Get the upper bound.\n\n:returns: the upper bound" + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "registerAverageBitsCallback", + "returnType": "wpilib.simulation.CallbackStore", + "tooltip": "Register a callback on the number of average bits.\n\n:param callback: the callback that will be called whenever the number of\n average bits is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogTriggerSim" + "type": "wpilib.simulation.AnalogInputSim" }, { "defaultValue": "", @@ -52306,17 +33570,17 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", + "declaringClassName": "wpilib.simulation.AnalogInputSim", "functionName": "registerInitializedCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on whether the analog trigger is initialized.\n\n:param callback: the callback that will be called whenever the analog\n trigger is initialized\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback on whether the analog input is initialized.\n\n:param callback: the callback that will be called whenever the analog input\n is initialized\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogTriggerSim" + "type": "wpilib.simulation.AnalogInputSim" }, { "defaultValue": "", @@ -52329,17 +33593,17 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "registerTriggerLowerBoundCallback", + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "registerOversampleBitsCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the lower bound.\n\n:param callback: the callback that will be called whenever the lower bound\n is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback on the amount of oversampling bits.\n\n:param callback: the callback that will be called whenever the oversampling\n bits are changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogTriggerSim" + "type": "wpilib.simulation.AnalogInputSim" }, { "defaultValue": "", @@ -52352,20 +33616,20 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "registerTriggerUpperBoundCallback", + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "registerVoltageCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback on the upper bound.\n\n:param callback: the callback that will be called whenever the upper bound\n is changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback on the voltage.\n\n:param callback: the callback that will be called whenever the voltage is\n changed\n:param initialNotify: if true, the callback will be run on the initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogTriggerSim" + "type": "wpilib.simulation.AnalogInputSim" } ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", + "declaringClassName": "wpilib.simulation.AnalogInputSim", "functionName": "resetData", "returnType": "None", "tooltip": "Reset all simulation data for this object." @@ -52375,86 +33639,77 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogTriggerSim" + "type": "wpilib.simulation.AnalogInputSim" }, { "defaultValue": "", - "name": "initialized", - "type": "bool" + "name": "averageBits", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "setInitialized", + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "setAverageBits", "returnType": "None", - "tooltip": "Change whether this analog trigger has been initialized.\n\n:param initialized: the new value" + "tooltip": "Change the number of average bits.\n\n:param averageBits: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogTriggerSim" + "type": "wpilib.simulation.AnalogInputSim" }, { "defaultValue": "", - "name": "triggerLowerBound", - "type": "float" + "name": "initialized", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "setTriggerLowerBound", + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "setInitialized", "returnType": "None", - "tooltip": "Change the lower bound.\n\n:param triggerLowerBound: the new lower bound" + "tooltip": "Change whether this analog input has been initialized.\n\n:param initialized: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.AnalogTriggerSim" + "type": "wpilib.simulation.AnalogInputSim" }, { "defaultValue": "", - "name": "triggerUpperBound", - "type": "float" + "name": "oversampleBits", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "setTriggerUpperBound", + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "setOversampleBits", "returnType": "None", - "tooltip": "Change the upper bound.\n\n:param triggerUpperBound: the new upper bound" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [ + "tooltip": "Change the amount of oversampling bits.\n\n:param oversampleBits: the new value" + }, { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "createForChannel", - "returnType": "wpilib.simulation.AnalogTriggerSim", - "tooltip": "Creates an AnalogTriggerSim for an analog input channel.\n\n:param channel: analog input channel\n\n:returns: Simulated object\n @throws std::out_of_range if no AnalogTrigger is configured for that\n channel" - }, - { - "args": [ + "name": "self", + "type": "wpilib.simulation.AnalogInputSim" + }, { "defaultValue": "", - "name": "index", - "type": "int" + "name": "voltage", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.AnalogTriggerSim", - "functionName": "createForIndex", - "returnType": "wpilib.simulation.AnalogTriggerSim", - "tooltip": "Creates an AnalogTriggerSim for a simulated index.\nThe index is incremented for each simulated AnalogTrigger.\n\n:param index: simulator index\n\n:returns: Simulated object" + "declaringClassName": "wpilib.simulation.AnalogInputSim", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Change the voltage.\n\n:param voltage: the new value" } - ] + ], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [] }, { "className": "wpilib.simulation.BatterySim", @@ -52511,321 +33766,6 @@ } ] }, - { - "className": "wpilib.simulation.BuiltInAccelerometerSim", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.BuiltInAccelerometerSim", - "tooltip": "Constructs for the first built-in accelerometer." - }, - { - "args": [ - { - "defaultValue": "", - "name": "accel", - "type": "wpilib.BuiltInAccelerometer" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.BuiltInAccelerometerSim", - "tooltip": "Constructs from a BuiltInAccelerometer object.\n\n:param accel: BuiltInAccelerometer to simulate" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "getActive", - "returnType": "bool", - "tooltip": "Check whether the accelerometer is active.\n\n:returns: true if active" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "getRange", - "returnType": "hal.AccelerometerRange", - "tooltip": "Check the range of this accelerometer.\n\n:returns: the accelerometer range" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "getX", - "returnType": "float", - "tooltip": "Measure the X axis value.\n\n:returns: the X axis measurement" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "getY", - "returnType": "float", - "tooltip": "Measure the Y axis value.\n\n:returns: the Y axis measurement" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "getZ", - "returnType": "float", - "tooltip": "Measure the Z axis value.\n\n:returns: the Z axis measurement" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "registerActiveCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when this accelerometer activates.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "registerRangeCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the range changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "registerXCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the X axis value changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "registerYCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the Y axis value changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "registerZCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the Z axis value changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "resetData", - "returnType": "None", - "tooltip": "Reset all simulation data of this object." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - }, - { - "defaultValue": "", - "name": "active", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "setActive", - "returnType": "None", - "tooltip": "Define whether this accelerometer is active.\n\n:param active: the new state" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - }, - { - "defaultValue": "", - "name": "range", - "type": "hal.AccelerometerRange" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "setRange", - "returnType": "None", - "tooltip": "Change the range of this accelerometer.\n\n:param range: the new accelerometer range" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - }, - { - "defaultValue": "", - "name": "x", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "setX", - "returnType": "None", - "tooltip": "Change the X axis value of the accelerometer.\n\n:param x: the new reading of the X axis" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - }, - { - "defaultValue": "", - "name": "y", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "setY", - "returnType": "None", - "tooltip": "Change the Y axis value of the accelerometer.\n\n:param y: the new reading of the Y axis" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.BuiltInAccelerometerSim" - }, - { - "defaultValue": "", - "name": "z", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim", - "functionName": "setZ", - "returnType": "None", - "tooltip": "Change the Z axis value of the accelerometer.\n\n:param z: the new reading of the Z axis" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, { "className": "wpilib.simulation.CTREPCMSim", "classVariables": [], @@ -52842,7 +33782,7 @@ { "defaultValue": "", "name": "module", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.CTREPCMSim", @@ -52954,7 +33894,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.CTREPCMSim", @@ -53087,7 +34027,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -53128,7 +34068,7 @@ { "defaultValue": "", "name": "outputs", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.CTREPCMSim", @@ -53164,7 +34104,7 @@ { "defaultValue": "", "name": "compressorCurrent", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.CTREPCMSim", @@ -53236,7 +34176,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -53258,7 +34198,7 @@ { "defaultValue": "", "name": "module", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -53308,7 +34248,7 @@ { "defaultValue": "", "name": "uid", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.CallbackStore", @@ -53340,7 +34280,7 @@ { "defaultValue": "[0.0, 0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(2)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(2)]" } ], "declaringClassName": "wpilib.simulation.DCMotorSim", @@ -53377,6 +34317,19 @@ "returnType": "wpimath.units.radians", "tooltip": "Returns the DC motor position.\n\n:returns: The DC motor position." }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.simulation.DCMotorSim" + } + ], + "declaringClassName": "wpilib.simulation.DCMotorSim", + "functionName": "getAngularPositionRotations", + "returnType": "wpimath.units.turns", + "tooltip": "Returns the DC motor position in rotations" + }, { "args": [ { @@ -53390,6 +34343,19 @@ "returnType": "wpimath.units.radians_per_second", "tooltip": "Returns the DC motor velocity.\n\n:returns: The DC motor velocity." }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.simulation.DCMotorSim" + } + ], + "declaringClassName": "wpilib.simulation.DCMotorSim", + "functionName": "getAngularVelocityRPM", + "returnType": "wpimath.units.revolutions_per_minute", + "tooltip": "Returns the DC motor velocity in revolutions per minute" + }, { "args": [ { @@ -53439,7 +34405,7 @@ ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", "functionName": "getInput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." }, { @@ -53452,7 +34418,7 @@ { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -53496,7 +34462,7 @@ ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", "functionName": "getOutput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." }, { @@ -53509,7 +34475,7 @@ { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -53576,7 +34542,7 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -53594,12 +34560,12 @@ { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -53706,7 +34672,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DIOSim", @@ -53920,7 +34886,7 @@ { "defaultValue": "", "name": "filterIndex", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DIOSim", @@ -53974,7 +34940,7 @@ { "defaultValue": "", "name": "pulseLength", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.DIOSim", @@ -54018,7 +34984,7 @@ }, { "defaultValue": "", - "name": "trackWidth", + "name": "trackwidth", "type": "wpimath.units.meters" }, { @@ -54029,7 +34995,7 @@ { "defaultValue": "", "name": "gearingRatio", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -54039,13 +35005,13 @@ { "defaultValue": "[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(7)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(7)]" } ], "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim", "functionName": "__init__", "returnType": "wpilib.simulation.DifferentialDrivetrainSim", - "tooltip": "Creates a simulated differential drivetrain.\n\n:param plant: The LinearSystem representing the robot's drivetrain. This\n system can be created with\n LinearSystemId::DrivetrainVelocitySystem() or\n LinearSystemId::IdentifyDrivetrainSystem().\n:param trackWidth: The robot's track width.\n:param driveMotor: A DCMotor representing the left side of the drivetrain.\n:param gearingRatio: The gearingRatio ratio of the left side, as output over\n input. This must be the same ratio as the ratio used to\n identify or create the plant.\n:param wheelRadius: The radius of the wheels on the drivetrain, in meters.\n:param measurementStdDevs: Standard deviations for measurements, in the form\n [x, y, heading, left velocity, right velocity,\n left distance, right distance]\u1d40. Can be omitted\n if no noise is desired. Gyro standard deviations\n of 0.0001 radians, velocity standard deviations\n of 0.05 m/s, and position measurement standard\n deviations of 0.005 meters are a reasonable\n starting point." + "tooltip": "Creates a simulated differential drivetrain.\n\n:param plant: The LinearSystem representing the robot's drivetrain. This\n system can be created with\n LinearSystemId::DrivetrainVelocitySystem() or\n LinearSystemId::IdentifyDrivetrainSystem().\n:param trackwidth: The robot's trackwidth.\n:param driveMotor: A DCMotor representing the left side of the drivetrain.\n:param gearingRatio: The gearingRatio ratio of the left side, as output over\n input. This must be the same ratio as the ratio used to\n identify or create the plant.\n:param wheelRadius: The radius of the wheels on the drivetrain, in meters.\n:param measurementStdDevs: Standard deviations for measurements, in the form\n [x, y, heading, left velocity, right velocity,\n left distance, right distance]\u1d40. Can be omitted\n if no noise is desired. Gyro standard deviations\n of 0.0001 radians, velocity standard deviations\n of 0.05 m/s, and position measurement standard\n deviations of 0.005 meters are a reasonable\n starting point." }, { "args": [ @@ -54057,7 +35023,7 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -54076,19 +35042,19 @@ }, { "defaultValue": "", - "name": "trackWidth", + "name": "trackwidth", "type": "wpimath.units.meters" }, { "defaultValue": "[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(7)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(7)]" } ], "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim", "functionName": "__init__", "returnType": "wpilib.simulation.DifferentialDrivetrainSim", - "tooltip": "Creates a simulated differential drivetrain.\n\n:param driveMotor: A DCMotor representing the left side of the drivetrain.\n:param gearing: The gearing on the drive between motor and wheel, as\n output over input. This must be the same ratio as the\n ratio used to identify or create the plant.\n:param J: The moment of inertia of the drivetrain about its\n center.\n:param mass: The mass of the drivebase.\n:param wheelRadius: The radius of the wheels on the drivetrain.\n:param trackWidth: The robot's track width, or distance between left and\n right wheels.\n:param measurementStdDevs: Standard deviations for measurements, in the form\n [x, y, heading, left velocity, right velocity,\n left distance, right distance]\u1d40. Can be omitted\n if no noise is desired. Gyro standard deviations\n of 0.0001 radians, velocity standard deviations\n of 0.05 m/s, and position measurement standard\n deviations of 0.005 meters are a reasonable\n starting point." + "tooltip": "Creates a simulated differential drivetrain.\n\n:param driveMotor: A DCMotor representing the left side of the drivetrain.\n:param gearing: The gearing on the drive between motor and wheel, as\n output over input. This must be the same ratio as the\n ratio used to identify or create the plant.\n:param J: The moment of inertia of the drivetrain about its\n center.\n:param mass: The mass of the drivebase.\n:param wheelRadius: The radius of the wheels on the drivetrain.\n:param trackwidth: The robot's trackwidth, or distance between left and\n right wheels.\n:param measurementStdDevs: Standard deviations for measurements, in the form\n [x, y, heading, left velocity, right velocity,\n left distance, right distance]\u1d40. Can be omitted\n if no noise is desired. Gyro standard deviations\n of 0.0001 radians, velocity standard deviations\n of 0.05 m/s, and position measurement standard\n deviations of 0.005 meters are a reasonable\n starting point." } ], "enums": [], @@ -54103,12 +35069,12 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim", "functionName": "clampInput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Clamp the input vector such that no element exceeds the battery voltage.\nIf any does, the relative magnitudes of the input will be maintained.\n\n:param u: The input vector.\n\n:returns: The normalized input." }, { @@ -54121,17 +35087,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[7, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[7, 1]\"]" }, { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim", "functionName": "dynamics", - "returnType": "numpy.ndarray[numpy.float64[7, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[7, 1]\"]", "tooltip": "The differential drive dynamics function.\n\n:param x: The state.\n:param u: The input.\n\n:returns: The state derivative with respect to time." }, { @@ -54352,7 +35318,7 @@ { "defaultValue": "", "name": "newGearing", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim", @@ -54411,7 +35377,7 @@ { "defaultValue": "", "name": "state", - "type": "numpy.ndarray[numpy.float64[7, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[7, 1]\"]" } ], "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim", @@ -54451,7 +35417,7 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -54461,7 +35427,7 @@ { "defaultValue": "[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(7)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(7)]" } ], "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim", @@ -54479,7 +35445,7 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -54494,7 +35460,7 @@ { "defaultValue": "[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(7)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(7)]" } ], "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim", @@ -54869,7 +35835,7 @@ { "defaultValue": "", "name": "dutyCycle", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.DigitalPWMSim", @@ -54905,7 +35871,7 @@ { "defaultValue": "", "name": "pin", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DigitalPWMSim", @@ -54922,7 +35888,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DigitalPWMSim", @@ -54935,7 +35901,7 @@ { "defaultValue": "", "name": "index", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DigitalPWMSim", @@ -54959,12 +35925,12 @@ { "defaultValue": "", "name": "fwd", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "rev", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DoubleSolenoidSim", @@ -54977,7 +35943,7 @@ { "defaultValue": "", "name": "module", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -54987,12 +35953,12 @@ { "defaultValue": "", "name": "fwd", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "rev", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DoubleSolenoidSim", @@ -55010,12 +35976,12 @@ { "defaultValue": "", "name": "fwd", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "rev", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DoubleSolenoidSim", @@ -55139,7 +36105,7 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55152,12 +36118,12 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "rumbleNum", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55446,17 +36412,17 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55469,12 +36435,12 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55487,17 +36453,17 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "type", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55510,12 +36476,12 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "button", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -55533,12 +36499,12 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55551,12 +36517,12 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "buttons", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55569,25 +36535,25 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "isXbox", + "name": "isGamepad", "type": "bool" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", - "functionName": "setJoystickIsXbox", + "functionName": "setJoystickIsGamepad", "returnType": "None", - "tooltip": "Sets the value of isXbox for a joystick.\n\n:param stick: The joystick number\n:param isXbox: The value of isXbox" + "tooltip": "Sets the value of isGamepad for a joystick.\n\n:param stick: The joystick number\n:param isGamepad: The value of isGamepad" }, { "args": [ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -55605,35 +36571,35 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "pov", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", "functionName": "setJoystickPOV", "returnType": "None", - "tooltip": "Gets the state of a POV on a joystick.\n\n:param stick: The joystick number\n:param pov: The POV number\n:param value: the angle of the POV in degrees, or -1 for not pressed" + "tooltip": "Gets the state of a POV on a joystick.\n\n:param stick: The joystick number\n:param pov: The POV number\n:param value: the angle of the POV" }, { "args": [ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55646,12 +36612,12 @@ { "defaultValue": "", "name": "stick", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "type", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55664,7 +36630,7 @@ { "defaultValue": "", "name": "matchNumber", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55677,7 +36643,7 @@ { "defaultValue": "", "name": "matchTime", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55703,7 +36669,7 @@ { "defaultValue": "", "name": "replayNumber", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DriverStationSim", @@ -55774,7 +36740,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DutyCycleEncoderSim", @@ -55821,7 +36787,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.DutyCycleEncoderSim", @@ -55882,7 +36848,7 @@ ], "declaringClassName": "wpilib.simulation.DutyCycleSim", "functionName": "getFrequency", - "returnType": "int", + "returnType": "wpimath.units.hertz", "tooltip": "Measure the frequency.\n\n:returns: the duty cycle frequency" }, { @@ -56003,7 +36969,7 @@ { "defaultValue": "", "name": "frequency", - "type": "int" + "type": "wpimath.units.hertz" } ], "declaringClassName": "wpilib.simulation.DutyCycleSim", @@ -56039,7 +37005,7 @@ { "defaultValue": "", "name": "output", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.DutyCycleSim", @@ -56056,26 +37022,13 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.DutyCycleSim", "functionName": "createForChannel", "returnType": "wpilib.simulation.DutyCycleSim", - "tooltip": "Creates a DutyCycleSim for a digital input channel.\n\n:param channel: digital input channel\n\n:returns: Simulated object\n @throws std::out_of_range if no DutyCycle is configured for that channel" - }, - { - "args": [ - { - "defaultValue": "", - "name": "index", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.DutyCycleSim", - "functionName": "createForIndex", - "returnType": "wpilib.simulation.DutyCycleSim", - "tooltip": "Creates a DutyCycleSim for a simulated index.\nThe index is incremented for each simulated DutyCycle.\n\n:param index: simulator index\n\n:returns: Simulated object" + "tooltip": "Creates a DutyCycleSim for a SmartIO channel.\n\n:param channel: SmartIO channel\n\n:returns: Simulated object" } ] }, @@ -56118,7 +37071,7 @@ { "defaultValue": "[0.0, 0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(2)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(2)]" } ], "declaringClassName": "wpilib.simulation.ElevatorSim", @@ -56136,7 +37089,7 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -56171,7 +37124,7 @@ { "defaultValue": "[0.0, 0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(2)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(2)]" } ], "declaringClassName": "wpilib.simulation.ElevatorSim", @@ -56205,7 +37158,7 @@ ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", "functionName": "getInput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." }, { @@ -56218,7 +37171,7 @@ { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -56236,7 +37189,7 @@ ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", "functionName": "getOutput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." }, { @@ -56249,7 +37202,7 @@ { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -56358,7 +37311,7 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -56376,12 +37329,12 @@ { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -56882,7 +37835,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.EncoderSim", @@ -56918,7 +37871,7 @@ { "defaultValue": "", "name": "distance", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.EncoderSim", @@ -56936,7 +37889,7 @@ { "defaultValue": "", "name": "distancePerPulse", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.EncoderSim", @@ -56972,7 +37925,7 @@ { "defaultValue": "", "name": "maxPeriod", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.EncoderSim", @@ -56990,7 +37943,7 @@ { "defaultValue": "", "name": "period", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.EncoderSim", @@ -57008,7 +37961,7 @@ { "defaultValue": "", "name": "rate", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.EncoderSim", @@ -57062,7 +38015,7 @@ { "defaultValue": "", "name": "samplesToAverage", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.EncoderSim", @@ -57079,7 +38032,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.EncoderSim", @@ -57092,7 +38045,7 @@ { "defaultValue": "", "name": "index", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.EncoderSim", @@ -57121,7 +38074,7 @@ { "defaultValue": "[0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(1)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(1)]" } ], "declaringClassName": "wpilib.simulation.FlywheelSim", @@ -57180,536 +38133,236 @@ } ], "declaringClassName": "wpilib.simulation.FlywheelSim", - "functionName": "getAngularAcceleration", - "returnType": "wpimath.units.radians_per_second_squared", - "tooltip": "Returns the flywheel's acceleration.\n\n:returns: The flywheel's acceleration" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.FlywheelSim" - } - ], - "declaringClassName": "wpilib.simulation.FlywheelSim", - "functionName": "getAngularVelocity", - "returnType": "wpimath.units.radians_per_second", - "tooltip": "Returns the flywheel's velocity.\n\n:returns: The flywheel's velocity." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.FlywheelSim" - } - ], - "declaringClassName": "wpilib.simulation.FlywheelSim", - "functionName": "getCurrentDraw", - "returnType": "wpimath.units.amperes", - "tooltip": "Returns the flywheel's current draw.\n\n:returns: The flywheel's current draw." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "getInput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", - "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "row", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "getInput", - "returnType": "float", - "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.FlywheelSim" - } - ], - "declaringClassName": "wpilib.simulation.FlywheelSim", - "functionName": "getInputVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Gets the input voltage for the flywheel.\n\n:returns: The flywheel input voltage." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "getOutput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", - "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "row", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "getOutput", - "returnType": "float", - "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.FlywheelSim" - } - ], - "declaringClassName": "wpilib.simulation.FlywheelSim", - "functionName": "getTorque", - "returnType": "wpimath.units.newton_meters", - "tooltip": "Returns the flywheel's torque.\n\n:returns: The flywheel's torque" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "setInput", - "returnType": "None", - "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "row", - "type": "int" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "setInput", - "returnType": "None", - "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.FlywheelSim" - }, - { - "defaultValue": "", - "name": "voltage", - "type": "wpimath.units.volts" - } - ], - "declaringClassName": "wpilib.simulation.FlywheelSim", - "functionName": "setInputVoltage", - "returnType": "None", - "tooltip": "Sets the input voltage for the flywheel.\n\n:param voltage: The input voltage." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "state", - "type": "numpy.ndarray[numpy.float64[1, 1]]" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "setState", - "returnType": "None", - "tooltip": "Sets the system state.\n\n:param state: The new state." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.FlywheelSim" - }, - { - "defaultValue": "", - "name": "velocity", - "type": "wpimath.units.radians_per_second" - } - ], - "declaringClassName": "wpilib.simulation.FlywheelSim", - "functionName": "setVelocity", - "returnType": "None", - "tooltip": "Sets the flywheel's angular velocity.\n\n:param velocity: The new velocity" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "dt", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "update", - "returnType": "None", - "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, - { - "className": "wpilib.simulation.GenericHIDSim", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "joystick", - "type": "wpilib.interfaces.GenericHID" - } - ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.GenericHIDSim", - "tooltip": "Constructs from a GenericHID object.\n\n:param joystick: joystick to simulate" + "functionName": "getAngularAcceleration", + "returnType": "wpimath.units.radians_per_second_squared", + "tooltip": "Returns the flywheel's acceleration.\n\n:returns: The flywheel's acceleration" }, { "args": [ { "defaultValue": "", - "name": "port", - "type": "int" + "name": "self", + "type": "wpilib.simulation.FlywheelSim" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.GenericHIDSim", - "tooltip": "Constructs from a joystick port number.\n\n:param port: port number" - } - ], - "enums": [], - "instanceMethods": [ + "declaringClassName": "wpilib.simulation.FlywheelSim", + "functionName": "getAngularVelocity", + "returnType": "wpimath.units.radians_per_second", + "tooltip": "Returns the flywheel's velocity.\n\n:returns: The flywheel's velocity." + }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "outputNumber", - "type": "int" + "type": "wpilib.simulation.FlywheelSim" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "getOutput", - "returnType": "bool", - "tooltip": "Read the output of a button.\n\n:param outputNumber: the button number\n\n:returns: the value of the button (true = pressed)" + "declaringClassName": "wpilib.simulation.FlywheelSim", + "functionName": "getCurrentDraw", + "returnType": "wpimath.units.amperes", + "tooltip": "Returns the flywheel's current draw.\n\n:returns: The flywheel's current draw." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "getOutputs", - "returnType": "int", - "tooltip": "Get the encoded 16-bit integer that passes button values.\n\n:returns: the button values" + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", + "functionName": "getInput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", - "name": "type", - "type": "wpilib.interfaces.GenericHID.RumbleType" + "name": "row", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "getRumble", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", + "functionName": "getInput", "returnType": "float", - "tooltip": "Get the joystick rumble.\n\n:param type: the rumble to read\n\n:returns: the rumble value" + "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.FlywheelSim" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "notifyNewData", - "returnType": "None", - "tooltip": "Updates joystick data so that new values are visible to the user program." + "declaringClassName": "wpilib.simulation.FlywheelSim", + "functionName": "getInputVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Gets the input voltage for the flywheel.\n\n:returns: The flywheel input voltage." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "count", - "type": "int" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setAxisCount", - "returnType": "None", - "tooltip": "Set the axis count of this device.\n\n:param count: the new axis count" + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", + "functionName": "getOutput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", - "name": "type", - "type": "int" + "name": "row", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setAxisType", - "returnType": "None", - "tooltip": "Set the type of an axis.\n\n:param axis: the axis\n:param type: the type" + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", + "functionName": "getOutput", + "returnType": "float", + "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "count", - "type": "int" + "type": "wpilib.simulation.FlywheelSim" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setButtonCount", - "returnType": "None", - "tooltip": "Set the button count of this device.\n\n:param count: the new button count" + "declaringClassName": "wpilib.simulation.FlywheelSim", + "functionName": "getTorque", + "returnType": "wpimath.units.newton_meters", + "tooltip": "Returns the flywheel's torque.\n\n:returns: The flywheel's torque" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", - "name": "name", - "type": "str" + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setName", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", + "functionName": "setInput", "returnType": "None", - "tooltip": "Set the name of this device.\n\n:param name: the new device name" + "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "pov", - "type": "int" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", - "name": "value", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setPOV", - "returnType": "None", - "tooltip": "Set the value of a given POV.\n\n:param pov: the POV to set\n:param value: the new value" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "name": "row", + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "int" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setPOV", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", + "functionName": "setInput", "returnType": "None", - "tooltip": "Set the value of the default POV (port 0).\n\n:param value: the new value" + "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.FlywheelSim" }, { "defaultValue": "", - "name": "count", - "type": "int" + "name": "voltage", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setPOVCount", + "declaringClassName": "wpilib.simulation.FlywheelSim", + "functionName": "setInputVoltage", "returnType": "None", - "tooltip": "Set the POV count of this device.\n\n:param count: the new POV count" + "tooltip": "Sets the input voltage for the flywheel.\n\n:param voltage: The input voltage." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "state", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setRawAxis", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", + "functionName": "setState", "returnType": "None", - "tooltip": "Set the value of a given axis.\n\n:param axis: the axis to set\n:param value: the new value" + "tooltip": "Sets the system state.\n\n:param state: The new state." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "button", - "type": "int" + "type": "wpilib.simulation.FlywheelSim" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "velocity", + "type": "wpimath.units.radians_per_second" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setRawButton", + "declaringClassName": "wpilib.simulation.FlywheelSim", + "functionName": "setVelocity", "returnType": "None", - "tooltip": "Set the value of a given button.\n\n:param button: the button to set\n:param value: the new value" + "tooltip": "Sets the flywheel's angular velocity.\n\n:param velocity: The new velocity" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", - "name": "type", - "type": "wpilib.interfaces.GenericHID.HIDType" + "name": "dt", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setType", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", + "functionName": "update", "returnType": "None", - "tooltip": "Set the type of this device.\n\n:param type: the new device type" + "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." } ], "instanceVariables": [], @@ -57717,7 +38370,7 @@ "staticMethods": [] }, { - "className": "wpilib.simulation.JoystickSim", + "className": "wpilib.simulation.GenericHIDSim", "classVariables": [], "constructors": [ { @@ -57725,25 +38378,25 @@ { "defaultValue": "", "name": "joystick", - "type": "wpilib.Joystick" + "type": "wpilib.interfaces.GenericHID" } ], - "declaringClassName": "wpilib.simulation.JoystickSim", + "declaringClassName": "wpilib.simulation.GenericHIDSim", "functionName": "__init__", - "returnType": "wpilib.simulation.JoystickSim", - "tooltip": "Constructs from a Joystick object.\n\n:param joystick: joystick to simulate" + "returnType": "wpilib.simulation.GenericHIDSim", + "tooltip": "Constructs from a GenericHID object.\n\n:param joystick: joystick to simulate" }, { "args": [ { "defaultValue": "", "name": "port", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.JoystickSim", + "declaringClassName": "wpilib.simulation.GenericHIDSim", "functionName": "__init__", - "returnType": "wpilib.simulation.JoystickSim", + "returnType": "wpilib.simulation.GenericHIDSim", "tooltip": "Constructs from a joystick port number.\n\n:param port: port number" } ], @@ -57759,7 +38412,7 @@ { "defaultValue": "", "name": "outputNumber", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -57821,7 +38474,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -57839,12 +38492,12 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "type", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -57862,7 +38515,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -57898,12 +38551,12 @@ { "defaultValue": "", "name": "pov", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -57921,7 +38574,7 @@ { "defaultValue": "", "name": "value", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -57939,7 +38592,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -57957,12 +38610,12 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -57980,7 +38633,7 @@ { "defaultValue": "", "name": "button", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -57993,78 +38646,6 @@ "returnType": "None", "tooltip": "Set the value of a given button.\n\n:param button: the button to set\n:param value: the new value" }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.JoystickSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.JoystickSim", - "functionName": "setThrottle", - "returnType": "None", - "tooltip": "Set the throttle value of the joystick.\n\n:param value: the new throttle value" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.JoystickSim" - }, - { - "defaultValue": "", - "name": "state", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.JoystickSim", - "functionName": "setTop", - "returnType": "None", - "tooltip": "Set the top state of the joystick.\n\n:param state: the new state" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.JoystickSim" - }, - { - "defaultValue": "", - "name": "state", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.JoystickSim", - "functionName": "setTrigger", - "returnType": "None", - "tooltip": "Set the trigger value of the joystick.\n\n:param state: the new value" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.JoystickSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.JoystickSim", - "functionName": "setTwist", - "returnType": "None", - "tooltip": "Set the twist value of the joystick.\n\n:param value: the new twist value" - }, { "args": [ { @@ -58082,60 +38663,6 @@ "functionName": "setType", "returnType": "None", "tooltip": "Set the type of this device.\n\n:param type: the new device type" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.JoystickSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.JoystickSim", - "functionName": "setX", - "returnType": "None", - "tooltip": "Set the X value of the joystick.\n\n:param value: the new X value" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.JoystickSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.JoystickSim", - "functionName": "setY", - "returnType": "None", - "tooltip": "Set the Y value of the joystick.\n\n:param value: the new Y value" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.JoystickSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.JoystickSim", - "functionName": "setZ", - "returnType": "None", - "tooltip": "Set the Z value of the joystick.\n\n:param value: the new Z value" } ], "instanceVariables": [], @@ -58143,195 +38670,34 @@ "staticMethods": [] }, { - "className": "wpilib.simulation.LinearSystemSim_1_1_1", + "className": "wpilib.simulation.JoystickSim", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "system", - "type": "wpimath.system.LinearSystem_1_1_1" - }, - { - "defaultValue": "[0.0]", - "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(1)]" + "name": "joystick", + "type": "wpilib.Joystick" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", + "declaringClassName": "wpilib.simulation.JoystickSim", "functionName": "__init__", - "returnType": "wpilib.simulation.LinearSystemSim_1_1_1", - "tooltip": "Creates a simulated generic linear system.\n\n:param system: The system to simulate.\n:param measurementStdDevs: The standard deviations of the measurements." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "getInput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", - "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "row", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "getInput", - "returnType": "float", - "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "getOutput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", - "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "row", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "getOutput", - "returnType": "float", - "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "setInput", - "returnType": "None", - "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "row", - "type": "int" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "setInput", - "returnType": "None", - "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "state", - "type": "numpy.ndarray[numpy.float64[1, 1]]" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "setState", - "returnType": "None", - "tooltip": "Sets the system state.\n\n:param state: The new state." + "returnType": "wpilib.simulation.JoystickSim", + "tooltip": "Constructs from a Joystick object.\n\n:param joystick: joystick to simulate" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_1" - }, - { - "defaultValue": "", - "name": "dt", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", - "functionName": "update", - "returnType": "None", - "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, - { - "className": "wpilib.simulation.LinearSystemSim_1_1_2", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "system", - "type": "wpimath.system.LinearSystem_1_1_2" - }, - { - "defaultValue": "[0.0, 0.0]", - "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(2)]" + "name": "port", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", + "declaringClassName": "wpilib.simulation.JoystickSim", "functionName": "__init__", - "returnType": "wpilib.simulation.LinearSystemSim_1_1_2", - "tooltip": "Creates a simulated generic linear system.\n\n:param system: The system to simulate.\n:param measurementStdDevs: The standard deviations of the measurements." + "returnType": "wpilib.simulation.JoystickSim", + "tooltip": "Constructs from a joystick port number.\n\n:param port: port number" } ], "enums": [], @@ -58341,477 +38707,388 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_2" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", - "functionName": "getInput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", - "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_2" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "row", - "type": "int" + "name": "outputNumber", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", - "functionName": "getInput", - "returnType": "float", - "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "getOutput", + "returnType": "bool", + "tooltip": "Read the output of a button.\n\n:param outputNumber: the button number\n\n:returns: the value of the button (true = pressed)" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_2" + "type": "wpilib.simulation.GenericHIDSim" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", - "functionName": "getOutput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", - "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "getOutputs", + "returnType": "int", + "tooltip": "Get the encoded 16-bit integer that passes button values.\n\n:returns: the button values" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_2" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "row", - "type": "int" + "name": "type", + "type": "wpilib.interfaces.GenericHID.RumbleType" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", - "functionName": "getOutput", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "getRumble", "returnType": "float", - "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." + "tooltip": "Get the joystick rumble.\n\n:param type: the rumble to read\n\n:returns: the rumble value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_2" - }, - { - "defaultValue": "", - "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "wpilib.simulation.GenericHIDSim" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", - "functionName": "setInput", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "notifyNewData", "returnType": "None", - "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." + "tooltip": "Updates joystick data so that new values are visible to the user program." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_2" - }, - { - "defaultValue": "", - "name": "row", - "type": "int" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "count", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", - "functionName": "setInput", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setAxisCount", "returnType": "None", - "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." + "tooltip": "Set the axis count of this device.\n\n:param count: the new axis count" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_2" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "state", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "name": "axis", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "type", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", - "functionName": "setState", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setAxisType", "returnType": "None", - "tooltip": "Sets the system state.\n\n:param state: The new state." + "tooltip": "Set the type of an axis.\n\n:param axis: the axis\n:param type: the type" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_1_1_2" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "dt", - "type": "wpimath.units.seconds" + "name": "count", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", - "functionName": "update", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setButtonCount", "returnType": "None", - "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, - { - "className": "wpilib.simulation.LinearSystemSim_2_1_1", - "classVariables": [], - "constructors": [ + "tooltip": "Set the button count of this device.\n\n:param count: the new button count" + }, { "args": [ { "defaultValue": "", - "name": "system", - "type": "wpimath.system.LinearSystem_2_1_1" + "name": "self", + "type": "wpilib.simulation.GenericHIDSim" }, - { - "defaultValue": "[0.0]", - "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(1)]" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", - "functionName": "__init__", - "returnType": "wpilib.simulation.LinearSystemSim_2_1_1", - "tooltip": "Creates a simulated generic linear system.\n\n:param system: The system to simulate.\n:param measurementStdDevs: The standard deviations of the measurements." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_1" + "name": "name", + "type": "str" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", - "functionName": "getInput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", - "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setName", + "returnType": "None", + "tooltip": "Set the name of this device.\n\n:param name: the new device name" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_1" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "row", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", - "functionName": "getInput", - "returnType": "float", - "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." - }, - { - "args": [ + "name": "pov", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_1" + "name": "value", + "type": "wpilib.DriverStation.POVDirection" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", - "functionName": "getOutput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", - "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setPOV", + "returnType": "None", + "tooltip": "Set the value of a given POV.\n\n:param pov: the POV to set\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_1" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "row", - "type": "int" + "name": "value", + "type": "wpilib.DriverStation.POVDirection" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", - "functionName": "getOutput", - "returnType": "float", - "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setPOV", + "returnType": "None", + "tooltip": "Set the value of the default POV (port 0).\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_1" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "name": "count", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", - "functionName": "setInput", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setPOVCount", "returnType": "None", - "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." + "tooltip": "Set the POV count of this device.\n\n:param count: the new POV count" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_1" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "row", - "type": "int" + "name": "axis", + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", - "functionName": "setInput", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setRawAxis", "returnType": "None", - "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." + "tooltip": "Set the value of a given axis.\n\n:param axis: the axis to set\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_1" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "state", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "name": "button", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", - "functionName": "setState", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setRawButton", "returnType": "None", - "tooltip": "Sets the system state.\n\n:param state: The new state." + "tooltip": "Set the value of a given button.\n\n:param button: the button to set\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_1" + "type": "wpilib.simulation.JoystickSim" }, { "defaultValue": "", - "name": "dt", - "type": "wpimath.units.seconds" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", - "functionName": "update", + "declaringClassName": "wpilib.simulation.JoystickSim", + "functionName": "setThrottle", "returnType": "None", - "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, - { - "className": "wpilib.simulation.LinearSystemSim_2_1_2", - "classVariables": [], - "constructors": [ + "tooltip": "Set the throttle value of the joystick.\n\n:param value: the new throttle value" + }, { "args": [ { "defaultValue": "", - "name": "system", - "type": "wpimath.system.LinearSystem_2_1_2" + "name": "self", + "type": "wpilib.simulation.JoystickSim" }, - { - "defaultValue": "[0.0, 0.0]", - "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(2)]" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", - "functionName": "__init__", - "returnType": "wpilib.simulation.LinearSystemSim_2_1_2", - "tooltip": "Creates a simulated generic linear system.\n\n:param system: The system to simulate.\n:param measurementStdDevs: The standard deviations of the measurements." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_2" + "name": "state", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", - "functionName": "getInput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", - "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." + "declaringClassName": "wpilib.simulation.JoystickSim", + "functionName": "setTop", + "returnType": "None", + "tooltip": "Set the top state of the joystick.\n\n:param state: the new state" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_2" + "type": "wpilib.simulation.JoystickSim" }, { "defaultValue": "", - "name": "row", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", - "functionName": "getInput", - "returnType": "float", - "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_2" + "name": "state", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", - "functionName": "getOutput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", - "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." + "declaringClassName": "wpilib.simulation.JoystickSim", + "functionName": "setTrigger", + "returnType": "None", + "tooltip": "Set the trigger value of the joystick.\n\n:param state: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_2" + "type": "wpilib.simulation.JoystickSim" }, { "defaultValue": "", - "name": "row", - "type": "int" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", - "functionName": "getOutput", - "returnType": "float", - "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." + "declaringClassName": "wpilib.simulation.JoystickSim", + "functionName": "setTwist", + "returnType": "None", + "tooltip": "Set the twist value of the joystick.\n\n:param value: the new twist value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_2" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "name": "type", + "type": "wpilib.interfaces.GenericHID.HIDType" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", - "functionName": "setInput", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setType", "returnType": "None", - "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." + "tooltip": "Set the type of this device.\n\n:param type: the new device type" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_2" - }, - { - "defaultValue": "", - "name": "row", - "type": "int" + "type": "wpilib.simulation.JoystickSim" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", - "functionName": "setInput", + "declaringClassName": "wpilib.simulation.JoystickSim", + "functionName": "setX", "returnType": "None", - "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." + "tooltip": "Set the X value of the joystick.\n\n:param value: the new X value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_2" + "type": "wpilib.simulation.JoystickSim" }, { "defaultValue": "", - "name": "state", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", - "functionName": "setState", + "declaringClassName": "wpilib.simulation.JoystickSim", + "functionName": "setY", "returnType": "None", - "tooltip": "Sets the system state.\n\n:param state: The new state." + "tooltip": "Set the Y value of the joystick.\n\n:param value: the new Y value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_1_2" + "type": "wpilib.simulation.JoystickSim" }, { "defaultValue": "", - "name": "dt", - "type": "wpimath.units.seconds" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", - "functionName": "update", + "declaringClassName": "wpilib.simulation.JoystickSim", + "functionName": "setZ", "returnType": "None", - "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." + "tooltip": "Set the Z value of the joystick.\n\n:param value: the new Z value" } ], "instanceVariables": [], @@ -58819,7 +39096,7 @@ "staticMethods": [] }, { - "className": "wpilib.simulation.LinearSystemSim_2_2_1", + "className": "wpilib.simulation.LinearSystemSim_1_1_1", "classVariables": [], "constructors": [ { @@ -58827,17 +39104,17 @@ { "defaultValue": "", "name": "system", - "type": "wpimath.system.LinearSystem_2_2_1" + "type": "wpimath.system.LinearSystem_1_1_1" }, { "defaultValue": "[0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(1)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(1)]" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", "functionName": "__init__", - "returnType": "wpilib.simulation.LinearSystemSim_2_2_1", + "returnType": "wpilib.simulation.LinearSystemSim_1_1_1", "tooltip": "Creates a simulated generic linear system.\n\n:param system: The system to simulate.\n:param measurementStdDevs: The standard deviations of the measurements." } ], @@ -58848,12 +39125,12 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_1" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", "functionName": "getInput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." }, { @@ -58861,15 +39138,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_1" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", "functionName": "getInput", "returnType": "float", "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." @@ -58879,12 +39156,12 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_1" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", "functionName": "getOutput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." }, { @@ -58892,15 +39169,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_1" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", "functionName": "getOutput", "returnType": "float", "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." @@ -58910,15 +39187,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_1" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", "functionName": "setInput", "returnType": "None", "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." @@ -58928,20 +39205,20 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_1" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", "functionName": "setInput", "returnType": "None", "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." @@ -58951,15 +39228,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_1" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", "name": "state", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", "functionName": "setState", "returnType": "None", "tooltip": "Sets the system state.\n\n:param state: The new state." @@ -58969,7 +39246,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_1" + "type": "wpilib.simulation.LinearSystemSim_1_1_1" }, { "defaultValue": "", @@ -58977,7 +39254,7 @@ "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1", "functionName": "update", "returnType": "None", "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." @@ -58988,7 +39265,7 @@ "staticMethods": [] }, { - "className": "wpilib.simulation.LinearSystemSim_2_2_2", + "className": "wpilib.simulation.LinearSystemSim_1_1_2", "classVariables": [], "constructors": [ { @@ -58996,17 +39273,17 @@ { "defaultValue": "", "name": "system", - "type": "wpimath.system.LinearSystem_2_2_2" + "type": "wpimath.system.LinearSystem_1_1_2" }, { "defaultValue": "[0.0, 0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(2)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(2)]" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", "functionName": "__init__", - "returnType": "wpilib.simulation.LinearSystemSim_2_2_2", + "returnType": "wpilib.simulation.LinearSystemSim_1_1_2", "tooltip": "Creates a simulated generic linear system.\n\n:param system: The system to simulate.\n:param measurementStdDevs: The standard deviations of the measurements." } ], @@ -59017,12 +39294,12 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_2" + "type": "wpilib.simulation.LinearSystemSim_1_1_2" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", "functionName": "getInput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." }, { @@ -59030,15 +39307,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_2" + "type": "wpilib.simulation.LinearSystemSim_1_1_2" }, { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", "functionName": "getInput", "returnType": "float", "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." @@ -59048,12 +39325,12 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_2" + "type": "wpilib.simulation.LinearSystemSim_1_1_2" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", "functionName": "getOutput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." }, { @@ -59061,15 +39338,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_2" + "type": "wpilib.simulation.LinearSystemSim_1_1_2" }, { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", "functionName": "getOutput", "returnType": "float", "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." @@ -59079,15 +39356,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_2" + "type": "wpilib.simulation.LinearSystemSim_1_1_2" }, { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", "functionName": "setInput", "returnType": "None", "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." @@ -59097,20 +39374,20 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_2" + "type": "wpilib.simulation.LinearSystemSim_1_1_2" }, { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", "functionName": "setInput", "returnType": "None", "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." @@ -59120,15 +39397,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_2" + "type": "wpilib.simulation.LinearSystemSim_1_1_2" }, { "defaultValue": "", "name": "state", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", "functionName": "setState", "returnType": "None", "tooltip": "Sets the system state.\n\n:param state: The new state." @@ -59138,7 +39415,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.LinearSystemSim_2_2_2" + "type": "wpilib.simulation.LinearSystemSim_1_1_2" }, { "defaultValue": "", @@ -59146,7 +39423,7 @@ "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2", "functionName": "update", "returnType": "None", "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." @@ -59157,34 +39434,26 @@ "staticMethods": [] }, { - "className": "wpilib.simulation.PS4ControllerSim", + "className": "wpilib.simulation.LinearSystemSim_2_1_1", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "joystick", - "type": "wpilib.PS4Controller" - } - ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.PS4ControllerSim", - "tooltip": "Constructs from a PS4Controller object.\n\n:param joystick: controller to simulate" - }, - { - "args": [ + "name": "system", + "type": "wpimath.system.LinearSystem_2_1_1" + }, { - "defaultValue": "", - "name": "port", - "type": "int" + "defaultValue": "[0.0]", + "name": "measurementStdDevs", + "type": "Annotated[list[typing.SupportsFloat], FixedSize(1)]" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", "functionName": "__init__", - "returnType": "wpilib.simulation.PS4ControllerSim", - "tooltip": "Constructs from a joystick port number.\n\n:param port: port number" + "returnType": "wpilib.simulation.LinearSystemSim_2_1_1", + "tooltip": "Creates a simulated generic linear system.\n\n:param system: The system to simulate.\n:param measurementStdDevs: The standard deviations of the measurements." } ], "enums": [], @@ -59194,622 +39463,646 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "outputNumber", - "type": "int" + "type": "wpilib.simulation.LinearSystemSim_2_1_1" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "getOutput", - "returnType": "bool", - "tooltip": "Read the output of a button.\n\n:param outputNumber: the button number\n\n:returns: the value of the button (true = pressed)" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", + "functionName": "getInput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_1" + }, + { + "defaultValue": "", + "name": "row", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "getOutputs", - "returnType": "int", - "tooltip": "Get the encoded 16-bit integer that passes button values.\n\n:returns: the button values" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", + "functionName": "getInput", + "returnType": "float", + "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.interfaces.GenericHID.RumbleType" + "type": "wpilib.simulation.LinearSystemSim_2_1_1" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "getRumble", - "returnType": "float", - "tooltip": "Get the joystick rumble.\n\n:param type: the rumble to read\n\n:returns: the rumble value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", + "functionName": "getOutput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_1" + }, + { + "defaultValue": "", + "name": "row", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "notifyNewData", - "returnType": "None", - "tooltip": "Updates joystick data so that new values are visible to the user program." + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", + "functionName": "getOutput", + "returnType": "float", + "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_1" }, { "defaultValue": "", - "name": "count", - "type": "int" + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setAxisCount", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", + "functionName": "setInput", "returnType": "None", - "tooltip": "Set the axis count of this device.\n\n:param count: the new axis count" + "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_1" }, { "defaultValue": "", - "name": "axis", - "type": "int" + "name": "row", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "type", - "type": "int" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setAxisType", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", + "functionName": "setInput", "returnType": "None", - "tooltip": "Set the type of an axis.\n\n:param axis: the axis\n:param type: the type" + "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_1" }, { "defaultValue": "", - "name": "count", - "type": "int" + "name": "state", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setButtonCount", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", + "functionName": "setState", "returnType": "None", - "tooltip": "Set the button count of this device.\n\n:param count: the new button count" + "tooltip": "Sets the system state.\n\n:param state: The new state." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_1" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "dt", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setCircleButton", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1", + "functionName": "update", "returnType": "None", - "tooltip": "Change the value of the circle button on the controller.\n\n:param value: the new value" - }, + "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." + } + ], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [] + }, + { + "className": "wpilib.simulation.LinearSystemSim_2_1_2", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "name": "system", + "type": "wpimath.system.LinearSystem_2_1_2" }, { - "defaultValue": "", - "name": "value", - "type": "bool" + "defaultValue": "[0.0, 0.0]", + "name": "measurementStdDevs", + "type": "Annotated[list[typing.SupportsFloat], FixedSize(2)]" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setCrossButton", - "returnType": "None", - "tooltip": "Change the value of the cross button on the controller.\n\n:param value: the new value" - }, + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", + "functionName": "__init__", + "returnType": "wpilib.simulation.LinearSystemSim_2_1_2", + "tooltip": "Creates a simulated generic linear system.\n\n:param system: The system to simulate.\n:param measurementStdDevs: The standard deviations of the measurements." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "bool" + "type": "wpilib.simulation.LinearSystemSim_2_1_2" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setL1Button", - "returnType": "None", - "tooltip": "Change the value of the left trigger 1 button on the controller.\n\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", + "functionName": "getInput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_2" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "row", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setL2Axis", - "returnType": "None", - "tooltip": "Change the value of the left trigger 2 axis on the controller.\n\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", + "functionName": "getInput", + "returnType": "float", + "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "bool" + "type": "wpilib.simulation.LinearSystemSim_2_1_2" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setL2Button", - "returnType": "None", - "tooltip": "Change the value of the left trigger 2 button on the controller.\n\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", + "functionName": "getOutput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", + "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_2" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "row", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setL3Button", - "returnType": "None", - "tooltip": "Change the value of the L3 (left stick) button on the controller.\n\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", + "functionName": "getOutput", + "returnType": "float", + "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_2" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setLeftX", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", + "functionName": "setInput", "returnType": "None", - "tooltip": "Change the left X value of the controller's joystick.\n\n:param value: the new value" + "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_2" + }, + { + "defaultValue": "", + "name": "row", + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setLeftY", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", + "functionName": "setInput", "returnType": "None", - "tooltip": "Change the left Y value of the controller's joystick.\n\n:param value: the new value" + "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_2" }, { "defaultValue": "", - "name": "name", - "type": "str" + "name": "state", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setName", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", + "functionName": "setState", "returnType": "None", - "tooltip": "Set the name of this device.\n\n:param name: the new device name" + "tooltip": "Sets the system state.\n\n:param state: The new state." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_1_2" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "dt", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setOptionsButton", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", + "functionName": "update", "returnType": "None", - "tooltip": "Change the value of the options button on the controller.\n\n:param value: the new value" - }, + "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." + } + ], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [] + }, + { + "className": "wpilib.simulation.LinearSystemSim_2_2_1", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "pov", - "type": "int" + "name": "system", + "type": "wpimath.system.LinearSystem_2_2_1" }, { - "defaultValue": "", - "name": "value", - "type": "int" + "defaultValue": "[0.0]", + "name": "measurementStdDevs", + "type": "Annotated[list[typing.SupportsFloat], FixedSize(1)]" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setPOV", - "returnType": "None", - "tooltip": "Set the value of a given POV.\n\n:param pov: the POV to set\n:param value: the new value" - }, + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "functionName": "__init__", + "returnType": "wpilib.simulation.LinearSystemSim_2_2_1", + "tooltip": "Creates a simulated generic linear system.\n\n:param system: The system to simulate.\n:param measurementStdDevs: The standard deviations of the measurements." + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "int" + "type": "wpilib.simulation.LinearSystemSim_2_2_1" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setPOV", - "returnType": "None", - "tooltip": "Set the value of the default POV (port 0).\n\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "functionName": "getInput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", + "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_1" }, { "defaultValue": "", - "name": "count", - "type": "int" + "name": "row", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setPOVCount", - "returnType": "None", - "tooltip": "Set the POV count of this device.\n\n:param count: the new POV count" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "functionName": "getInput", + "returnType": "float", + "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "bool" + "type": "wpilib.simulation.LinearSystemSim_2_2_1" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setPSButton", - "returnType": "None", - "tooltip": "Change the value of the PlayStation button on the controller.\n\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "functionName": "getOutput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_1" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "row", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setR1Button", - "returnType": "None", - "tooltip": "Change the value of the right trigger 1 button on the controller.\n\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "functionName": "getOutput", + "returnType": "float", + "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_1" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setR2Axis", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "functionName": "setInput", "returnType": "None", - "tooltip": "Change the value of the right trigger 2 axis on the controller.\n\n:param value: the new value" + "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_1" + }, + { + "defaultValue": "", + "name": "row", + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "bool" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setR2Button", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "functionName": "setInput", "returnType": "None", - "tooltip": "Change the value of the right trigger 2 button on the controller.\n\n:param value: the new value" + "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_1" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "state", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setR3Button", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "functionName": "setState", "returnType": "None", - "tooltip": "Change the value of the R3 (right stick) button on the controller.\n\n:param value: the new value" + "tooltip": "Sets the system state.\n\n:param state: The new state." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" - }, - { - "defaultValue": "", - "name": "axis", - "type": "int" + "type": "wpilib.simulation.LinearSystemSim_2_2_1" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "dt", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setRawAxis", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1", + "functionName": "update", "returnType": "None", - "tooltip": "Set the value of a given axis.\n\n:param axis: the axis to set\n:param value: the new value" - }, + "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." + } + ], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [] + }, + { + "className": "wpilib.simulation.LinearSystemSim_2_2_2", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "name": "system", + "type": "wpimath.system.LinearSystem_2_2_2" }, { - "defaultValue": "", - "name": "button", - "type": "int" - }, + "defaultValue": "[0.0, 0.0]", + "name": "measurementStdDevs", + "type": "Annotated[list[typing.SupportsFloat], FixedSize(2)]" + } + ], + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "functionName": "__init__", + "returnType": "wpilib.simulation.LinearSystemSim_2_2_2", + "tooltip": "Creates a simulated generic linear system.\n\n:param system: The system to simulate.\n:param measurementStdDevs: The standard deviations of the measurements." + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "self", + "type": "wpilib.simulation.LinearSystemSim_2_2_2" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setRawButton", - "returnType": "None", - "tooltip": "Set the value of a given button.\n\n:param button: the button to set\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "functionName": "getInput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", + "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_2" }, { "defaultValue": "", - "name": "value", - "type": "float" + "name": "row", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setRightX", - "returnType": "None", - "tooltip": "Change the right X value of the controller's joystick.\n\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "functionName": "getInput", + "returnType": "float", + "tooltip": "Returns an element of the current input of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current input of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "float" + "type": "wpilib.simulation.LinearSystemSim_2_2_2" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setRightY", - "returnType": "None", - "tooltip": "Change the right Y value of the controller's joystick.\n\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "functionName": "getOutput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", + "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_2" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "row", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setShareButton", - "returnType": "None", - "tooltip": "Change the value of the share button on the controller.\n\n:param value: the new value" + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "functionName": "getOutput", + "returnType": "float", + "tooltip": "Returns an element of the current output of the plant.\n\n:param row: The row to return.\n\n:returns: An element of the current output of the plant." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_2" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setSquareButton", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "functionName": "setInput", "returnType": "None", - "tooltip": "Change the value of the square button on the controller.\n\n:param value: the new value" + "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_2" + }, + { + "defaultValue": "", + "name": "row", + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "bool" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setTouchpadButton", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "functionName": "setInput", "returnType": "None", - "tooltip": "Change the value of the touchpad button on the controller.\n\n:param value: the new value" + "tooltip": "Sets the system inputs.\n\n:param row: The row in the input matrix to set.\n:param value: The value to set the row to." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS4ControllerSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_2" }, { "defaultValue": "", - "name": "value", - "type": "bool" + "name": "state", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpilib.simulation.PS4ControllerSim", - "functionName": "setTriangleButton", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "functionName": "setState", "returnType": "None", - "tooltip": "Change the value of the triangle button on the controller.\n\n:param value: the new value" + "tooltip": "Sets the system state.\n\n:param state: The new state." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.GenericHIDSim" + "type": "wpilib.simulation.LinearSystemSim_2_2_2" }, { "defaultValue": "", - "name": "type", - "type": "wpilib.interfaces.GenericHID.HIDType" + "name": "dt", + "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpilib.simulation.GenericHIDSim", - "functionName": "setType", + "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2", + "functionName": "update", "returnType": "None", - "tooltip": "Set the type of this device.\n\n:param type: the new device type" + "tooltip": "Updates the simulation.\n\n:param dt: The time between updates." } ], "instanceVariables": [], @@ -59817,7 +40110,7 @@ "staticMethods": [] }, { - "className": "wpilib.simulation.PS5ControllerSim", + "className": "wpilib.simulation.PS4ControllerSim", "classVariables": [], "constructors": [ { @@ -59825,25 +40118,25 @@ { "defaultValue": "", "name": "joystick", - "type": "wpilib.PS5Controller" + "type": "wpilib.PS4Controller" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "__init__", - "returnType": "wpilib.simulation.PS5ControllerSim", - "tooltip": "Constructs from a PS5Controller object.\n\n:param joystick: controller to simulate" + "returnType": "wpilib.simulation.PS4ControllerSim", + "tooltip": "Constructs from a PS4Controller object.\n\n:param joystick: controller to simulate" }, { "args": [ { "defaultValue": "", "name": "port", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "__init__", - "returnType": "wpilib.simulation.PS5ControllerSim", + "returnType": "wpilib.simulation.PS4ControllerSim", "tooltip": "Constructs from a joystick port number.\n\n:param port: port number" } ], @@ -59859,7 +40152,7 @@ { "defaultValue": "", "name": "outputNumber", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -59921,7 +40214,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -59939,12 +40232,12 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "type", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -59962,7 +40255,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -59975,7 +40268,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -59983,7 +40276,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setCircleButton", "returnType": "None", "tooltip": "Change the value of the circle button on the controller.\n\n:param value: the new value" @@ -59993,25 +40286,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" - }, - { - "defaultValue": "", - "name": "value", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", - "functionName": "setCreateButton", - "returnType": "None", - "tooltip": "Change the value of the create button on the controller.\n\n:param value: the new value" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60019,7 +40294,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setCrossButton", "returnType": "None", "tooltip": "Change the value of the cross button on the controller.\n\n:param value: the new value" @@ -60029,7 +40304,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60037,7 +40312,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setL1Button", "returnType": "None", "tooltip": "Change the value of the left trigger 1 button on the controller.\n\n:param value: the new value" @@ -60047,15 +40322,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setL2Axis", "returnType": "None", "tooltip": "Change the value of the left trigger 2 axis on the controller.\n\n:param value: the new value" @@ -60065,7 +40340,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60073,7 +40348,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setL2Button", "returnType": "None", "tooltip": "Change the value of the left trigger 2 button on the controller.\n\n:param value: the new value" @@ -60083,7 +40358,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60091,7 +40366,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setL3Button", "returnType": "None", "tooltip": "Change the value of the L3 (left stick) button on the controller.\n\n:param value: the new value" @@ -60101,15 +40376,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setLeftX", "returnType": "None", "tooltip": "Change the left X value of the controller's joystick.\n\n:param value: the new value" @@ -60119,15 +40394,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setLeftY", "returnType": "None", "tooltip": "Change the left Y value of the controller's joystick.\n\n:param value: the new value" @@ -60155,7 +40430,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60163,7 +40438,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setOptionsButton", "returnType": "None", "tooltip": "Change the value of the options button on the controller.\n\n:param value: the new value" @@ -60178,12 +40453,12 @@ { "defaultValue": "", "name": "pov", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -60201,7 +40476,7 @@ { "defaultValue": "", "name": "value", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -60219,7 +40494,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -60232,7 +40507,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60240,7 +40515,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setPSButton", "returnType": "None", "tooltip": "Change the value of the PlayStation button on the controller.\n\n:param value: the new value" @@ -60250,7 +40525,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60258,7 +40533,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setR1Button", "returnType": "None", "tooltip": "Change the value of the right trigger 1 button on the controller.\n\n:param value: the new value" @@ -60268,15 +40543,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setR2Axis", "returnType": "None", "tooltip": "Change the value of the right trigger 2 axis on the controller.\n\n:param value: the new value" @@ -60286,7 +40561,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60294,7 +40569,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setR2Button", "returnType": "None", "tooltip": "Change the value of the right trigger 2 button on the controller.\n\n:param value: the new value" @@ -60304,7 +40579,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60312,7 +40587,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setR3Button", "returnType": "None", "tooltip": "Change the value of the R3 (right stick) button on the controller.\n\n:param value: the new value" @@ -60327,12 +40602,12 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -60350,7 +40625,7 @@ { "defaultValue": "", "name": "button", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -60368,15 +40643,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setRightX", "returnType": "None", "tooltip": "Change the right X value of the controller's joystick.\n\n:param value: the new value" @@ -60386,15 +40661,15 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setRightY", "returnType": "None", "tooltip": "Change the right Y value of the controller's joystick.\n\n:param value: the new value" @@ -60404,7 +40679,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60412,7 +40687,25 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", + "functionName": "setShareButton", + "returnType": "None", + "tooltip": "Change the value of the share button on the controller.\n\n:param value: the new value" + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.simulation.PS4ControllerSim" + }, + { + "defaultValue": "", + "name": "value", + "type": "bool" + } + ], + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setSquareButton", "returnType": "None", "tooltip": "Change the value of the square button on the controller.\n\n:param value: the new value" @@ -60422,7 +40715,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60430,7 +40723,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setTouchpadButton", "returnType": "None", "tooltip": "Change the value of the touchpad button on the controller.\n\n:param value: the new value" @@ -60440,7 +40733,7 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PS5ControllerSim" + "type": "wpilib.simulation.PS4ControllerSim" }, { "defaultValue": "", @@ -60448,7 +40741,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "declaringClassName": "wpilib.simulation.PS4ControllerSim", "functionName": "setTriangleButton", "returnType": "None", "tooltip": "Change the value of the triangle button on the controller.\n\n:param value: the new value" @@ -60477,47 +40770,34 @@ "staticMethods": [] }, { - "className": "wpilib.simulation.PWMSim", + "className": "wpilib.simulation.PS5ControllerSim", "classVariables": [], "constructors": [ { "args": [ { "defaultValue": "", - "name": "pwm", - "type": "wpilib.PWM" - } - ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.PWMSim", - "tooltip": "Constructs from a PWM object.\n\n:param pwm: PWM to simulate" - }, - { - "args": [ - { - "defaultValue": "", - "name": "motorctrl", - "type": "wpilib.PWMMotorController" + "name": "joystick", + "type": "wpilib.PS5Controller" } ], - "declaringClassName": "wpilib.simulation.PWMSim", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", "functionName": "__init__", - "returnType": "wpilib.simulation.PWMSim", - "tooltip": "Constructs from a PWMMotorController object.\n\n:param motorctrl: PWMMotorController to simulate" + "returnType": "wpilib.simulation.PS5ControllerSim", + "tooltip": "Constructs from a PS5Controller object.\n\n:param joystick: controller to simulate" }, { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "port", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PWMSim", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", "functionName": "__init__", - "returnType": "wpilib.simulation.PWMSim", - "tooltip": "Constructs from a PWM channel number.\n\n:param channel: Channel number" + "returnType": "wpilib.simulation.PS5ControllerSim", + "tooltip": "Constructs from a joystick port number.\n\n:param port: port number" } ], "enums": [], @@ -60527,758 +40807,657 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.GenericHIDSim" + }, + { + "defaultValue": "", + "name": "outputNumber", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "getInitialized", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "getOutput", "returnType": "bool", - "tooltip": "Check whether the PWM has been initialized.\n\n:returns: true if initialized" + "tooltip": "Read the output of a button.\n\n:param outputNumber: the button number\n\n:returns: the value of the button (true = pressed)" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.GenericHIDSim" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "getPeriodScale", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "getOutputs", "returnType": "int", - "tooltip": "Get the PWM period scale.\n\n:returns: the PWM period scale" + "tooltip": "Get the encoded 16-bit integer that passes button values.\n\n:returns: the button values" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.GenericHIDSim" + }, + { + "defaultValue": "", + "name": "type", + "type": "wpilib.interfaces.GenericHID.RumbleType" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "getPosition", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "getRumble", "returnType": "float", - "tooltip": "Get the PWM position.\n\n:returns: the PWM position (0.0 to 1.0)" + "tooltip": "Get the joystick rumble.\n\n:param type: the rumble to read\n\n:returns: the rumble value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.GenericHIDSim" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "getPulseMicrosecond", - "returnType": "int", - "tooltip": "Get the PWM pulse microsecond value.\n\n:returns: the PWM pulse microsecond value" + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "notifyNewData", + "returnType": "None", + "tooltip": "Updates joystick data so that new values are visible to the user program." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" - } - ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "getSpeed", - "returnType": "float", - "tooltip": "Get the PWM speed.\n\n:returns: the PWM speed (-1.0 to 1.0)" - }, - { - "args": [ + "type": "wpilib.simulation.GenericHIDSim" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.PWMSim" + "name": "count", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "getZeroLatch", - "returnType": "bool", - "tooltip": "Check whether the PWM is zero latched.\n\n:returns: true if zero latched" + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setAxisCount", + "returnType": "None", + "tooltip": "Set the axis count of this device.\n\n:param count: the new axis count" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "name": "axis", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "type", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "registerInitializedCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the PWM is initialized.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setAxisType", + "returnType": "None", + "tooltip": "Set the type of an axis.\n\n:param axis: the axis\n:param type: the type" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "count", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "registerPeriodScaleCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the PWM period scale changes.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setButtonCount", + "returnType": "None", + "tooltip": "Set the button count of this device.\n\n:param count: the new button count" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "initialNotify", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "registerPositionCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the PWM position changes.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setCircleButton", + "returnType": "None", + "tooltip": "Change the value of the circle button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "initialNotify", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "registerPulseMicrosecondCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the PWM pulse microsecond value changes.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setCreateButton", + "returnType": "None", + "tooltip": "Change the value of the create button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "initialNotify", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "registerSpeedCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the PWM speed changes.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setCrossButton", + "returnType": "None", + "tooltip": "Change the value of the cross button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "initialNotify", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "registerZeroLatchCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the PWM zero latch state changes.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setL1Button", + "returnType": "None", + "tooltip": "Change the value of the left trigger 1 button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.PS5ControllerSim" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "resetData", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setL2Axis", "returnType": "None", - "tooltip": "Reset all simulation data." + "tooltip": "Change the value of the left trigger 2 axis on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "initialized", + "name": "value", "type": "bool" } - ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "setInitialized", + ], + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setL2Button", "returnType": "None", - "tooltip": "Define whether the PWM has been initialized.\n\n:param initialized: whether this object is initialized" + "tooltip": "Change the value of the left trigger 2 button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "periodScale", - "type": "int" + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "setPeriodScale", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setL3Button", "returnType": "None", - "tooltip": "Set the PWM period scale.\n\n:param periodScale: the PWM period scale" + "tooltip": "Change the value of the L3 (left stick) button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "position", - "type": "float" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "setPosition", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setLeftX", "returnType": "None", - "tooltip": "Set the PWM position.\n\n:param position: the PWM position (0.0 to 1.0)" + "tooltip": "Change the left X value of the controller's joystick.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "microsecondPulseTime", - "type": "int" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "setPulseMicrosecond", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setLeftY", "returnType": "None", - "tooltip": "Set the PWM pulse microsecond value.\n\n:param microsecondPulseTime: the PWM pulse microsecond value" + "tooltip": "Change the left Y value of the controller's joystick.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "speed", - "type": "float" + "name": "name", + "type": "str" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "setSpeed", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setName", "returnType": "None", - "tooltip": "Set the PWM speed.\n\n:param speed: the PWM speed (-1.0 to 1.0)" + "tooltip": "Set the name of this device.\n\n:param name: the new device name" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PWMSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "zeroLatch", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PWMSim", - "functionName": "setZeroLatch", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setOptionsButton", "returnType": "None", - "tooltip": "Define whether the PWM has been zero latched.\n\n:param zeroLatch: true to indicate zero latched" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, - { - "className": "wpilib.simulation.PneumaticsBaseSim", - "classVariables": [], - "constructors": [ + "tooltip": "Change the value of the options button on the controller.\n\n:param value: the new value" + }, { "args": [ { "defaultValue": "", - "name": "index", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.PneumaticsBaseSim", - "tooltip": "Constructs a PneumaticsBaseSim with the given index.\n\n:param index: The index." - }, - { - "args": [ + "name": "self", + "type": "wpilib.simulation.GenericHIDSim" + }, { "defaultValue": "", - "name": "module", - "type": "wpilib.PneumaticsBase" - } - ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.PneumaticsBaseSim", - "tooltip": "Constructs a PneumaticsBaseSim for the given module.\n\n:param module: The module." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ + "name": "pov", + "type": "typing.SupportsInt" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "name": "value", + "type": "wpilib.DriverStation.POVDirection" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "getAllSolenoidOutputs", - "returnType": "int", - "tooltip": "Get the current value of all solenoid outputs.\n\n:returns: the solenoid outputs (1 bit per output)" + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setPOV", + "returnType": "None", + "tooltip": "Set the value of a given POV.\n\n:param pov: the POV to set\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" - } - ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "getCompressorCurrent", - "returnType": "float", - "tooltip": "Read the compressor current.\n\n:returns: the current of the compressor connected to this module" - }, - { - "args": [ + "type": "wpilib.simulation.GenericHIDSim" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "name": "value", + "type": "wpilib.DriverStation.POVDirection" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "getCompressorOn", - "returnType": "bool", - "tooltip": "Check if the compressor is on.\n\n:returns: true if the compressor is active" + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setPOV", + "returnType": "None", + "tooltip": "Set the value of the default POV (port 0).\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "type": "wpilib.simulation.GenericHIDSim" + }, + { + "defaultValue": "", + "name": "count", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "getInitialized", - "returnType": "bool", - "tooltip": "Check whether the PCM/PH has been initialized.\n\n:returns: true if initialized" + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setPOVCount", + "returnType": "None", + "tooltip": "Set the POV count of this device.\n\n:param count: the new POV count" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "type": "wpilib.simulation.PS5ControllerSim" + }, + { + "defaultValue": "", + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "getPressureSwitch", - "returnType": "bool", - "tooltip": "Check the value of the pressure switch.\n\n:returns: the pressure switch value" + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setPSButton", + "returnType": "None", + "tooltip": "Change the value of the PlayStation button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "value", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "getSolenoidOutput", - "returnType": "bool", - "tooltip": "Check the solenoid output on a specific channel.\n\n:param channel: the channel to check\n\n:returns: the solenoid output" + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setR1Button", + "returnType": "None", + "tooltip": "Change the value of the right trigger 1 button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "registerCompressorCurrentCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the compressor current changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the :class:`.CallbackStore` object associated with this callback.\n Save a reference to this object; it being deconstructed cancels the\n callback." + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setR2Axis", + "returnType": "None", + "tooltip": "Change the value of the right trigger 2 axis on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "initialNotify", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "registerCompressorOnCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the compressor activates.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the :class:`.CallbackStore` object associated with this callback.\n Save a reference to this object; it being deconstructed cancels the\n callback." + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setR2Button", + "returnType": "None", + "tooltip": "Change the value of the right trigger 2 button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "initialNotify", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "registerInitializedCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the PCM/PH is initialized.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the :class:`.CallbackStore` object associated with this callback.\n Save a reference to this object; it being deconstructed cancels the\n callback." + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setR3Button", + "returnType": "None", + "tooltip": "Change the value of the R3 (right stick) button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "name": "axis", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "registerPressureSwitchCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the pressure switch value changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the initial\n value\n\n:returns: the :class:`.CallbackStore` object associated with this callback.\n Save a reference to this object; it being deconstructed cancels the\n callback." + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setRawAxis", + "returnType": "None", + "tooltip": "Set the value of a given axis.\n\n:param axis: the axis to set\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "name": "button", + "type": "typing.SupportsInt" }, { "defaultValue": "", - "name": "initialNotify", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "registerSolenoidOutputCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the solenoid output on a channel\nchanges.\n\n:param channel: the channel to monitor\n:param callback: the callback\n:param initialNotify: should the callback be run with the initial value\n\n:returns: the :class:`.CallbackStore` object associated with this callback.\n Save a reference to this object; it being deconstructed cancels the\n callback." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" - } - ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "resetData", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setRawButton", "returnType": "None", - "tooltip": "Reset all simulation data for this object." + "tooltip": "Set the value of a given button.\n\n:param button: the button to set\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "outputs", - "type": "int" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "setAllSolenoidOutputs", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setRightX", "returnType": "None", - "tooltip": "Change all of the solenoid outputs.\n\n:param outputs: the new solenoid outputs (1 bit per output)" + "tooltip": "Change the right X value of the controller's joystick.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "compressorCurrent", - "type": "float" + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "setCompressorCurrent", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setRightY", "returnType": "None", - "tooltip": "Set the compressor current.\n\n:param compressorCurrent: the new compressor current" + "tooltip": "Change the right Y value of the controller's joystick.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "compressorOn", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "setCompressorOn", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setSquareButton", "returnType": "None", - "tooltip": "Set whether the compressor is active.\n\n:param compressorOn: the new value" + "tooltip": "Change the value of the square button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "initialized", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "setInitialized", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setTouchpadButton", "returnType": "None", - "tooltip": "Define whether the PCM/PH has been initialized.\n\n:param initialized: true for initialized" + "tooltip": "Change the value of the touchpad button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" + "type": "wpilib.simulation.PS5ControllerSim" }, { "defaultValue": "", - "name": "pressureSwitch", + "name": "value", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "setPressureSwitch", + "declaringClassName": "wpilib.simulation.PS5ControllerSim", + "functionName": "setTriangleButton", "returnType": "None", - "tooltip": "Set the value of the pressure switch.\n\n:param pressureSwitch: the new value" + "tooltip": "Change the value of the triangle button on the controller.\n\n:param value: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PneumaticsBaseSim" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" + "type": "wpilib.simulation.GenericHIDSim" }, { "defaultValue": "", - "name": "solenoidOutput", - "type": "bool" + "name": "type", + "type": "wpilib.interfaces.GenericHID.HIDType" } ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "setSolenoidOutput", + "declaringClassName": "wpilib.simulation.GenericHIDSim", + "functionName": "setType", "returnType": "None", - "tooltip": "Change the solenoid output on a specific channel.\n\n:param channel: the channel to check\n:param solenoidOutput: the new solenoid output" + "tooltip": "Set the type of this device.\n\n:param type: the new device type" } ], "instanceVariables": [], "moduleName": "wpilib.simulation", - "staticMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "module", - "type": "int" - }, - { - "defaultValue": "", - "name": "type", - "type": "wpilib.PneumaticsModuleType" - } - ], - "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", - "functionName": "getForType", - "returnType": "wpilib.simulation.PneumaticsBaseSim", - "tooltip": "" - } - ] + "staticMethods": [] }, { - "className": "wpilib.simulation.PowerDistributionSim", + "className": "wpilib.simulation.PWMMotorControllerSim", "classVariables": [], "constructors": [ { "args": [ { - "defaultValue": "0", - "name": "module", - "type": "int" + "defaultValue": "", + "name": "motorctrl", + "type": "wpilib.PWMMotorController" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "declaringClassName": "wpilib.simulation.PWMMotorControllerSim", "functionName": "__init__", - "returnType": "wpilib.simulation.PowerDistributionSim", - "tooltip": "Constructs from a PowerDistribution module number (CAN ID).\n\n:param module: module number" + "returnType": "wpilib.simulation.PWMMotorControllerSim", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "pdp", - "type": "wpilib.PowerDistribution" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "declaringClassName": "wpilib.simulation.PWMMotorControllerSim", "functionName": "__init__", - "returnType": "wpilib.simulation.PowerDistributionSim", - "tooltip": "Constructs from a PowerDistribution object.\n\n:param pdp: PowerDistribution to simulate" + "returnType": "wpilib.simulation.PWMMotorControllerSim", + "tooltip": "" } ], "enums": [], @@ -61288,110 +41467,97 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" - }, - { - "defaultValue": "", - "name": "length", - "type": "int" + "type": "wpilib.simulation.PWMMotorControllerSim" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "getAllCurrents", + "declaringClassName": "wpilib.simulation.PWMMotorControllerSim", + "functionName": "getSpeed", "returnType": "float", - "tooltip": "Read the current of all of the PowerDistribution channels.\n\n:param currents: output array; set to the current in each channel. The\n array must be big enough to hold all the PowerDistribution\n channels\n:param length: length of output array" - }, + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [] + }, + { + "className": "wpilib.simulation.PWMSim", + "classVariables": [], + "constructors": [ { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" + "name": "pwm", + "type": "wpilib.PWM" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "getCurrent", - "returnType": "float", - "tooltip": "Read the current in one of the PowerDistribution channels.\n\n:param channel: the channel to check\n\n:returns: the current in the given channel" + "declaringClassName": "wpilib.simulation.PWMSim", + "functionName": "__init__", + "returnType": "wpilib.simulation.PWMSim", + "tooltip": "Constructs from a PWM object.\n\n:param pwm: PWM to simulate" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "getInitialized", - "returnType": "bool", - "tooltip": "Check whether the PowerDistribution has been initialized.\n\n:returns: true if initialized" - }, + "declaringClassName": "wpilib.simulation.PWMSim", + "functionName": "__init__", + "returnType": "wpilib.simulation.PWMSim", + "tooltip": "Constructs from a PWM channel number.\n\n:param channel: Channel number" + } + ], + "enums": [], + "instanceMethods": [ { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" + "type": "wpilib.simulation.PWMSim" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "getTemperature", - "returnType": "float", - "tooltip": "Check the temperature of the PowerDistribution.\n\n:returns: the PowerDistribution temperature" + "declaringClassName": "wpilib.simulation.PWMSim", + "functionName": "getInitialized", + "returnType": "bool", + "tooltip": "Check whether the PWM has been initialized.\n\n:returns: true if initialized" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" + "type": "wpilib.simulation.PWMSim" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "getVoltage", - "returnType": "float", - "tooltip": "Check the PowerDistribution voltage.\n\n:returns: the PowerDistribution voltage." + "declaringClassName": "wpilib.simulation.PWMSim", + "functionName": "getOutputPeriod", + "returnType": "int", + "tooltip": "Get the PWM period scale.\n\n:returns: the PWM period scale" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "type": "wpilib.simulation.PWMSim" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "registerCurrentCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the current of a specific channel\nchanges.\n\n:param channel: the channel\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.PWMSim", + "functionName": "getPulseMicrosecond", + "returnType": "int", + "tooltip": "Get the PWM pulse microsecond value.\n\n:returns: the PWM pulse microsecond value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" + "type": "wpilib.simulation.PWMSim" }, { "defaultValue": "", @@ -61404,40 +41570,17 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "declaringClassName": "wpilib.simulation.PWMSim", "functionName": "registerInitializedCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the PowerDistribution is initialized.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "registerTemperatureCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the PowerDistribution temperature\nchanges.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback to be run when the PWM is initialized.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" + "type": "wpilib.simulation.PWMSim" }, { "defaultValue": "", @@ -61450,76 +41593,53 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "registerVoltageCallback", + "declaringClassName": "wpilib.simulation.PWMSim", + "functionName": "registerOutputPeriodCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the PowerDistribution voltage\nchanges.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" - } - ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "resetData", - "returnType": "None", - "tooltip": "Reset all PowerDistribution simulation data." + "tooltip": "Register a callback to be run when the PWM period scale changes.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" + "type": "wpilib.simulation.PWMSim" }, { "defaultValue": "", - "name": "currents", - "type": "float" + "name": "callback", + "type": "Callable[[str, hal.Value], None]" }, { "defaultValue": "", - "name": "length", - "type": "int" + "name": "initialNotify", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "setAllCurrents", - "returnType": "None", - "tooltip": "Change the current in all of the PowerDistribution channels.\n\n:param currents: array containing the current values for each channel. The\n array must be big enough to hold all the PowerDistribution\n channels\n:param length: length of array" + "declaringClassName": "wpilib.simulation.PWMSim", + "functionName": "registerPulseMicrosecondCallback", + "returnType": "wpilib.simulation.CallbackStore", + "tooltip": "Register a callback to be run when the PWM pulse microsecond value changes.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" - }, - { - "defaultValue": "", - "name": "channel", - "type": "int" - }, - { - "defaultValue": "", - "name": "current", - "type": "float" + "type": "wpilib.simulation.PWMSim" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "setCurrent", + "declaringClassName": "wpilib.simulation.PWMSim", + "functionName": "resetData", "returnType": "None", - "tooltip": "Change the current in the given channel.\n\n:param channel: the channel to edit\n:param current: the new current for the channel" + "tooltip": "Reset all simulation data." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" + "type": "wpilib.simulation.PWMSim" }, { "defaultValue": "", @@ -61527,46 +41647,46 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "declaringClassName": "wpilib.simulation.PWMSim", "functionName": "setInitialized", "returnType": "None", - "tooltip": "Define whether the PowerDistribution has been initialized.\n\n:param initialized: whether this object is initialized" + "tooltip": "Define whether the PWM has been initialized.\n\n:param initialized: whether this object is initialized" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" + "type": "wpilib.simulation.PWMSim" }, { "defaultValue": "", - "name": "temperature", - "type": "float" + "name": "period", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "setTemperature", + "declaringClassName": "wpilib.simulation.PWMSim", + "functionName": "setOutputPeriod", "returnType": "None", - "tooltip": "Define the PowerDistribution temperature.\n\n:param temperature: the new PowerDistribution temperature" + "tooltip": "Set the PWM period scale.\n\n:param period: the PWM period scale" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.PowerDistributionSim" + "type": "wpilib.simulation.PWMSim" }, { "defaultValue": "", - "name": "voltage", - "type": "float" + "name": "microsecondPulseTime", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.PowerDistributionSim", - "functionName": "setVoltage", + "declaringClassName": "wpilib.simulation.PWMSim", + "functionName": "setPulseMicrosecond", "returnType": "None", - "tooltip": "Set the PowerDistribution voltage.\n\n:param voltage: the new PowerDistribution voltage" + "tooltip": "Set the PWM pulse microsecond value.\n\n:param microsecondPulseTime: the PWM pulse microsecond value" } ], "instanceVariables": [], @@ -61574,41 +41694,34 @@ "staticMethods": [] }, { - "className": "wpilib.simulation.REVPHSim", + "className": "wpilib.simulation.PneumaticsBaseSim", "classVariables": [], "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.simulation.REVPHSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.REVPHSim", - "tooltip": "Constructs with the default PCM module number (CAN ID)." - }, { "args": [ { "defaultValue": "", - "name": "module", - "type": "int" + "name": "index", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "__init__", - "returnType": "wpilib.simulation.REVPHSim", - "tooltip": "Constructs from a PCM module number (CAN ID).\n\n:param module: module number" + "returnType": "wpilib.simulation.PneumaticsBaseSim", + "tooltip": "Constructs a PneumaticsBaseSim with the given index.\n\n:param index: The index." }, { "args": [ { "defaultValue": "", - "name": "pneumatics", + "name": "module", "type": "wpilib.PneumaticsBase" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "__init__", - "returnType": "wpilib.simulation.REVPHSim", - "tooltip": "" + "returnType": "wpilib.simulation.PneumaticsBaseSim", + "tooltip": "Constructs a PneumaticsBaseSim for the given module.\n\n:param module: The module." } ], "enums": [], @@ -61618,49 +41731,36 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "getAllSolenoidOutputs", "returnType": "int", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.REVPHSim" - } - ], - "declaringClassName": "wpilib.simulation.REVPHSim", - "functionName": "getCompressorConfigType", - "returnType": "int", - "tooltip": "Check whether the closed loop compressor control is active.\n\n:returns: compressor config type" + "tooltip": "Get the current value of all solenoid outputs.\n\n:returns: the solenoid outputs (1 bit per output)" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "getCompressorCurrent", "returnType": "float", - "tooltip": "" + "tooltip": "Read the compressor current.\n\n:returns: the current of the compressor connected to this module" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "getCompressorOn", "returnType": "bool", "tooltip": "Check if the compressor is on.\n\n:returns: true if the compressor is active" @@ -61670,74 +41770,51 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "getInitialized", "returnType": "bool", - "tooltip": "" + "tooltip": "Check whether the PCM/PH has been initialized.\n\n:returns: true if initialized" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "getPressureSwitch", "returnType": "bool", - "tooltip": "" + "tooltip": "Check the value of the pressure switch.\n\n:returns: the pressure switch value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "getSolenoidOutput", "returnType": "bool", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.REVPHSim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.REVPHSim", - "functionName": "registerCompressorConfigTypeCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the closed loop state changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Check the solenoid output on a specific channel.\n\n:param channel: the channel to check\n\n:returns: the solenoid output" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", @@ -61750,17 +41827,17 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "registerCompressorCurrentCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "" + "tooltip": "Register a callback to be run whenever the compressor current changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the :class:`.CallbackStore` object associated with this callback.\n Save a reference to this object; it being deconstructed cancels the\n callback." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", @@ -61773,17 +41850,17 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "registerCompressorOnCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "" + "tooltip": "Register a callback to be run when the compressor activates.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the :class:`.CallbackStore` object associated with this callback.\n Save a reference to this object; it being deconstructed cancels the\n callback." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", @@ -61796,17 +41873,17 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "registerInitializedCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "" + "tooltip": "Register a callback to be run when the PCM/PH is initialized.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the :class:`.CallbackStore` object associated with this callback.\n Save a reference to this object; it being deconstructed cancels the\n callback." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", @@ -61819,22 +41896,22 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "registerPressureSwitchCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "" + "tooltip": "Register a callback to be run whenever the pressure switch value changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the initial\n value\n\n:returns: the :class:`.CallbackStore` object associated with this callback.\n Save a reference to this object; it being deconstructed cancels the\n callback." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -61847,84 +41924,66 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "registerSolenoidOutputCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "" + "tooltip": "Register a callback to be run when the solenoid output on a channel\nchanges.\n\n:param channel: the channel to monitor\n:param callback: the callback\n:param initialNotify: should the callback be run with the initial value\n\n:returns: the :class:`.CallbackStore` object associated with this callback.\n Save a reference to this object; it being deconstructed cancels the\n callback." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "resetData", "returnType": "None", - "tooltip": "" + "tooltip": "Reset all simulation data for this object." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", "name": "outputs", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "setAllSolenoidOutputs", "returnType": "None", - "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.REVPHSim" - }, - { - "defaultValue": "", - "name": "compressorConfigType", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.REVPHSim", - "functionName": "setCompressorConfigType", - "returnType": "None", - "tooltip": "Turn on/off the closed loop control of the compressor.\n\n:param compressorConfigType: compressor config type" + "tooltip": "Change all of the solenoid outputs.\n\n:param outputs: the new solenoid outputs (1 bit per output)" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", "name": "compressorCurrent", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "setCompressorCurrent", "returnType": "None", - "tooltip": "" + "tooltip": "Set the compressor current.\n\n:param compressorCurrent: the new compressor current" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", @@ -61932,7 +41991,7 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "setCompressorOn", "returnType": "None", "tooltip": "Set whether the compressor is active.\n\n:param compressorOn: the new value" @@ -61942,25 +42001,25 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", - "name": "solenoidInitialized", + "name": "initialized", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "setInitialized", "returnType": "None", - "tooltip": "" + "tooltip": "Define whether the PCM/PH has been initialized.\n\n:param initialized: true for initialized" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", @@ -61968,22 +42027,22 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "setPressureSwitch", "returnType": "None", - "tooltip": "" + "tooltip": "Set the value of the pressure switch.\n\n:param pressureSwitch: the new value" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.REVPHSim" + "type": "wpilib.simulation.PneumaticsBaseSim" }, { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -61991,10 +42050,10 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "setSolenoidOutput", "returnType": "None", - "tooltip": "" + "tooltip": "Change the solenoid output on a specific channel.\n\n:param channel: the channel to check\n:param solenoidOutput: the new solenoid output" } ], "instanceVariables": [], @@ -62005,7 +42064,7 @@ { "defaultValue": "", "name": "module", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -62013,7 +42072,7 @@ "type": "wpilib.PneumaticsModuleType" } ], - "declaringClassName": "wpilib.simulation.REVPHSim", + "declaringClassName": "wpilib.simulation.PneumaticsBaseSim", "functionName": "getForType", "returnType": "wpilib.simulation.PneumaticsBaseSim", "tooltip": "" @@ -62021,34 +42080,34 @@ ] }, { - "className": "wpilib.simulation.RelaySim", + "className": "wpilib.simulation.PowerDistributionSim", "classVariables": [], "constructors": [ { "args": [ { - "defaultValue": "", - "name": "relay", - "type": "wpilib.Relay" + "defaultValue": "0", + "name": "module", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.RelaySim", + "declaringClassName": "wpilib.simulation.PowerDistributionSim", "functionName": "__init__", - "returnType": "wpilib.simulation.RelaySim", - "tooltip": "Constructs from a Relay object.\n\n:param relay: Relay to simulate" + "returnType": "wpilib.simulation.PowerDistributionSim", + "tooltip": "Constructs from a PowerDistribution module number (CAN ID).\n\n:param module: module number" }, { "args": [ { "defaultValue": "", - "name": "channel", - "type": "int" + "name": "pdp", + "type": "wpilib.PowerDistribution" } ], - "declaringClassName": "wpilib.simulation.RelaySim", + "declaringClassName": "wpilib.simulation.PowerDistributionSim", "functionName": "__init__", - "returnType": "wpilib.simulation.RelaySim", - "tooltip": "Constructs from a relay channel number.\n\n:param channel: Channel number" + "returnType": "wpilib.simulation.PowerDistributionSim", + "tooltip": "Constructs from a PowerDistribution object.\n\n:param pdp: PowerDistribution to simulate" } ], "enums": [], @@ -62058,82 +42117,87 @@ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" + "type": "wpilib.simulation.PowerDistributionSim" + }, + { + "defaultValue": "", + "name": "length", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "getForward", - "returnType": "bool", - "tooltip": "Check whether the forward direction is active.\n\n:returns: true if active" + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "getAllCurrents", + "returnType": "float", + "tooltip": "Read the current of all of the PowerDistribution channels.\n\n:param currents: output array; set to the current in each channel. The\n array must be big enough to hold all the PowerDistribution\n channels\n:param length: length of output array" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" + "type": "wpilib.simulation.PowerDistributionSim" + }, + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "getInitializedForward", - "returnType": "bool", - "tooltip": "Check whether the forward direction has been initialized.\n\n:returns: true if initialized" + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "getCurrent", + "returnType": "float", + "tooltip": "Read the current in one of the PowerDistribution channels.\n\n:param channel: the channel to check\n\n:returns: the current in the given channel" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" + "type": "wpilib.simulation.PowerDistributionSim" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "getInitializedReverse", + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "getInitialized", "returnType": "bool", - "tooltip": "Check whether the reverse direction has been initialized.\n\n:returns: true if initialized" + "tooltip": "Check whether the PowerDistribution has been initialized.\n\n:returns: true if initialized" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" + "type": "wpilib.simulation.PowerDistributionSim" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "getReverse", - "returnType": "bool", - "tooltip": "Check whether the reverse direction is active.\n\n:returns: true if active" + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "getTemperature", + "returnType": "float", + "tooltip": "Check the temperature of the PowerDistribution.\n\n:returns: the PowerDistribution temperature" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" - }, - { - "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "type": "wpilib.simulation.PowerDistributionSim" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "registerForwardCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the forward direction changes state.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "getVoltage", + "returnType": "float", + "tooltip": "Check the PowerDistribution voltage.\n\n:returns: the PowerDistribution voltage." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" + "type": "wpilib.simulation.PowerDistributionSim" + }, + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -62146,17 +42210,17 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "registerInitializedForwardCallback", + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "registerCurrentCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the forward direction is initialized.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback to be run whenever the current of a specific channel\nchanges.\n\n:param channel: the channel\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" + "type": "wpilib.simulation.PowerDistributionSim" }, { "defaultValue": "", @@ -62169,17 +42233,17 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "registerInitializedReverseCallback", + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "registerInitializedCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the reverse direction is initialized.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback to be run when the PowerDistribution is initialized.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" + "type": "wpilib.simulation.PowerDistributionSim" }, { "defaultValue": "", @@ -62192,483 +42256,295 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "registerReverseCallback", + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "registerTemperatureCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the reverse direction changes state.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback to be run whenever the PowerDistribution temperature\nchanges.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" - } - ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "resetData", - "returnType": "None", - "tooltip": "Reset all simulation data." - }, - { - "args": [ + "type": "wpilib.simulation.PowerDistributionSim" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.RelaySim" + "name": "callback", + "type": "Callable[[str, hal.Value], None]" }, { "defaultValue": "", - "name": "forward", + "name": "initialNotify", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "setForward", - "returnType": "None", - "tooltip": "Set whether the forward direction is active.\n\n:param forward: true to make active" + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "registerVoltageCallback", + "returnType": "wpilib.simulation.CallbackStore", + "tooltip": "Register a callback to be run whenever the PowerDistribution voltage\nchanges.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" - }, - { - "defaultValue": "", - "name": "initializedForward", - "type": "bool" + "type": "wpilib.simulation.PowerDistributionSim" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "setInitializedForward", + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "resetData", "returnType": "None", - "tooltip": "Define whether the forward direction has been initialized.\n\n:param initializedForward: whether this object is initialized" + "tooltip": "Reset all PowerDistribution simulation data." }, { "args": [ { "defaultValue": "", "name": "self", - "type": "wpilib.simulation.RelaySim" + "type": "wpilib.simulation.PowerDistributionSim" }, { "defaultValue": "", - "name": "initializedReverse", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "setInitializedReverse", - "returnType": "None", - "tooltip": "Define whether the reverse direction has been initialized.\n\n:param initializedReverse: whether this object is initialized" - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.RelaySim" + "name": "currents", + "type": "typing.SupportsFloat" }, { "defaultValue": "", - "name": "reverse", - "type": "bool" + "name": "length", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.RelaySim", - "functionName": "setReverse", + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "setAllCurrents", "returnType": "None", - "tooltip": "Set whether the reverse direction is active.\n\n:param reverse: true to make active" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, - { - "className": "wpilib.simulation.RoboRioSim", - "classVariables": [], - "constructors": [ - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.RoboRioSim", - "tooltip": "" - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [ - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getBrownoutVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Measure the brownout voltage.\n\n:returns: the brownout voltage" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getCPUTemp", - "returnType": "wpimath.units.celsius", - "tooltip": "Get the cpu temp.\n\n:returns: the cpu temp." - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getComments", - "returnType": "str", - "tooltip": "Get the comments.\n\n:returns: The comments." - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getFPGAButton", - "returnType": "bool", - "tooltip": "Query the state of the FPGA button.\n\n:returns: the FPGA button state" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getRadioLEDState", - "returnType": "wpilib.RadioLEDState", - "tooltip": "Get the state of the radio led.\n\n:returns: The state of the radio led." - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getSerialNumber", - "returnType": "str", - "tooltip": "Get the serial number.\n\n:returns: The serial number." - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getTeamNumber", - "returnType": "int", - "tooltip": "Get the team number.\n\n:returns: the team number." - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserActive3V3", - "returnType": "bool", - "tooltip": "Get the 3.3V rail active state.\n\n:returns: true if the 3.3V rail is active" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserActive5V", - "returnType": "bool", - "tooltip": "Get the 5V rail active state.\n\n:returns: true if the 5V rail is active" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserActive6V", - "returnType": "bool", - "tooltip": "Get the 6V rail active state.\n\n:returns: true if the 6V rail is active" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserCurrent3V3", - "returnType": "wpimath.units.amperes", - "tooltip": "Measure the 3.3V rail current.\n\n:returns: the 3.3V rail current" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserCurrent5V", - "returnType": "wpimath.units.amperes", - "tooltip": "Measure the 5V rail current.\n\n:returns: the 5V rail current" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserCurrent6V", - "returnType": "wpimath.units.amperes", - "tooltip": "Measure the 6V rail current.\n\n:returns: the 6V rail current" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserFaults3V3", - "returnType": "int", - "tooltip": "Get the 3.3V rail number of faults.\n\n:returns: number of faults" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserFaults5V", - "returnType": "int", - "tooltip": "Get the 5V rail number of faults.\n\n:returns: number of faults" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserFaults6V", - "returnType": "int", - "tooltip": "Get the 6V rail number of faults.\n\n:returns: number of faults" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserVoltage3V3", - "returnType": "wpimath.units.volts", - "tooltip": "Measure the 3.3V rail voltage.\n\n:returns: the 3.3V rail voltage" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserVoltage5V", - "returnType": "wpimath.units.volts", - "tooltip": "Measure the 5V rail voltage.\n\n:returns: the 5V rail voltage" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getUserVoltage6V", - "returnType": "wpimath.units.volts", - "tooltip": "Measure the 6V rail voltage.\n\n:returns: the 6V rail voltage" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getVInCurrent", - "returnType": "wpimath.units.amperes", - "tooltip": "Measure the Vin current.\n\n:returns: the Vin current" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "getVInVoltage", - "returnType": "wpimath.units.volts", - "tooltip": "Measure the Vin voltage.\n\n:returns: the Vin voltage" + "tooltip": "Change the current in all of the PowerDistribution channels.\n\n:param currents: array containing the current values for each channel. The\n array must be big enough to hold all the PowerDistribution\n channels\n:param length: length of array" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "name": "self", + "type": "wpilib.simulation.PowerDistributionSim" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "channel", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "current", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerBrownoutVoltageCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the brownout voltage changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "setCurrent", + "returnType": "None", + "tooltip": "Change the current in the given channel.\n\n:param channel: the channel to edit\n:param current: the new current for the channel" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "name": "self", + "type": "wpilib.simulation.PowerDistributionSim" }, { "defaultValue": "", - "name": "initialNotify", + "name": "initialized", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerCPUTempCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the cpu temp changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "setInitialized", + "returnType": "None", + "tooltip": "Define whether the PowerDistribution has been initialized.\n\n:param initialized: whether this object is initialized" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "name": "self", + "type": "wpilib.simulation.PowerDistributionSim" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "temperature", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerFPGAButtonCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when the FPGA button state changes.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "setTemperature", + "returnType": "None", + "tooltip": "Define the PowerDistribution temperature.\n\n:param temperature: the new PowerDistribution temperature" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "name": "self", + "type": "wpilib.simulation.PowerDistributionSim" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "voltage", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerRadioLEDStateCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the Radio led state changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.PowerDistributionSim", + "functionName": "setVoltage", + "returnType": "None", + "tooltip": "Set the PowerDistribution voltage.\n\n:param voltage: the new PowerDistribution voltage" + } + ], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [] + }, + { + "className": "wpilib.simulation.REVPHSim", + "classVariables": [], + "constructors": [ + { + "args": [], + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "__init__", + "returnType": "wpilib.simulation.REVPHSim", + "tooltip": "Constructs with the default PCM module number (CAN ID)." }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "module", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerTeamNumberCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the team number changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "__init__", + "returnType": "wpilib.simulation.REVPHSim", + "tooltip": "Constructs from a PCM module number (CAN ID).\n\n:param module: module number" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, + "name": "pneumatics", + "type": "wpilib.PneumaticsBase" + } + ], + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "__init__", + "returnType": "wpilib.simulation.REVPHSim", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "self", + "type": "wpilib.simulation.REVPHSim" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserActive3V3Callback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 3.3V rail active state changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "getAllSolenoidOutputs", + "returnType": "int", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "self", + "type": "wpilib.simulation.REVPHSim" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserActive5VCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 5V rail active state changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "getCompressorConfigType", + "returnType": "int", + "tooltip": "Check whether the closed loop compressor control is active.\n\n:returns: compressor config type" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "self", + "type": "wpilib.simulation.REVPHSim" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserActive6VCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 6V rail active state changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial state\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "getCompressorCurrent", + "returnType": "float", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "self", + "type": "wpilib.simulation.REVPHSim" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserCurrent3V3Callback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 3.3V rail current changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "getCompressorOn", + "returnType": "bool", + "tooltip": "Check if the compressor is on.\n\n:returns: true if the compressor is active" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "self", + "type": "wpilib.simulation.REVPHSim" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserCurrent5VCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 5V rail current changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "getInitialized", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" - }, - { - "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "self", + "type": "wpilib.simulation.REVPHSim" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserCurrent6VCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 6V rail current changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "getPressureSwitch", + "returnType": "bool", + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "name": "self", + "type": "wpilib.simulation.REVPHSim" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" + "name": "channel", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserFaults3V3Callback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 3.3V rail number of faults\nchanges.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "getSolenoidOutput", + "returnType": "bool", + "tooltip": "" }, { "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, { "defaultValue": "", "name": "callback", @@ -62680,13 +42556,18 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserFaults5VCallback", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "registerCompressorConfigTypeCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 5V rail number of faults\nchanges.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback to be run whenever the closed loop state changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, { "defaultValue": "", "name": "callback", @@ -62698,13 +42579,18 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserFaults6VCallback", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "registerCompressorCurrentCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 6V rail number of faults\nchanges.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "" }, { "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, { "defaultValue": "", "name": "callback", @@ -62716,13 +42602,18 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserVoltage3V3Callback", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "registerCompressorOnCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 3.3V rail voltage changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "" }, { "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, { "defaultValue": "", "name": "callback", @@ -62734,13 +42625,18 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserVoltage5VCallback", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "registerInitializedCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 5V rail voltage changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "" }, { "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, { "defaultValue": "", "name": "callback", @@ -62752,31 +42648,23 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerUserVoltage6VCallback", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "registerPressureSwitchCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the 6V rail voltage changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "callback", - "type": "Callable[[str, hal.Value], None]" + "name": "self", + "type": "wpilib.simulation.REVPHSim" }, { "defaultValue": "", - "name": "initialNotify", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerVInCurrentCallback", - "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the Vin current changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" - }, - { - "args": [ + "name": "channel", + "type": "typing.SupportsInt" + }, { "defaultValue": "", "name": "callback", @@ -62788,385 +42676,322 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "registerVInVoltageCallback", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "registerSolenoidOutputCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the Vin voltage changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" - }, - { - "args": [], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "resetData", - "returnType": "None", - "tooltip": "Reset all simulation data." + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "brownoutVoltage", - "type": "wpimath.units.volts" + "name": "self", + "type": "wpilib.simulation.REVPHSim" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setBrownoutVoltage", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "resetData", "returnType": "None", - "tooltip": "Define the brownout voltage.\n\n:param brownoutVoltage: the new voltage" + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "cpuTemp", - "type": "wpimath.units.celsius" - } - ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setCPUTemp", - "returnType": "None", - "tooltip": "Define the cpu temp.\n\n:param cpuTemp: the new cpu temp." - }, - { - "args": [ + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, { "defaultValue": "", - "name": "comments", - "type": "str" + "name": "outputs", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setComments", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "setAllSolenoidOutputs", "returnType": "None", - "tooltip": "Set the comments.\n\n:param comments: The comments." + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "fPGAButton", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setFPGAButton", - "returnType": "None", - "tooltip": "Define the state of the FPGA button.\n\n:param fPGAButton: the new state" - }, - { - "args": [ + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, { "defaultValue": "", - "name": "state", - "type": "wpilib.RadioLEDState" + "name": "compressorConfigType", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setRadioLEDState", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "setCompressorConfigType", "returnType": "None", - "tooltip": "Set the state of the radio led.\n\n:param state: The state of the radio led." + "tooltip": "Turn on/off the closed loop control of the compressor.\n\n:param compressorConfigType: compressor config type" }, { "args": [ { "defaultValue": "", - "name": "serialNumber", - "type": "str" - } - ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setSerialNumber", - "returnType": "None", - "tooltip": "Set the serial number.\n\n:param serialNumber: The serial number." - }, - { - "args": [ + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, { "defaultValue": "", - "name": "teamNumber", - "type": "int" + "name": "compressorCurrent", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setTeamNumber", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "setCompressorCurrent", "returnType": "None", - "tooltip": "Set the team number.\n\n:param teamNumber: the new team number." + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "userActive3V3", + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, + { + "defaultValue": "", + "name": "compressorOn", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserActive3V3", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "setCompressorOn", "returnType": "None", - "tooltip": "Set the 3.3V rail active state.\n\n:param userActive3V3: true to make rail active" + "tooltip": "Set whether the compressor is active.\n\n:param compressorOn: the new value" }, { "args": [ { "defaultValue": "", - "name": "userActive5V", + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, + { + "defaultValue": "", + "name": "solenoidInitialized", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserActive5V", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "setInitialized", "returnType": "None", - "tooltip": "Set the 5V rail active state.\n\n:param userActive5V: true to make rail active" + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "userActive6V", + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, + { + "defaultValue": "", + "name": "pressureSwitch", "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserActive6V", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "setPressureSwitch", "returnType": "None", - "tooltip": "Set the 6V rail active state.\n\n:param userActive6V: true to make rail active" + "tooltip": "" }, { "args": [ { "defaultValue": "", - "name": "userCurrent3V3", - "type": "wpimath.units.amperes" + "name": "self", + "type": "wpilib.simulation.REVPHSim" + }, + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "solenoidOutput", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserCurrent3V3", + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "setSolenoidOutput", "returnType": "None", - "tooltip": "Define the 3.3V rail current.\n\n:param userCurrent3V3: the new current" - }, + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [ { "args": [ { "defaultValue": "", - "name": "userCurrent5V", - "type": "wpimath.units.amperes" + "name": "module", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "type", + "type": "wpilib.PneumaticsModuleType" } ], + "declaringClassName": "wpilib.simulation.REVPHSim", + "functionName": "getForType", + "returnType": "wpilib.simulation.PneumaticsBaseSim", + "tooltip": "" + } + ] + }, + { + "className": "wpilib.simulation.RoboRioSim", + "classVariables": [], + "constructors": [ + { + "args": [], "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserCurrent5V", - "returnType": "None", - "tooltip": "Define the 5V rail current.\n\n:param userCurrent5V: the new current" + "functionName": "__init__", + "returnType": "wpilib.simulation.RoboRioSim", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [ + { + "args": [], + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "getBrownoutVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Measure the brownout voltage.\n\n:returns: the brownout voltage" }, { - "args": [ - { - "defaultValue": "", - "name": "userCurrent6V", - "type": "wpimath.units.amperes" - } - ], + "args": [], "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserCurrent6V", - "returnType": "None", - "tooltip": "Define the 6V rail current.\n\n:param userCurrent6V: the new current" + "functionName": "getCPUTemp", + "returnType": "wpimath.units.celsius", + "tooltip": "Get the cpu temp.\n\n:returns: the cpu temp." }, { - "args": [ - { - "defaultValue": "", - "name": "userFaults3V3", - "type": "int" - } - ], + "args": [], "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserFaults3V3", - "returnType": "None", - "tooltip": "Set the 3.3V rail number of faults.\n\n:param userFaults3V3: number of faults" + "functionName": "getComments", + "returnType": "str", + "tooltip": "Get the comments.\n\n:returns: The comments." }, { - "args": [ - { - "defaultValue": "", - "name": "userFaults5V", - "type": "int" - } - ], + "args": [], "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserFaults5V", - "returnType": "None", - "tooltip": "Set the 5V rail number of faults.\n\n:param userFaults5V: number of faults" + "functionName": "getSerialNumber", + "returnType": "str", + "tooltip": "Get the serial number.\n\n:returns: The serial number." }, { - "args": [ - { - "defaultValue": "", - "name": "userFaults6V", - "type": "int" - } - ], + "args": [], "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserFaults6V", - "returnType": "None", - "tooltip": "Set the 6V rail number of faults.\n\n:param userFaults6V: number of faults" + "functionName": "getTeamNumber", + "returnType": "int", + "tooltip": "Get the team number.\n\n:returns: the team number." }, { - "args": [ - { - "defaultValue": "", - "name": "userVoltage3V3", - "type": "wpimath.units.volts" - } - ], + "args": [], "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserVoltage3V3", - "returnType": "None", - "tooltip": "Define the 3.3V rail voltage.\n\n:param userVoltage3V3: the new voltage" + "functionName": "getUserActive3V3", + "returnType": "bool", + "tooltip": "Get the 3.3V rail active state.\n\n:returns: true if the 3.3V rail is active" }, { - "args": [ - { - "defaultValue": "", - "name": "userVoltage5V", - "type": "wpimath.units.volts" - } - ], + "args": [], "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserVoltage5V", - "returnType": "None", - "tooltip": "Define the 5V rail voltage.\n\n:param userVoltage5V: the new voltage" + "functionName": "getUserCurrent3V3", + "returnType": "wpimath.units.amperes", + "tooltip": "Measure the 3.3V rail current.\n\n:returns: the 3.3V rail current" }, { - "args": [ - { - "defaultValue": "", - "name": "userVoltage6V", - "type": "wpimath.units.volts" - } - ], + "args": [], "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setUserVoltage6V", - "returnType": "None", - "tooltip": "Define the 6V rail voltage.\n\n:param userVoltage6V: the new voltage" + "functionName": "getUserFaults3V3", + "returnType": "int", + "tooltip": "Get the 3.3V rail number of faults.\n\n:returns: number of faults" }, { - "args": [ - { - "defaultValue": "", - "name": "vInCurrent", - "type": "wpimath.units.amperes" - } - ], + "args": [], "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setVInCurrent", - "returnType": "None", - "tooltip": "Define the Vin current.\n\n:param vInCurrent: the new current" + "functionName": "getUserVoltage3V3", + "returnType": "wpimath.units.volts", + "tooltip": "Measure the 3.3V rail voltage.\n\n:returns: the 3.3V rail voltage" }, { - "args": [ - { - "defaultValue": "", - "name": "vInVoltage", - "type": "wpimath.units.volts" - } - ], + "args": [], "declaringClassName": "wpilib.simulation.RoboRioSim", - "functionName": "setVInVoltage", - "returnType": "None", - "tooltip": "Define the Vin voltage.\n\n:param vInVoltage: the new voltage" - } - ] - }, - { - "className": "wpilib.simulation.SPIAccelerometerSim", - "classVariables": [], - "constructors": [ + "functionName": "getVInVoltage", + "returnType": "wpimath.units.volts", + "tooltip": "Measure the Vin voltage.\n\n:returns: the Vin voltage" + }, { "args": [ { "defaultValue": "", - "name": "index", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.SPIAccelerometerSim", - "tooltip": "Construct a new simulation object.\n\n:param index: the HAL index of the accelerometer" - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ + "name": "callback", + "type": "Callable[[str, hal.Value], None]" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" + "name": "initialNotify", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "getActive", - "returnType": "bool", - "tooltip": "Check whether the accelerometer is active.\n\n:returns: true if active" + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "registerBrownoutVoltageCallback", + "returnType": "wpilib.simulation.CallbackStore", + "tooltip": "Register a callback to be run whenever the brownout voltage changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - } - ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "getRange", - "returnType": "int", - "tooltip": "Check the range of this accelerometer.\n\n:returns: the accelerometer range" - }, - { - "args": [ + "name": "callback", + "type": "Callable[[str, hal.Value], None]" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" + "name": "initialNotify", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "getX", - "returnType": "float", - "tooltip": "Measure the X axis value.\n\n:returns: the X axis measurement" + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "registerCPUTempCallback", + "returnType": "wpilib.simulation.CallbackStore", + "tooltip": "Register a callback to be run whenever the cpu temp changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - } - ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "getY", - "returnType": "float", - "tooltip": "Measure the Y axis value.\n\n:returns: the Y axis measurement" - }, - { - "args": [ + "name": "callback", + "type": "Callable[[str, hal.Value], None]" + }, { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" + "name": "initialNotify", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "getZ", - "returnType": "float", - "tooltip": "Measure the Z axis value.\n\n:returns: the Z axis measurement" + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "registerTeamNumberCallback", + "returnType": "wpilib.simulation.CallbackStore", + "tooltip": "Register a callback to be run whenever the team number changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - }, { "defaultValue": "", "name": "callback", @@ -63178,18 +43003,13 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "registerActiveCallback", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "registerUserActive3V3Callback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run when this accelerometer activates.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback to be run whenever the 3.3V rail active state changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial state\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - }, { "defaultValue": "", "name": "callback", @@ -63201,18 +43021,13 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "registerRangeCallback", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "registerUserCurrent3V3Callback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the range changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback to be run whenever the 3.3V rail current changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - }, { "defaultValue": "", "name": "callback", @@ -63224,18 +43039,13 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "registerXCallback", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "registerUserFaults3V3Callback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the X axis value changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback to be run whenever the 3.3V rail number of faults\nchanges.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - }, { "defaultValue": "", "name": "callback", @@ -63247,18 +43057,13 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "registerYCallback", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "registerUserVoltage3V3Callback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the Y axis value changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback to be run whenever the 3.3V rail voltage changes.\n\n:param callback: the callback\n:param initialNotify: whether the callback should be called with the\n initial value\n\n:returns: the CallbackStore object associated with this callback" }, { "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - }, { "defaultValue": "", "name": "callback", @@ -63270,118 +43075,149 @@ "type": "bool" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "registerZCallback", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "registerVInVoltageCallback", "returnType": "wpilib.simulation.CallbackStore", - "tooltip": "Register a callback to be run whenever the Z axis value changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + "tooltip": "Register a callback to be run whenever the Vin voltage changes.\n\n:param callback: the callback\n:param initialNotify: whether to call the callback with the initial state\n\n:returns: the CallbackStore object associated with this callback" + }, + { + "args": [], + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "resetData", + "returnType": "None", + "tooltip": "Reset all simulation data." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" + "name": "brownoutVoltage", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "resetData", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "setBrownoutVoltage", "returnType": "None", - "tooltip": "Reset all simulation data of this object." + "tooltip": "Define the brownout voltage.\n\n:param brownoutVoltage: the new voltage" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - }, - { - "defaultValue": "", - "name": "active", - "type": "bool" + "name": "cpuTemp", + "type": "wpimath.units.celsius" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "setActive", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "setCPUTemp", "returnType": "None", - "tooltip": "Define whether this accelerometer is active.\n\n:param active: the new state" + "tooltip": "Define the cpu temp.\n\n:param cpuTemp: the new cpu temp." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - }, + "name": "comments", + "type": "str" + } + ], + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "setComments", + "returnType": "None", + "tooltip": "Set the comments.\n\n:param comments: The comments." + }, + { + "args": [ { "defaultValue": "", - "name": "range", - "type": "int" + "name": "serialNumber", + "type": "str" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "setRange", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "setSerialNumber", "returnType": "None", - "tooltip": "Change the range of this accelerometer.\n\n:param range: the new accelerometer range" + "tooltip": "Set the serial number.\n\n:param serialNumber: The serial number." }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - }, + "name": "teamNumber", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "setTeamNumber", + "returnType": "None", + "tooltip": "Set the team number.\n\n:param teamNumber: the new team number." + }, + { + "args": [ { "defaultValue": "", - "name": "x", - "type": "float" + "name": "userActive3V3", + "type": "bool" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "setX", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "setUserActive3V3", "returnType": "None", - "tooltip": "Change the X axis value of the accelerometer.\n\n:param x: the new reading of the X axis" + "tooltip": "Set the 3.3V rail active state.\n\n:param userActive3V3: true to make rail active" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - }, + "name": "userCurrent3V3", + "type": "wpimath.units.amperes" + } + ], + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "setUserCurrent3V3", + "returnType": "None", + "tooltip": "Define the 3.3V rail current.\n\n:param userCurrent3V3: the new current" + }, + { + "args": [ { "defaultValue": "", - "name": "y", - "type": "float" + "name": "userFaults3V3", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "setY", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "setUserFaults3V3", "returnType": "None", - "tooltip": "Change the Y axis value of the accelerometer.\n\n:param y: the new reading of the Y axis" + "tooltip": "Set the 3.3V rail number of faults.\n\n:param userFaults3V3: number of faults" }, { "args": [ { "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.SPIAccelerometerSim" - }, + "name": "userVoltage3V3", + "type": "wpimath.units.volts" + } + ], + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "setUserVoltage3V3", + "returnType": "None", + "tooltip": "Define the 3.3V rail voltage.\n\n:param userVoltage3V3: the new voltage" + }, + { + "args": [ { "defaultValue": "", - "name": "z", - "type": "float" + "name": "vInVoltage", + "type": "wpimath.units.volts" } ], - "declaringClassName": "wpilib.simulation.SPIAccelerometerSim", - "functionName": "setZ", + "declaringClassName": "wpilib.simulation.RoboRioSim", + "functionName": "setVInVoltage", "returnType": "None", - "tooltip": "Change the Z axis value of the accelerometer.\n\n:param z: the new reading of the Z axis" + "tooltip": "Define the Vin voltage.\n\n:param vInVoltage: the new voltage" } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] + ] }, { "className": "wpilib.simulation.SendableChooserSim", @@ -63444,6 +43280,70 @@ "moduleName": "wpilib.simulation", "staticMethods": [] }, + { + "className": "wpilib.simulation.ServoSim", + "classVariables": [], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "servo", + "type": "wpilib.Servo" + } + ], + "declaringClassName": "wpilib.simulation.ServoSim", + "functionName": "__init__", + "returnType": "wpilib.simulation.ServoSim", + "tooltip": "" + }, + { + "args": [ + { + "defaultValue": "", + "name": "channel", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.simulation.ServoSim", + "functionName": "__init__", + "returnType": "wpilib.simulation.ServoSim", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.simulation.ServoSim" + } + ], + "declaringClassName": "wpilib.simulation.ServoSim", + "functionName": "getAngle", + "returnType": "float", + "tooltip": "" + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpilib.simulation.ServoSim" + } + ], + "declaringClassName": "wpilib.simulation.ServoSim", + "functionName": "getPosition", + "returnType": "float", + "tooltip": "" + } + ], + "instanceVariables": [], + "moduleName": "wpilib.simulation", + "staticMethods": [] + }, { "className": "wpilib.simulation.SharpIRSim", "classVariables": [], @@ -63466,7 +43366,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.SharpIRSim", @@ -63486,14 +43386,14 @@ }, { "defaultValue": "", - "name": "rng", - "type": "wpimath.units.centimeters" + "name": "range", + "type": "wpimath.units.meters" } ], "declaringClassName": "wpilib.simulation.SharpIRSim", "functionName": "setRange", "returnType": "None", - "tooltip": "Set the range returned by the distance sensor.\n\n:param rng: range of the target returned by the sensor" + "tooltip": "Set the range returned by the distance sensor.\n\n:param range: range of the target returned by the sensor" } ], "instanceVariables": [], @@ -63527,7 +43427,7 @@ { "defaultValue": "", "name": "index", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.SimDeviceSim", @@ -63545,12 +43445,12 @@ { "defaultValue": "", "name": "index", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.SimDeviceSim", @@ -63563,7 +43463,7 @@ { "defaultValue": "", "name": "handle", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.SimDeviceSim", @@ -63766,7 +43666,7 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -63796,7 +43696,7 @@ { "defaultValue": "[0.0, 0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(2)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(2)]" } ], "declaringClassName": "wpilib.simulation.SingleJointedArmSim", @@ -63814,7 +43714,7 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -63849,7 +43749,7 @@ { "defaultValue": "[0.0, 0.0]", "name": "measurementStdDevs", - "type": "Annotated[list[float], FixedSize(2)]" + "type": "Annotated[list[typing.SupportsFloat], FixedSize(2)]" } ], "declaringClassName": "wpilib.simulation.SingleJointedArmSim", @@ -63909,7 +43809,7 @@ ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", "functionName": "getInput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant." }, { @@ -63922,7 +43822,7 @@ { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -63940,7 +43840,7 @@ ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", "functionName": "getOutput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the current output of the plant.\n\n:returns: The current output of the plant." }, { @@ -63953,7 +43853,7 @@ { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -64023,7 +43923,7 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -64041,12 +43941,12 @@ { "defaultValue": "", "name": "row", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2", @@ -64187,7 +44087,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.SolenoidSim", @@ -64200,7 +44100,7 @@ { "defaultValue": "", "name": "module", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -64210,7 +44110,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.SolenoidSim", @@ -64228,7 +44128,7 @@ { "defaultValue": "", "name": "channel", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.SolenoidSim", @@ -64333,7 +44233,7 @@ { "defaultValue": "", "name": "port", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.StadiaControllerSim", @@ -64354,7 +44254,7 @@ { "defaultValue": "", "name": "outputNumber", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -64434,7 +44334,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -64452,12 +44352,12 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "type", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -64493,7 +44393,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -64637,7 +44537,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.StadiaControllerSim", @@ -64655,7 +44555,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.StadiaControllerSim", @@ -64691,12 +44591,12 @@ { "defaultValue": "", "name": "pov", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -64714,7 +44614,7 @@ { "defaultValue": "", "name": "value", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -64732,7 +44632,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -64750,12 +44650,12 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -64773,7 +44673,7 @@ { "defaultValue": "", "name": "button", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -64850,7 +44750,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.StadiaControllerSim", @@ -64868,7 +44768,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.StadiaControllerSim", @@ -64953,85 +44853,6 @@ "moduleName": "wpilib.simulation", "staticMethods": [] }, - { - "className": "wpilib.simulation.UltrasonicSim", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "ultrasonic", - "type": "wpilib.Ultrasonic" - } - ], - "declaringClassName": "wpilib.simulation.UltrasonicSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.UltrasonicSim", - "tooltip": "Constructor.\n\n:param ultrasonic: The real ultrasonic to simulate" - }, - { - "args": [ - { - "defaultValue": "", - "name": "ping", - "type": "int" - }, - { - "defaultValue": "", - "name": "echo", - "type": "int" - } - ], - "declaringClassName": "wpilib.simulation.UltrasonicSim", - "functionName": "__init__", - "returnType": "wpilib.simulation.UltrasonicSim", - "tooltip": "Constructor.\n\n:param ping: unused.\n:param echo: the ultrasonic's echo channel." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.UltrasonicSim" - }, - { - "defaultValue": "", - "name": "range", - "type": "wpimath.units.inches" - } - ], - "declaringClassName": "wpilib.simulation.UltrasonicSim", - "functionName": "setRange", - "returnType": "None", - "tooltip": "Sets the range measurement.\n\n:param range: The range." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpilib.simulation.UltrasonicSim" - }, - { - "defaultValue": "", - "name": "valid", - "type": "bool" - } - ], - "declaringClassName": "wpilib.simulation.UltrasonicSim", - "functionName": "setRangeValid", - "returnType": "None", - "tooltip": "Sets if the range measurement is valid.\n\n:param valid: True if valid" - } - ], - "instanceVariables": [], - "moduleName": "wpilib.simulation", - "staticMethods": [] - }, { "className": "wpilib.simulation.XboxControllerSim", "classVariables": [], @@ -65054,7 +44875,7 @@ { "defaultValue": "", "name": "port", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.XboxControllerSim", @@ -65075,7 +44896,7 @@ { "defaultValue": "", "name": "outputNumber", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -65155,7 +44976,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -65173,12 +44994,12 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "type", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -65232,7 +45053,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -65286,7 +45107,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.XboxControllerSim", @@ -65304,7 +45125,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.XboxControllerSim", @@ -65322,7 +45143,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.XboxControllerSim", @@ -65358,12 +45179,12 @@ { "defaultValue": "", "name": "pov", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -65381,7 +45202,7 @@ { "defaultValue": "", "name": "value", - "type": "int" + "type": "wpilib.DriverStation.POVDirection" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -65399,7 +45220,7 @@ { "defaultValue": "", "name": "count", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -65417,12 +45238,12 @@ { "defaultValue": "", "name": "axis", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.GenericHIDSim", @@ -65440,7 +45261,7 @@ { "defaultValue": "", "name": "button", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", @@ -65499,7 +45320,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.XboxControllerSim", @@ -65517,7 +45338,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.XboxControllerSim", @@ -65535,7 +45356,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpilib.simulation.XboxControllerSim", @@ -65620,6 +45441,74 @@ "moduleName": "wpilib.simulation", "staticMethods": [] }, + { + "className": "wpilib.sysid.State", + "classVariables": [ + { + "name": "kDynamicForward", + "tooltip": "", + "type": "wpilib.sysid.State", + "writable": false + }, + { + "name": "kDynamicReverse", + "tooltip": "", + "type": "wpilib.sysid.State", + "writable": false + }, + { + "name": "kNone", + "tooltip": "", + "type": "wpilib.sysid.State", + "writable": false + }, + { + "name": "kQuasistaticForward", + "tooltip": "", + "type": "wpilib.sysid.State", + "writable": false + }, + { + "name": "kQuasistaticReverse", + "tooltip": "", + "type": "wpilib.sysid.State", + "writable": false + } + ], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpilib.sysid.State", + "functionName": "__init__", + "returnType": "wpilib.sysid.State", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpilib.sysid", + "staticMethods": [] + }, { "className": "wpilib.sysid.SysIdRoutineLog", "classVariables": [], @@ -65843,7 +45732,7 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -66151,6 +46040,78 @@ "functionName": "minAchievableVelocity", "returnType": "wpimath.units.radians_per_second", "tooltip": "Calculates the minimum achievable velocity given a maximum voltage supply,\na position, and an acceleration. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the acceleration constraint, and this will give you\na simultaneously-achievable velocity constraint.\n\n:param maxVoltage: The maximum voltage that can be supplied to the arm.\n:param angle: The angle of the arm. This angle should be measured\n from the horizontal (i.e. if the provided angle is 0,\n the arm should be parallel to the floor). If your\n encoder does not follow this convention, an offset\n should be added.\n:param acceleration: The acceleration of the arm.\n\n:returns: The minimum possible velocity at the given acceleration and angle." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.ArmFeedforward" + }, + { + "defaultValue": "", + "name": "kA", + "type": "wpimath.units.volt_seconds_squared_per_radian" + } + ], + "declaringClassName": "wpimath.controller.ArmFeedforward", + "functionName": "setKa", + "returnType": "None", + "tooltip": "Sets the acceleration gain.\n\n:param kA: The acceleration gain." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.ArmFeedforward" + }, + { + "defaultValue": "", + "name": "kG", + "type": "wpimath.units.volts" + } + ], + "declaringClassName": "wpimath.controller.ArmFeedforward", + "functionName": "setKg", + "returnType": "None", + "tooltip": "Sets the gravity gain.\n\n:param kG: The gravity gain." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.ArmFeedforward" + }, + { + "defaultValue": "", + "name": "kS", + "type": "wpimath.units.volts" + } + ], + "declaringClassName": "wpimath.controller.ArmFeedforward", + "functionName": "setKs", + "returnType": "None", + "tooltip": "Sets the static gain.\n\n:param kS: The static gain." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.ArmFeedforward" + }, + { + "defaultValue": "", + "name": "kV", + "type": "wpimath.units.volt_seconds_per_radian" + } + ], + "declaringClassName": "wpimath.controller.ArmFeedforward", + "functionName": "setKv", + "returnType": "None", + "tooltip": "Sets the velocity gain.\n\n:param kV: The velocity gain." } ], "instanceVariables": [], @@ -66166,7 +46127,7 @@ { "defaultValue": "inf", "name": "tolerance", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.BangBangController", @@ -66200,12 +46161,12 @@ { "defaultValue": "", "name": "measurement", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "setpoint", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.BangBangController", @@ -66223,7 +46184,7 @@ { "defaultValue": "", "name": "measurement", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.BangBangController", @@ -66311,7 +46272,7 @@ { "defaultValue": "", "name": "setpoint", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.BangBangController", @@ -66329,7 +46290,7 @@ { "defaultValue": "", "name": "tolerance", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.BangBangController", @@ -66351,7 +46312,7 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", @@ -66369,12 +46330,12 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -66400,7 +46361,7 @@ ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector." }, { @@ -66413,7 +46374,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1", @@ -66431,12 +46392,12 @@ { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Calculate the feedforward with only the desired\nfuture reference. This uses the internally stored \"current\"\nreference.\n\nIf this method is used the initial state of the system is the one set using\nReset(const StateVector&). If the initial state is not\nset it defaults to a zero vector.\n\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -66449,17 +46410,17 @@ { "defaultValue": "", "name": "r", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Calculate the feedforward with current and future reference vectors.\n\n:param r: The reference state of the current timestep (k).\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -66472,7 +46433,7 @@ { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1", @@ -66503,7 +46464,7 @@ ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1", "functionName": "uff", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward." }, { @@ -66516,7 +46477,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1", @@ -66538,7 +46499,7 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", @@ -66556,12 +46517,12 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -66587,7 +46548,7 @@ ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector." }, { @@ -66600,7 +46561,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1", @@ -66618,12 +46579,12 @@ { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Calculate the feedforward with only the desired\nfuture reference. This uses the internally stored \"current\"\nreference.\n\nIf this method is used the initial state of the system is the one set using\nReset(const StateVector&). If the initial state is not\nset it defaults to a zero vector.\n\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -66636,17 +46597,17 @@ { "defaultValue": "", "name": "r", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Calculate the feedforward with current and future reference vectors.\n\n:param r: The reference state of the current timestep (k).\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -66659,7 +46620,7 @@ { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1", @@ -66690,7 +46651,7 @@ ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1", "functionName": "uff", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward." }, { @@ -66703,7 +46664,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1", @@ -66725,7 +46686,7 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", @@ -66743,12 +46704,12 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", @@ -66774,7 +46735,7 @@ ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector." }, { @@ -66787,7 +46748,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2", @@ -66805,12 +46766,12 @@ { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Calculate the feedforward with only the desired\nfuture reference. This uses the internally stored \"current\"\nreference.\n\nIf this method is used the initial state of the system is the one set using\nReset(const StateVector&). If the initial state is not\nset it defaults to a zero vector.\n\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -66823,17 +46784,17 @@ { "defaultValue": "", "name": "r", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Calculate the feedforward with current and future reference vectors.\n\n:param r: The reference state of the current timestep (k).\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -66846,7 +46807,7 @@ { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2", @@ -66877,7 +46838,7 @@ ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2", "functionName": "uff", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward." }, { @@ -66890,7 +46851,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2", @@ -67275,6 +47236,78 @@ "functionName": "minAchievableVelocity", "returnType": "wpimath.units.meters_per_second", "tooltip": "Calculates the minimum achievable velocity given a maximum voltage supply\nand an acceleration. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the acceleration constraint, and this will give you\na simultaneously-achievable velocity constraint.\n\n:param maxVoltage: The maximum voltage that can be supplied to the elevator.\n:param acceleration: The acceleration of the elevator.\n\n:returns: The minimum possible velocity at the given acceleration." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.ElevatorFeedforward" + }, + { + "defaultValue": "", + "name": "kA", + "type": "wpimath.units.volt_seconds_squared_per_meter" + } + ], + "declaringClassName": "wpimath.controller.ElevatorFeedforward", + "functionName": "setKa", + "returnType": "None", + "tooltip": "Sets the acceleration gain.\n\n:param kA: The acceleration gain." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.ElevatorFeedforward" + }, + { + "defaultValue": "", + "name": "kG", + "type": "wpimath.units.volts" + } + ], + "declaringClassName": "wpimath.controller.ElevatorFeedforward", + "functionName": "setKg", + "returnType": "None", + "tooltip": "Sets the gravity gain.\n\n:param kG: The gravity gain." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.ElevatorFeedforward" + }, + { + "defaultValue": "", + "name": "kS", + "type": "wpimath.units.volts" + } + ], + "declaringClassName": "wpimath.controller.ElevatorFeedforward", + "functionName": "setKs", + "returnType": "None", + "tooltip": "Sets the static gain.\n\n:param kS: The static gain." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.ElevatorFeedforward" + }, + { + "defaultValue": "", + "name": "kV", + "type": "wpimath.units.volt_seconds_per_meter" + } + ], + "declaringClassName": "wpimath.controller.ElevatorFeedforward", + "functionName": "setKv", + "returnType": "None", + "tooltip": "Sets the velocity gain.\n\n:param kV: The velocity gain." } ], "instanceVariables": [], @@ -67474,22 +47507,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "Aref", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "Bref", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1", @@ -67564,7 +47597,7 @@ ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the control input vector u.\n\n:returns: The control input." }, { @@ -67577,7 +47610,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1", @@ -67595,17 +47628,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x.\n:param u: The current input for the original model." }, { @@ -67635,22 +47668,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "Aref", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "Bref", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1", @@ -67725,7 +47758,7 @@ ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the control input vector u.\n\n:returns: The control input." }, { @@ -67738,7 +47771,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1", @@ -67756,17 +47789,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x.\n:param u: The current input for the original model." }, { @@ -67796,22 +47829,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "Aref", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "Bref", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" } ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2", @@ -67886,7 +47919,7 @@ ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the control input vector u.\n\n:returns: The control input." }, { @@ -67899,7 +47932,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2", @@ -67917,17 +47950,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x.\n:param u: The current input for the original model." }, { @@ -67967,12 +48000,12 @@ { "defaultValue": "", "name": "Qelems", - "type": "Tuple[float, float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "Relems", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -67983,7 +48016,7 @@ "declaringClassName": "wpimath.controller.LTVDifferentialDriveController", "functionName": "__init__", "returnType": "wpimath.controller.LTVDifferentialDriveController", - "tooltip": "Constructs a linear time-varying differential drive controller.\n\nSee\nhttps://docs.wpilib.org/en/stable/docs/software/advanced-controls/state-space/state-space-intro.html#lqr-tuning\nfor how to select the tolerances.\n\n:param plant: The differential drive velocity plant.\n:param trackwidth: The distance between the differential drive's left and\n right wheels.\n:param Qelems: The maximum desired error tolerance for each state.\n:param Relems: The maximum desired control effort for each input.\n:param dt: Discretization timestep.\n @throws std::domain_error if max velocity of plant with 12 V input <= 0 m/s\n or >= 15 m/s." + "tooltip": "Constructs a linear time-varying differential drive controller.\n\nSee\nhttps://docs.wpilib.org/en/stable/docs/software/advanced-controls/state-space/state-space-intro.html#lqr-tuning\nfor how to select the tolerances.\n\n:param plant: The differential drive velocity plant.\n:param trackwidth: The distance between the differential drive's left and\n right wheels.\n:param Qelems: The maximum desired error tolerance for each state.\n:param Relems: The maximum desired control effort for each input.\n:param dt: Discretization timestep." } ], "enums": [], @@ -68120,45 +48153,35 @@ "defaultValue": "", "name": "dt", "type": "wpimath.units.seconds" - }, - { - "defaultValue": "9.0", - "name": "maxVelocity", - "type": "wpimath.units.meters_per_second" } ], "declaringClassName": "wpimath.controller.LTVUnicycleController", "functionName": "__init__", "returnType": "wpimath.controller.LTVUnicycleController", - "tooltip": "Constructs a linear time-varying unicycle controller with default maximum\ndesired error tolerances of (x = 0.0625 m, y = 0.125 m, heading = 2 rad)\nand default maximum desired control effort of (linear velocity = 1 m/s,\nangular velocity = 2 rad/s).\n\n:param dt: Discretization timestep.\n:param maxVelocity: The maximum velocity for the controller gain lookup\n table.\n @throws std::domain_error if maxVelocity <= 0 m/s or >= 15 m/s." + "tooltip": "Constructs a linear time-varying unicycle controller with default maximum\ndesired error tolerances of (x = 0.0625 m, y = 0.125 m, heading = 2 rad)\nand default maximum desired control effort of (linear velocity = 1 m/s,\nangular velocity = 2 rad/s).\n\n:param dt: Discretization timestep." }, { "args": [ { "defaultValue": "", "name": "Qelems", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "Relems", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "dt", "type": "wpimath.units.seconds" - }, - { - "defaultValue": "9.0", - "name": "maxVelocity", - "type": "wpimath.units.meters_per_second" } ], "declaringClassName": "wpimath.controller.LTVUnicycleController", "functionName": "__init__", "returnType": "wpimath.controller.LTVUnicycleController", - "tooltip": "Constructs a linear time-varying unicycle controller.\n\nSee\nhttps://docs.wpilib.org/en/stable/docs/software/advanced-controls/state-space/state-space-intro.html#lqr-tuning\nfor how to select the tolerances.\n\n:param Qelems: The maximum desired error tolerance for each state (x, y,\n heading).\n:param Relems: The maximum desired control effort for each input (linear\n velocity, angular velocity).\n:param dt: Discretization timestep.\n:param maxVelocity: The maximum velocity for the controller gain lookup\n table.\n @throws std::domain_error if maxVelocity <= 0 m/s or >= 15 m/s." + "tooltip": "Constructs a linear time-varying unicycle controller.\n\nSee\nhttps://docs.wpilib.org/en/stable/docs/software/advanced-controls/state-space/state-space-intro.html#lqr-tuning\nfor how to select the tolerances.\n\n:param Qelems: The maximum desired error tolerance for each state (x, y,\n heading).\n:param Relems: The maximum desired control effort for each input (linear\n velocity, angular velocity).\n:param dt: Discretization timestep." } ], "enums": [], @@ -68282,12 +48305,12 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -68313,7 +48336,7 @@ ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector." }, { @@ -68326,7 +48349,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1", @@ -68344,12 +48367,12 @@ { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Calculate the feedforward with only the desired\nfuture reference. This uses the internally stored \"current\"\nreference.\n\nIf this method is used the initial state of the system is the one set using\nReset(const StateVector&). If the initial state is not\nset it defaults to a zero vector.\n\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -68362,17 +48385,17 @@ { "defaultValue": "", "name": "r", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Calculate the feedforward with current and future reference vectors.\n\n:param r: The reference state of the current timestep (k).\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -68385,7 +48408,7 @@ { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1", @@ -68416,7 +48439,7 @@ ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1", "functionName": "uff", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward." }, { @@ -68429,7 +48452,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1", @@ -68451,12 +48474,12 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -68482,7 +48505,7 @@ ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector." }, { @@ -68495,7 +48518,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1", @@ -68513,12 +48536,12 @@ { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Calculate the feedforward with only the desired\nfuture reference. This uses the internally stored \"current\"\nreference.\n\nIf this method is used the initial state of the system is the one set using\nReset(const StateVector&). If the initial state is not\nset it defaults to a zero vector.\n\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -68531,17 +48554,17 @@ { "defaultValue": "", "name": "r", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Calculate the feedforward with current and future reference vectors.\n\n:param r: The reference state of the current timestep (k).\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -68554,7 +48577,7 @@ { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1", @@ -68585,7 +48608,7 @@ ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1", "functionName": "uff", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward." }, { @@ -68598,7 +48621,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1", @@ -68620,12 +48643,12 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", @@ -68651,7 +48674,7 @@ ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector." }, { @@ -68664,7 +48687,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2", @@ -68682,12 +48705,12 @@ { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Calculate the feedforward with only the desired\nfuture reference. This uses the internally stored \"current\"\nreference.\n\nIf this method is used the initial state of the system is the one set using\nReset(const StateVector&). If the initial state is not\nset it defaults to a zero vector.\n\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -68700,17 +48723,17 @@ { "defaultValue": "", "name": "r", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Calculate the feedforward with current and future reference vectors.\n\n:param r: The reference state of the current timestep (k).\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -68723,7 +48746,7 @@ { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2", @@ -68754,7 +48777,7 @@ ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2", "functionName": "uff", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward." }, { @@ -68767,7 +48790,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2", @@ -68789,12 +48812,12 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" }, { "defaultValue": "", @@ -68820,7 +48843,7 @@ ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector." }, { @@ -68833,7 +48856,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2", @@ -68851,12 +48874,12 @@ { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Calculate the feedforward with only the desired\nfuture reference. This uses the internally stored \"current\"\nreference.\n\nIf this method is used the initial state of the system is the one set using\nReset(const StateVector&). If the initial state is not\nset it defaults to a zero vector.\n\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -68869,17 +48892,17 @@ { "defaultValue": "", "name": "r", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Calculate the feedforward with current and future reference vectors.\n\n:param r: The reference state of the current timestep (k).\n:param nextR: The reference state of the future timestep (k + dt).\n\n:returns: The calculated feedforward." }, { @@ -68892,7 +48915,7 @@ { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2", @@ -68923,7 +48946,7 @@ ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2", "functionName": "uff", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward." }, { @@ -68936,7 +48959,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2", @@ -68958,22 +48981,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "Qelems", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", "name": "Relems", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -68991,22 +49014,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "Q", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -69024,27 +49047,27 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "Q", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "N", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -69067,12 +49090,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -69095,12 +49118,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -69123,12 +49146,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -69154,7 +49177,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1", "functionName": "K", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the controller matrix K." }, { @@ -69167,12 +49190,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1", @@ -69190,7 +49213,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the reference vector r.\n\n:returns: The reference vector." }, { @@ -69203,7 +49226,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1", @@ -69221,7 +49244,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the control input vector u.\n\n:returns: The control input." }, { @@ -69234,7 +49257,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1", @@ -69252,12 +49275,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x." }, { @@ -69270,17 +49293,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x.\n:param nextR: The next reference vector r." }, { @@ -69366,22 +49389,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "Qelems", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "Relems", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -69399,22 +49422,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "Q", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -69432,27 +49455,27 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "Q", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "N", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -69475,12 +49498,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -69503,12 +49526,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -69531,12 +49554,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -69562,7 +49585,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1", "functionName": "K", - "returnType": "numpy.ndarray[numpy.float64[1, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 2]\"]", "tooltip": "Returns the controller matrix K." }, { @@ -69575,12 +49598,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1", @@ -69598,7 +49621,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the reference vector r.\n\n:returns: The reference vector." }, { @@ -69611,7 +49634,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1", @@ -69629,7 +49652,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the control input vector u.\n\n:returns: The control input." }, { @@ -69642,7 +49665,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1", @@ -69660,12 +49683,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x." }, { @@ -69678,17 +49701,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x.\n:param nextR: The next reference vector r." }, { @@ -69774,22 +49797,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "Qelems", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "Relems", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -69807,22 +49830,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "Q", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", @@ -69840,27 +49863,27 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "Q", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "N", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", @@ -69883,12 +49906,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -69911,12 +49934,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -69939,12 +49962,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -69970,7 +49993,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2", "functionName": "K", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the controller matrix K." }, { @@ -69983,12 +50006,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2", @@ -70006,7 +50029,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the reference vector r.\n\n:returns: The reference vector." }, { @@ -70019,7 +50042,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2", @@ -70037,7 +50060,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the control input vector u.\n\n:returns: The control input." }, { @@ -70050,7 +50073,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2", @@ -70068,12 +50091,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x." }, { @@ -70086,17 +50109,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x.\n:param nextR: The next reference vector r." }, { @@ -70182,22 +50205,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" }, { "defaultValue": "", "name": "Qelems", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "Relems", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -70215,22 +50238,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" }, { "defaultValue": "", "name": "Q", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", @@ -70248,27 +50271,27 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" }, { "defaultValue": "", "name": "Q", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "N", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" }, { "defaultValue": "", @@ -70291,12 +50314,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -70319,12 +50342,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -70347,12 +50370,12 @@ { "defaultValue": "", "name": "arg1", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "arg2", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -70378,7 +50401,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2", "functionName": "K", - "returnType": "numpy.ndarray[numpy.float64[2, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 3]\"]", "tooltip": "Returns the controller matrix K." }, { @@ -70391,12 +50414,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2", @@ -70414,7 +50437,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2", "functionName": "R", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns the reference vector r.\n\n:returns: The reference vector." }, { @@ -70427,7 +50450,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2", @@ -70445,7 +50468,7 @@ ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the control input vector u.\n\n:returns: The control input." }, { @@ -70458,7 +50481,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2", @@ -70476,12 +50499,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x." }, { @@ -70494,17 +50517,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2", "functionName": "calculate", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x.\n:param nextR: The next reference vector r." }, { @@ -70590,17 +50613,17 @@ { "defaultValue": "", "name": "Kp", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Ki", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Kd", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "0.02", @@ -70639,7 +50662,7 @@ { "defaultValue": "", "name": "measurement", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -70657,12 +50680,12 @@ { "defaultValue": "", "name": "measurement", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "setpoint", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -70693,12 +50716,12 @@ { "defaultValue": "", "name": "minimumInput", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "maximumInput", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -70955,7 +50978,7 @@ { "defaultValue": "", "name": "Kd", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -70973,7 +50996,7 @@ { "defaultValue": "", "name": "Ki", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -70991,7 +51014,7 @@ { "defaultValue": "", "name": "iZone", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -71009,12 +51032,12 @@ { "defaultValue": "", "name": "minimumIntegral", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "maximumIntegral", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -71032,7 +51055,7 @@ { "defaultValue": "", "name": "Kp", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -71050,17 +51073,17 @@ { "defaultValue": "", "name": "Kp", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Ki", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Kd", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -71078,7 +51101,7 @@ { "defaultValue": "", "name": "setpoint", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -71096,12 +51119,12 @@ { "defaultValue": "", "name": "errorTolerance", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "inf", "name": "errorDerivativeTolerance", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.PIDController", @@ -71123,17 +51146,17 @@ { "defaultValue": "", "name": "Kp", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Ki", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Kd", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -71582,7 +51605,7 @@ { "defaultValue": "", "name": "Kd", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDController", @@ -71636,7 +51659,7 @@ { "defaultValue": "", "name": "Ki", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDController", @@ -71654,7 +51677,7 @@ { "defaultValue": "", "name": "iZone", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDController", @@ -71672,12 +51695,12 @@ { "defaultValue": "", "name": "minimumIntegral", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "maximumIntegral", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDController", @@ -71695,7 +51718,7 @@ { "defaultValue": "", "name": "Kp", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDController", @@ -71713,17 +51736,17 @@ { "defaultValue": "", "name": "Kp", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Ki", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Kd", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDController", @@ -71768,17 +51791,17 @@ { "defaultValue": "", "name": "Kp", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Ki", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Kd", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -72227,7 +52250,7 @@ { "defaultValue": "", "name": "Kd", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians", @@ -72281,7 +52304,7 @@ { "defaultValue": "", "name": "Ki", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians", @@ -72299,7 +52322,7 @@ { "defaultValue": "", "name": "iZone", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians", @@ -72317,12 +52340,12 @@ { "defaultValue": "", "name": "minimumIntegral", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "maximumIntegral", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians", @@ -72340,7 +52363,7 @@ { "defaultValue": "", "name": "Kp", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians", @@ -72358,17 +52381,17 @@ { "defaultValue": "", "name": "Kp", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Ki", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "Kd", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians", @@ -72404,148 +52427,6 @@ "moduleName": "wpimath.controller", "staticMethods": [] }, - { - "className": "wpimath.controller.RamseteController", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "b", - "type": "float" - }, - { - "defaultValue": "", - "name": "zeta", - "type": "float" - } - ], - "declaringClassName": "wpimath.controller.RamseteController", - "functionName": "__init__", - "returnType": "wpimath.controller.RamseteController", - "tooltip": "Construct a Ramsete unicycle controller.\n\n:deprecated: Use LTVUnicycleController instead.\n\n:param b: Tuning parameter (b > 0 rad\u00b2/m\u00b2) for which larger values make\n convergence more aggressive like a proportional term.\n:param zeta: Tuning parameter (0 rad\u207b\u00b9 < zeta < 1 rad\u207b\u00b9) for which larger\n values provide more damping in response." - }, - { - "args": [], - "declaringClassName": "wpimath.controller.RamseteController", - "functionName": "__init__", - "returnType": "wpimath.controller.RamseteController", - "tooltip": "Construct a Ramsete unicycle controller. The default arguments for\nb and zeta of 2.0 rad\u00b2/m\u00b2 and 0.7 rad\u207b\u00b9 have been well-tested to produce\ndesirable results.\n\n:deprecated: Use LTVUnicycleController instead." - } - ], - "enums": [], - "instanceMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpimath.controller.RamseteController" - } - ], - "declaringClassName": "wpimath.controller.RamseteController", - "functionName": "atReference", - "returnType": "bool", - "tooltip": "Returns true if the pose error is within tolerance of the reference." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpimath.controller.RamseteController" - }, - { - "defaultValue": "", - "name": "currentPose", - "type": "wpimath.geometry.Pose2d" - }, - { - "defaultValue": "", - "name": "poseRef", - "type": "wpimath.geometry.Pose2d" - }, - { - "defaultValue": "", - "name": "linearVelocityRef", - "type": "wpimath.units.meters_per_second" - }, - { - "defaultValue": "", - "name": "angularVelocityRef", - "type": "wpimath.units.radians_per_second" - } - ], - "declaringClassName": "wpimath.controller.RamseteController", - "functionName": "calculate", - "returnType": "wpimath.kinematics.ChassisSpeeds", - "tooltip": "Returns the next output of the Ramsete controller.\n\nThe reference pose, linear velocity, and angular velocity should come from\na drivetrain trajectory.\n\n:param currentPose: The current pose.\n:param poseRef: The desired pose.\n:param linearVelocityRef: The desired linear velocity.\n:param angularVelocityRef: The desired angular velocity." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpimath.controller.RamseteController" - }, - { - "defaultValue": "", - "name": "currentPose", - "type": "wpimath.geometry.Pose2d" - }, - { - "defaultValue": "", - "name": "desiredState", - "type": "wpimath.trajectory.Trajectory.State" - } - ], - "declaringClassName": "wpimath.controller.RamseteController", - "functionName": "calculate", - "returnType": "wpimath.kinematics.ChassisSpeeds", - "tooltip": "Returns the next output of the Ramsete controller.\n\nThe reference pose, linear velocity, and angular velocity should come from\na drivetrain trajectory.\n\n:param currentPose: The current pose.\n:param desiredState: The desired pose, linear velocity, and angular velocity\n from a trajectory." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpimath.controller.RamseteController" - }, - { - "defaultValue": "", - "name": "enabled", - "type": "bool" - } - ], - "declaringClassName": "wpimath.controller.RamseteController", - "functionName": "setEnabled", - "returnType": "None", - "tooltip": "Enables and disables the controller for troubleshooting purposes.\n\n:param enabled: If the controller is enabled or not." - }, - { - "args": [ - { - "defaultValue": "", - "name": "self", - "type": "wpimath.controller.RamseteController" - }, - { - "defaultValue": "", - "name": "poseTolerance", - "type": "wpimath.geometry.Pose2d" - } - ], - "declaringClassName": "wpimath.controller.RamseteController", - "functionName": "setTolerance", - "returnType": "None", - "tooltip": "Sets the pose error which is considered tolerable for use with\nAtReference().\n\n:param poseTolerance: Pose error which is tolerable." - } - ], - "instanceVariables": [], - "moduleName": "wpimath.controller", - "staticMethods": [] - }, { "className": "wpimath.controller.SimpleMotorFeedforwardMeters", "classVariables": [], @@ -72765,6 +52646,60 @@ "functionName": "minAchievableVelocity", "returnType": "wpimath.units.meters_per_second", "tooltip": "Calculates the minimum achievable velocity given a maximum voltage supply\nand an acceleration. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the acceleration constraint, and this will give you\na simultaneously-achievable velocity constraint.\n\n:param maxVoltage: The maximum voltage that can be supplied to the motor.\n:param acceleration: The acceleration of the motor.\n\n:returns: The minimum possible velocity at the given acceleration." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.SimpleMotorFeedforwardMeters" + }, + { + "defaultValue": "", + "name": "kA", + "type": "wpimath.units.volt_seconds_squared_per_meter" + } + ], + "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters", + "functionName": "setKa", + "returnType": "None", + "tooltip": "Sets the acceleration gain.\n\n:param kA: The acceleration gain." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.SimpleMotorFeedforwardMeters" + }, + { + "defaultValue": "", + "name": "kS", + "type": "wpimath.units.volts" + } + ], + "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters", + "functionName": "setKs", + "returnType": "None", + "tooltip": "Sets the static gain.\n\n:param kS: The static gain." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.SimpleMotorFeedforwardMeters" + }, + { + "defaultValue": "", + "name": "kV", + "type": "wpimath.units.volt_seconds_per_meter" + } + ], + "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters", + "functionName": "setKv", + "returnType": "None", + "tooltip": "Sets the velocity gain.\n\n:param kV: The velocity gain." } ], "instanceVariables": [], @@ -72990,6 +52925,60 @@ "functionName": "minAchievableVelocity", "returnType": "wpimath.units.radians_per_second", "tooltip": "Calculates the minimum achievable velocity given a maximum voltage supply\nand an acceleration. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the acceleration constraint, and this will give you\na simultaneously-achievable velocity constraint.\n\n:param maxVoltage: The maximum voltage that can be supplied to the motor.\n:param acceleration: The acceleration of the motor.\n\n:returns: The minimum possible velocity at the given acceleration." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.SimpleMotorFeedforwardRadians" + }, + { + "defaultValue": "", + "name": "kA", + "type": "wpimath.units.volt_seconds_squared_per_radian" + } + ], + "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians", + "functionName": "setKa", + "returnType": "None", + "tooltip": "Sets the acceleration gain.\n\n:param kA: The acceleration gain." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.SimpleMotorFeedforwardRadians" + }, + { + "defaultValue": "", + "name": "kS", + "type": "wpimath.units.volts" + } + ], + "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians", + "functionName": "setKs", + "returnType": "None", + "tooltip": "Sets the static gain.\n\n:param kS: The static gain." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.controller.SimpleMotorFeedforwardRadians" + }, + { + "defaultValue": "", + "name": "kV", + "type": "wpimath.units.volt_seconds_per_radian" + } + ], + "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians", + "functionName": "setKv", + "returnType": "None", + "tooltip": "Sets the velocity gain.\n\n:param kV: The velocity gain." } ], "instanceVariables": [], @@ -73063,12 +53052,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator", @@ -73122,7 +53111,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase", @@ -73258,7 +53247,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase", @@ -73399,12 +53388,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3d", @@ -73458,7 +53447,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase", @@ -73594,7 +53583,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase", @@ -73687,12 +53676,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase", @@ -73746,7 +53735,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase", @@ -73877,7 +53866,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase", @@ -73960,12 +53949,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase", @@ -74019,7 +54008,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase", @@ -74150,7 +54139,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase", @@ -74223,22 +54212,22 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", "name": "h", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", "name": "measurementStdDevs", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -74256,32 +54245,32 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", "name": "h", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", "name": "measurementStdDevs", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", "name": "residualFuncY", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", "name": "addFuncX", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", @@ -74307,7 +54296,7 @@ ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1", "functionName": "P", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the error covariance matrix P." }, { @@ -74320,12 +54309,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1", @@ -74343,12 +54332,12 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1", @@ -74366,17 +54355,17 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1", @@ -74394,7 +54383,7 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -74430,7 +54419,7 @@ { "defaultValue": "", "name": "P", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1", @@ -74448,7 +54437,7 @@ { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1", @@ -74466,12 +54455,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1", @@ -74489,7 +54478,7 @@ ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the state estimate x-hat." }, { @@ -74502,7 +54491,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1", @@ -74524,22 +54513,22 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", "name": "h", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "measurementStdDevs", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -74557,32 +54546,32 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", "name": "h", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "measurementStdDevs", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", "name": "residualFuncY", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", "name": "addFuncX", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", @@ -74608,7 +54597,7 @@ ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1", "functionName": "P", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the error covariance matrix P." }, { @@ -74621,12 +54610,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1", @@ -74644,12 +54633,12 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1", @@ -74667,17 +54656,17 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1", @@ -74695,7 +54684,7 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -74731,7 +54720,7 @@ { "defaultValue": "", "name": "P", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1", @@ -74749,7 +54738,7 @@ { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1", @@ -74767,12 +54756,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1", @@ -74790,7 +54779,7 @@ ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the state estimate x-hat." }, { @@ -74803,7 +54792,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1", @@ -74816,6 +54805,307 @@ "moduleName": "wpimath.estimator", "staticMethods": [] }, + { + "className": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "classVariables": [], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "f", + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" + }, + { + "defaultValue": "", + "name": "h", + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" + }, + { + "defaultValue": "", + "name": "stateStdDevs", + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" + }, + { + "defaultValue": "", + "name": "measurementStdDevs", + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "__init__", + "returnType": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "tooltip": "Constructs an extended Kalman filter.\n\nSee\nhttps://docs.wpilib.org/en/stable/docs/software/advanced-controls/state-space/state-space-observers.html#process-and-measurement-noise-covariance-matrices\nfor how to select the standard deviations.\n\n:param f: A vector-valued function of x and u that returns\n the derivative of the state vector.\n:param h: A vector-valued function of x and u that returns\n the measurement vector.\n:param stateStdDevs: Standard deviations of model states.\n:param measurementStdDevs: Standard deviations of measurements.\n:param dt: Nominal discretization timestep." + }, + { + "args": [ + { + "defaultValue": "", + "name": "f", + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" + }, + { + "defaultValue": "", + "name": "h", + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" + }, + { + "defaultValue": "", + "name": "stateStdDevs", + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" + }, + { + "defaultValue": "", + "name": "measurementStdDevs", + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" + }, + { + "defaultValue": "", + "name": "residualFuncY", + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" + }, + { + "defaultValue": "", + "name": "addFuncX", + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "__init__", + "returnType": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "tooltip": "Constructs an extended Kalman filter.\n\nSee\nhttps://docs.wpilib.org/en/stable/docs/software/advanced-controls/state-space/state-space-observers.html#process-and-measurement-noise-covariance-matrices\nfor how to select the standard deviations.\n\n:param f: A vector-valued function of x and u that returns\n the derivative of the state vector.\n:param h: A vector-valued function of x and u that returns\n the measurement vector.\n:param stateStdDevs: Standard deviations of model states.\n:param measurementStdDevs: Standard deviations of measurements.\n:param residualFuncY: A function that computes the residual of two\n measurement vectors (i.e. it subtracts them.)\n:param addFuncX: A function that adds two state vectors.\n:param dt: Nominal discretization timestep." + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "P", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", + "tooltip": "Returns the error covariance matrix P." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "i", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "j", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "P", + "returnType": "float", + "tooltip": "Returns an element of the error covariance matrix P.\n\n:param i: Row of P.\n:param j: Column of P." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" + }, + { + "defaultValue": "", + "name": "y", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "correct", + "returnType": "None", + "tooltip": "Correct the state estimate x-hat using the measurements in y.\n\n:param u: Same control input used in the predict step.\n:param y: Measurement vector." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" + }, + { + "defaultValue": "", + "name": "y", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" + }, + { + "defaultValue": "", + "name": "R", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "correct", + "returnType": "None", + "tooltip": "Correct the state estimate x-hat using the measurements in y.\n\nThis is useful for when the measurement noise covariances vary.\n\n:param u: Same control input used in the predict step.\n:param y: Measurement vector.\n:param R: Continuous measurement noise covariance matrix." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "predict", + "returnType": "None", + "tooltip": "Project the model into the future with a new control input u.\n\n:param u: New control input from controller.\n:param dt: Timestep for prediction." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "reset", + "returnType": "None", + "tooltip": "Resets the observer." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "P", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "setP", + "returnType": "None", + "tooltip": "Set the current error covariance matrix P.\n\n:param P: The error covariance matrix P." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "xHat", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "setXhat", + "returnType": "None", + "tooltip": "Set initial state estimate x-hat.\n\n:param xHat: The state estimate x-hat." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "i", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsFloat" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "setXhat", + "returnType": "None", + "tooltip": "Set an element of the initial state estimate x-hat.\n\n:param i: Row of x-hat.\n:param value: Value for element of x-hat." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "xhat", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", + "tooltip": "Returns the state estimate x-hat." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "i", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_2", + "functionName": "xhat", + "returnType": "float", + "tooltip": "Returns an element of the state estimate x-hat.\n\n:param i: Row of x-hat." + } + ], + "instanceVariables": [], + "moduleName": "wpimath.estimator", + "staticMethods": [] + }, { "className": "wpimath.estimator.ExtendedKalmanFilter_2_2_2", "classVariables": [], @@ -74825,22 +55115,22 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", "name": "h", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "measurementStdDevs", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -74858,32 +55148,32 @@ { "defaultValue": "", "name": "f", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", "name": "h", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "measurementStdDevs", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "residualFuncY", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", "name": "addFuncX", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"], typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", @@ -74909,7 +55199,7 @@ ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2", "functionName": "P", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the error covariance matrix P." }, { @@ -74922,12 +55212,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2", @@ -74945,12 +55235,12 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2", @@ -74968,17 +55258,17 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2", @@ -74996,7 +55286,7 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -75032,7 +55322,7 @@ { "defaultValue": "", "name": "P", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2", @@ -75050,7 +55340,7 @@ { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2", @@ -75068,12 +55358,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2", @@ -75091,7 +55381,7 @@ ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the state estimate x-hat." }, { @@ -75104,7 +55394,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2", @@ -75131,12 +55421,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", "name": "measurementStdDevs", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -75162,7 +55452,7 @@ ], "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1", "functionName": "P", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the error covariance matrix P." }, { @@ -75175,12 +55465,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1", @@ -75198,12 +55488,12 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1", @@ -75221,17 +55511,17 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1", @@ -75249,7 +55539,7 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -75285,7 +55575,7 @@ { "defaultValue": "", "name": "P", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1", @@ -75303,7 +55593,7 @@ { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1", @@ -75321,12 +55611,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1", @@ -75344,7 +55634,7 @@ ], "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the state estimate x-hat." }, { @@ -75357,7 +55647,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1", @@ -75384,12 +55674,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "measurementStdDevs", - "type": "Tuple[float]" + "type": "Tuple[typing.SupportsFloat]" }, { "defaultValue": "", @@ -75415,7 +55705,7 @@ ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1", "functionName": "P", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the error covariance matrix P." }, { @@ -75428,12 +55718,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1", @@ -75451,12 +55741,12 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1", @@ -75474,17 +55764,17 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1", @@ -75502,7 +55792,7 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -75538,7 +55828,7 @@ { "defaultValue": "", "name": "P", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1", @@ -75556,7 +55846,7 @@ { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1", @@ -75574,12 +55864,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1", @@ -75597,7 +55887,7 @@ ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the state estimate x-hat." }, { @@ -75610,7 +55900,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1", @@ -75623,6 +55913,259 @@ "moduleName": "wpimath.estimator", "staticMethods": [] }, + { + "className": "wpimath.estimator.KalmanFilter_2_1_2", + "classVariables": [], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "plant", + "type": "wpimath.system.LinearSystem_2_1_2" + }, + { + "defaultValue": "", + "name": "stateStdDevs", + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" + }, + { + "defaultValue": "", + "name": "measurementStdDevs", + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "__init__", + "returnType": "wpimath.estimator.KalmanFilter_2_1_2", + "tooltip": "Constructs a Kalman filter with the given plant.\n\nSee\nhttps://docs.wpilib.org/en/stable/docs/software/advanced-controls/state-space/state-space-observers.html#process-and-measurement-noise-covariance-matrices\nfor how to select the standard deviations.\n\n:param plant: The plant used for the prediction step.\n:param stateStdDevs: Standard deviations of model states.\n:param measurementStdDevs: Standard deviations of measurements.\n:param dt: Nominal discretization timestep.\n @throws std::invalid_argument If the system is undetectable." + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "P", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", + "tooltip": "Returns the error covariance matrix P." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "i", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "j", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "P", + "returnType": "float", + "tooltip": "Returns an element of the error covariance matrix P.\n\n:param i: Row of P.\n:param j: Column of P." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" + }, + { + "defaultValue": "", + "name": "y", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "correct", + "returnType": "None", + "tooltip": "Correct the state estimate x-hat using the measurements in y.\n\n:param u: Same control input used in the predict step.\n:param y: Measurement vector." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" + }, + { + "defaultValue": "", + "name": "y", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" + }, + { + "defaultValue": "", + "name": "R", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "correct", + "returnType": "None", + "tooltip": "Correct the state estimate x-hat using the measurements in y.\n\nThis is useful for when the measurement noise covariances vary.\n\n:param u: Same control input used in the predict step.\n:param y: Measurement vector.\n:param R: Continuous measurement noise covariance matrix." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "predict", + "returnType": "None", + "tooltip": "Project the model into the future with a new control input u.\n\n:param u: New control input from controller.\n:param dt: Timestep for prediction." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "reset", + "returnType": "None", + "tooltip": "Resets the observer." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "P", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "setP", + "returnType": "None", + "tooltip": "Set the current error covariance matrix P.\n\n:param P: The error covariance matrix P." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "xHat", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "setXhat", + "returnType": "None", + "tooltip": "Set initial state estimate x-hat.\n\n:param xHat: The state estimate x-hat." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "i", + "type": "typing.SupportsInt" + }, + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsFloat" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "setXhat", + "returnType": "None", + "tooltip": "Set an element of the initial state estimate x-hat.\n\n:param i: Row of x-hat.\n:param value: Value for element of x-hat." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "xhat", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", + "tooltip": "Returns the state estimate x-hat." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.estimator.KalmanFilter_2_1_2" + }, + { + "defaultValue": "", + "name": "i", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_2", + "functionName": "xhat", + "returnType": "float", + "tooltip": "Returns an element of the state estimate x-hat.\n\n:param i: Row of x-hat." + } + ], + "instanceVariables": [], + "moduleName": "wpimath.estimator", + "staticMethods": [] + }, { "className": "wpimath.estimator.KalmanFilter_2_2_2", "classVariables": [], @@ -75637,12 +56180,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "measurementStdDevs", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -75668,7 +56211,7 @@ ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2", "functionName": "P", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the error covariance matrix P." }, { @@ -75681,12 +56224,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2", @@ -75704,12 +56247,12 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2", @@ -75727,17 +56270,17 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2", @@ -75755,7 +56298,7 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -75791,7 +56334,7 @@ { "defaultValue": "", "name": "P", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2", @@ -75809,7 +56352,7 @@ { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2", @@ -75827,12 +56370,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2", @@ -75850,7 +56393,7 @@ ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the state estimate x-hat." }, { @@ -75863,7 +56406,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2", @@ -75890,12 +56433,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "measurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", @@ -75921,7 +56464,7 @@ ], "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3", "functionName": "P", - "returnType": "numpy.ndarray[numpy.float64[3, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 3]\"]", "tooltip": "Returns the error covariance matrix P." }, { @@ -75934,12 +56477,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3", @@ -75957,12 +56500,12 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3", @@ -75980,17 +56523,17 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "R", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3", @@ -76008,7 +56551,7 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -76044,7 +56587,7 @@ { "defaultValue": "", "name": "P", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3", @@ -76062,7 +56605,7 @@ { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3", @@ -76080,12 +56623,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3", @@ -76103,7 +56646,7 @@ ], "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns the state estimate x-hat." }, { @@ -76116,7 +56659,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3", @@ -76186,12 +56729,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator", @@ -76245,7 +56788,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase", @@ -76376,7 +56919,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase", @@ -76497,12 +57040,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3d", @@ -76556,7 +57099,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase", @@ -76687,7 +57230,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase", @@ -76770,12 +57313,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase", @@ -76829,7 +57372,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase", @@ -76960,7 +57503,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase", @@ -77043,12 +57586,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase", @@ -77102,7 +57645,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase", @@ -77233,7 +57776,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase", @@ -77354,12 +57897,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator", @@ -77413,7 +57956,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase", @@ -77544,7 +58087,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase", @@ -77665,12 +58208,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3d", @@ -77724,7 +58267,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase", @@ -77855,7 +58398,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase", @@ -77938,12 +58481,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase", @@ -77997,7 +58540,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase", @@ -78128,7 +58671,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase", @@ -78211,12 +58754,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase", @@ -78270,7 +58813,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase", @@ -78401,7 +58944,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase", @@ -78522,12 +59065,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator", @@ -78581,7 +59124,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase", @@ -78712,7 +59255,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase", @@ -78833,12 +59376,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3d", @@ -78892,7 +59435,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase", @@ -79023,7 +59566,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase", @@ -79106,12 +59649,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase", @@ -79165,7 +59708,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase", @@ -79296,7 +59839,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase", @@ -79379,12 +59922,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase", @@ -79438,7 +59981,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase", @@ -79569,7 +60112,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase", @@ -79690,12 +60233,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator", @@ -79749,7 +60292,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase", @@ -79880,7 +60423,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase", @@ -80001,12 +60544,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3d", @@ -80060,7 +60603,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase", @@ -80191,7 +60734,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase", @@ -80274,12 +60817,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase", @@ -80333,7 +60876,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase", @@ -80464,7 +61007,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase", @@ -80547,12 +61090,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase", @@ -80606,7 +61149,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase", @@ -80737,7 +61280,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase", @@ -80858,12 +61401,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator", @@ -80917,7 +61460,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase", @@ -81048,7 +61591,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase", @@ -81169,12 +61712,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3d", @@ -81228,7 +61771,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase", @@ -81359,7 +61902,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase", @@ -81442,12 +61985,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase", @@ -81501,7 +62044,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase", @@ -81632,7 +62175,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase", @@ -81715,12 +62258,12 @@ { "defaultValue": "", "name": "stateStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase", @@ -81774,7 +62317,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase", @@ -81905,7 +62448,7 @@ { "defaultValue": "", "name": "visionMeasurementStdDevs", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase", @@ -81992,18 +62535,7 @@ "tooltip": "Creates a new Debouncer.\n\n:param debounceTime: The number of seconds the value must change from\n baseline for the filtered value to change.\n:param type: Which type of state change the debouncing will be\n performed on." } ], - "enums": [ - { - "enumClassName": "wpimath.filter.Debouncer.DebounceType", - "enumValues": [ - "kBoth", - "kFalling", - "kRising" - ], - "moduleName": "wpimath.filter", - "tooltip": "Type of debouncing to perform.\n\nMembers:\n\n kRising : Rising edge.\n\n kFalling : Falling edge.\n\n kBoth : Both rising and falling edges." - } - ], + "enums": [], "instanceMethods": [ { "args": [ @@ -82022,12 +62554,130 @@ "functionName": "calculate", "returnType": "bool", "tooltip": "Applies the debouncer to the input stream.\n\n:param input: The current value of the input stream.\n\n:returns: The debounced value of the input stream." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.filter.Debouncer" + } + ], + "declaringClassName": "wpimath.filter.Debouncer", + "functionName": "getDebounceTime", + "returnType": "wpimath.units.seconds", + "tooltip": "Gets the time to debounce.\n\n:returns: The number of seconds the value must change from baseline\n for the filtered value to change." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.filter.Debouncer" + } + ], + "declaringClassName": "wpimath.filter.Debouncer", + "functionName": "getDebounceType", + "returnType": "wpimath.filter.Debouncer.DebounceType", + "tooltip": "Get the debounce type.\n\n:returns: Which type of state change the debouncing will be performed on." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.filter.Debouncer" + }, + { + "defaultValue": "", + "name": "time", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpimath.filter.Debouncer", + "functionName": "setDebounceTime", + "returnType": "None", + "tooltip": "Sets the time to debounce.\n\n:param time: The number of seconds the value must change from baseline\n for the filtered value to change." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.filter.Debouncer" + }, + { + "defaultValue": "", + "name": "type", + "type": "wpimath.filter.Debouncer.DebounceType" + } + ], + "declaringClassName": "wpimath.filter.Debouncer", + "functionName": "setDebounceType", + "returnType": "None", + "tooltip": "Set the debounce type.\n\n:param type: Which type of state change the debouncing will be performed on." } ], "instanceVariables": [], "moduleName": "wpimath.filter", "staticMethods": [] }, + { + "className": "wpimath.filter.Debouncer.DebounceType", + "classVariables": [ + { + "name": "kBoth", + "tooltip": "", + "type": "wpimath.filter.Debouncer.DebounceType", + "writable": false + }, + { + "name": "kFalling", + "tooltip": "", + "type": "wpimath.filter.Debouncer.DebounceType", + "writable": false + }, + { + "name": "kRising", + "tooltip": "", + "type": "wpimath.filter.Debouncer.DebounceType", + "writable": false + } + ], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "value", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpimath.filter.Debouncer.DebounceType", + "functionName": "__init__", + "returnType": "wpimath.filter.Debouncer.DebounceType", + "tooltip": "" + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [ + { + "name": "name", + "tooltip": "name(self: object, /) -> str\n", + "type": "str", + "writable": false + }, + { + "name": "value", + "tooltip": "", + "type": "int", + "writable": false + } + ], + "moduleName": "wpimath.filter", + "staticMethods": [] + }, { "className": "wpimath.filter.LinearFilter", "classVariables": [], @@ -82037,12 +62687,12 @@ { "defaultValue": "", "name": "ffGains", - "type": "List[float]" + "type": "List[typing.SupportsFloat]" }, { "defaultValue": "", "name": "fbGains", - "type": "List[float]" + "type": "List[typing.SupportsFloat]" } ], "declaringClassName": "wpimath.filter.LinearFilter", @@ -82063,7 +62713,7 @@ { "defaultValue": "", "name": "input", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.filter.LinearFilter", @@ -82107,12 +62757,12 @@ { "defaultValue": "", "name": "inputBuffer", - "type": "List[float]" + "type": "List[typing.SupportsFloat]" }, { "defaultValue": "", "name": "outputBuffer", - "type": "List[float]" + "type": "List[typing.SupportsFloat]" } ], "declaringClassName": "wpimath.filter.LinearFilter", @@ -82129,7 +62779,7 @@ { "defaultValue": "", "name": "timeConstant", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -82147,7 +62797,7 @@ { "defaultValue": "", "name": "taps", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.filter.LinearFilter", @@ -82160,7 +62810,7 @@ { "defaultValue": "", "name": "timeConstant", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -82184,7 +62834,7 @@ { "defaultValue": "", "name": "size", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.filter.MedianFilter", @@ -82205,7 +62855,7 @@ { "defaultValue": "", "name": "next", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.filter.MedianFilter", @@ -82350,17 +63000,17 @@ { "defaultValue": "", "name": "x", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "y", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "z", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.geometry.CoordinateAxis", @@ -82603,7 +63253,7 @@ { "defaultValue": "", "name": "radius", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.geometry.Ellipse2d", @@ -82971,7 +63621,7 @@ "declaringClassName": "wpimath.geometry.Pose2d", "functionName": "nearest", "returnType": "wpimath.geometry.Pose2d", - "tooltip": "Returns the nearest Pose2d from a collection of poses\n\n:param poses: The collection of poses.\n\n:returns: The nearest Pose2d from the collection." + "tooltip": "Returns the nearest Pose2d from a collection of poses.\n\nIf two or more poses in the collection have the same distance from this\npose, return the one with the closest rotation component.\n\n:param poses: The collection of poses.\n\n:returns: The nearest Pose2d from the collection." }, { "args": [ @@ -82991,6 +63641,29 @@ "returnType": "wpimath.geometry.Pose2d", "tooltip": "Returns the current pose relative to the given pose.\n\nThis function can often be used for trajectory tracking or pose\nstabilization algorithms to get the error between the reference and the\ncurrent pose.\n\n:param other: The pose that is the origin of the new coordinate frame that\n the current pose will be converted into.\n\n:returns: The current pose relative to the new origin pose." }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.geometry.Pose2d" + }, + { + "defaultValue": "", + "name": "point", + "type": "wpimath.geometry.Translation2d" + }, + { + "defaultValue": "", + "name": "rot", + "type": "wpimath.geometry.Rotation2d" + } + ], + "declaringClassName": "wpimath.geometry.Pose2d", + "functionName": "rotateAround", + "returnType": "wpimath.geometry.Pose2d", + "tooltip": "Rotates the current pose around a point in 2D space.\n\n:param point: The point in 2D space to rotate around.\n:param rot: The rotation to rotate the pose by.\n\n:returns: The new rotated pose." + }, { "args": [ { @@ -83032,7 +63705,7 @@ ], "declaringClassName": "wpimath.geometry.Pose2d", "functionName": "toMatrix", - "returnType": "numpy.ndarray[numpy.float64[3, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 3]\"]", "tooltip": "Returns an affine transformation matrix representation of this pose." }, { @@ -83146,7 +63819,7 @@ { "defaultValue": "", "name": "matrix", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" } ], "declaringClassName": "wpimath.geometry.Pose2d", @@ -83304,6 +63977,24 @@ "returnType": "wpimath.geometry.Twist3d", "tooltip": "Returns a Twist3d that maps this pose to the end pose. If c is the output\nof a.Log(b), then a.Exp(c) would yield b.\n\n:param end: The end pose for the transformation.\n\n:returns: The twist that maps this to end." }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.geometry.Pose3d" + }, + { + "defaultValue": "", + "name": "poses", + "type": "List[wpimath.geometry.Pose3d]" + } + ], + "declaringClassName": "wpimath.geometry.Pose3d", + "functionName": "nearest", + "returnType": "wpimath.geometry.Pose3d", + "tooltip": "Returns the nearest Pose3d from a collection of poses.\n\nIf two or more poses in the collection have the same distance from this\npose, return the one with the closest rotation component.\n\n:param poses: The collection of poses.\n\n:returns: The nearest Pose3d from the collection." + }, { "args": [ { @@ -83322,6 +64013,29 @@ "returnType": "wpimath.geometry.Pose3d", "tooltip": "Returns the current pose relative to the given pose.\n\nThis function can often be used for trajectory tracking or pose\nstabilization algorithms to get the error between the reference and the\ncurrent pose.\n\n:param other: The pose that is the origin of the new coordinate frame that\n the current pose will be converted into.\n\n:returns: The current pose relative to the new origin pose." }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.geometry.Pose3d" + }, + { + "defaultValue": "", + "name": "point", + "type": "wpimath.geometry.Translation3d" + }, + { + "defaultValue": "", + "name": "rot", + "type": "wpimath.geometry.Rotation3d" + } + ], + "declaringClassName": "wpimath.geometry.Pose3d", + "functionName": "rotateAround", + "returnType": "wpimath.geometry.Pose3d", + "tooltip": "Rotates the current pose around a point in 3D space.\n\n:param point: The point in 3D space to rotate around.\n:param rot: The rotation to rotate the pose by.\n\n:returns: The new rotated pose." + }, { "args": [ { @@ -83363,7 +64077,7 @@ ], "declaringClassName": "wpimath.geometry.Pose3d", "functionName": "toMatrix", - "returnType": "numpy.ndarray[numpy.float64[4, 4]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[4, 4]\"]", "tooltip": "Returns an affine transformation matrix representation of this pose." }, { @@ -83484,7 +64198,7 @@ { "defaultValue": "", "name": "matrix", - "type": "numpy.ndarray[numpy.float64[4, 4]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[4, 4]\"]" } ], "declaringClassName": "wpimath.geometry.Pose3d", @@ -83510,22 +64224,22 @@ { "defaultValue": "", "name": "w", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "x", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "y", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "z", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.geometry.Quaternion", @@ -83730,7 +64444,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.geometry.Quaternion", @@ -83748,7 +64462,7 @@ ], "declaringClassName": "wpimath.geometry.Quaternion", "functionName": "toRotationVector", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns the rotation vector representation of this quaternion.\n\nThis is also the log operator of SO(3)." } ], @@ -83760,7 +64474,7 @@ { "defaultValue": "", "name": "rvec", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.geometry.Quaternion", @@ -84035,12 +64749,12 @@ { "defaultValue": "", "name": "x", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "y", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.geometry.Rotation2d", @@ -84075,7 +64789,7 @@ "declaringClassName": "wpimath.geometry.Rotation2d", "functionName": "degrees", "returnType": "wpimath.units.degrees", - "tooltip": "Returns the degree value of the rotation.\n\n:returns: The degree value of the rotation.\n @see InputModulus to constrain the angle within (-180, 180]" + "tooltip": "Returns the degree value of the rotation constrained within [-180, 180].\n\n:returns: The degree value of the rotation constrained within [-180, 180]." }, { "args": [ @@ -84088,7 +64802,7 @@ "declaringClassName": "wpimath.geometry.Rotation2d", "functionName": "radians", "returnType": "wpimath.units.radians", - "tooltip": "Returns the radian value of the rotation.\n\n:returns: The radian value of the rotation.\n @see AngleModulus to constrain the angle within (-\u03c0, \u03c0]" + "tooltip": "Returns the radian value of the rotation constrained within [-\u03c0, \u03c0].\n\n:returns: The radian value of the rotation constrained within [-\u03c0, \u03c0]." }, { "args": [ @@ -84144,7 +64858,7 @@ ], "declaringClassName": "wpimath.geometry.Rotation2d", "functionName": "toMatrix", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns matrix representation of this rotation." } ], @@ -84169,7 +64883,7 @@ { "defaultValue": "", "name": "rotationMatrix", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" } ], "declaringClassName": "wpimath.geometry.Rotation2d", @@ -84244,7 +64958,7 @@ { "defaultValue": "", "name": "axis", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", @@ -84262,7 +64976,7 @@ { "defaultValue": "", "name": "rvec", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.geometry.Rotation3d", @@ -84275,7 +64989,7 @@ { "defaultValue": "", "name": "rotationMatrix", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" } ], "declaringClassName": "wpimath.geometry.Rotation3d", @@ -84288,12 +65002,12 @@ { "defaultValue": "", "name": "initial", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "final", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.geometry.Rotation3d", @@ -84366,7 +65080,7 @@ ], "declaringClassName": "wpimath.geometry.Rotation3d", "functionName": "axis", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns the axis in the axis-angle representation of this rotation." }, { @@ -84410,7 +65124,7 @@ ], "declaringClassName": "wpimath.geometry.Rotation3d", "functionName": "toMatrix", - "returnType": "numpy.ndarray[numpy.float64[3, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 3]\"]", "tooltip": "Returns rotation matrix representation of this rotation." }, { @@ -84436,7 +65150,7 @@ ], "declaringClassName": "wpimath.geometry.Rotation3d", "functionName": "toVector", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns rotation vector representation of this rotation.\n\n:returns: Rotation vector representation of this rotation." } ], @@ -84675,7 +65389,7 @@ ], "declaringClassName": "wpimath.geometry.Transform2d", "functionName": "toMatrix", - "returnType": "numpy.ndarray[numpy.float64[3, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 3]\"]", "tooltip": "Returns an affine transformation matrix representation of this\ntransformation." }, { @@ -84748,7 +65462,7 @@ { "defaultValue": "", "name": "matrix", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" } ], "declaringClassName": "wpimath.geometry.Transform2d", @@ -84924,7 +65638,7 @@ ], "declaringClassName": "wpimath.geometry.Transform3d", "functionName": "toMatrix", - "returnType": "numpy.ndarray[numpy.float64[4, 4]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[4, 4]\"]", "tooltip": "Returns an affine transformation matrix representation of this\ntransformation." }, { @@ -84986,7 +65700,7 @@ { "defaultValue": "", "name": "matrix", - "type": "numpy.ndarray[numpy.float64[4, 4]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[4, 4]\"]" } ], "declaringClassName": "wpimath.geometry.Transform3d", @@ -85048,7 +65762,7 @@ { "defaultValue": "", "name": "vector", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.geometry.Translation2d", @@ -85229,7 +65943,7 @@ ], "declaringClassName": "wpimath.geometry.Translation2d", "functionName": "toVector", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns a 2D translation vector representation of this translation.\n\n:returns: A 2D translation vector representation of this translation." } ], @@ -85356,7 +66070,7 @@ { "defaultValue": "", "name": "vector", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.geometry.Translation3d", @@ -85455,6 +66169,24 @@ "returnType": "wpimath.units.feet", "tooltip": "" }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.geometry.Translation3d" + }, + { + "defaultValue": "", + "name": "translations", + "type": "List[wpimath.geometry.Translation3d]" + } + ], + "declaringClassName": "wpimath.geometry.Translation3d", + "functionName": "nearest", + "returnType": "wpimath.geometry.Translation3d", + "tooltip": "Returns the nearest Translation3d from a collection of translations\n\n:param translations: The collection of translations.\n\n:returns: The nearest Translation3d from the collection." + }, { "args": [ { @@ -85481,6 +66213,29 @@ "returnType": "wpimath.units.feet", "tooltip": "" }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.geometry.Translation3d" + }, + { + "defaultValue": "", + "name": "other", + "type": "wpimath.geometry.Translation3d" + }, + { + "defaultValue": "", + "name": "rot", + "type": "wpimath.geometry.Rotation3d" + } + ], + "declaringClassName": "wpimath.geometry.Translation3d", + "functionName": "rotateAround", + "returnType": "wpimath.geometry.Translation3d", + "tooltip": "Rotates this translation around another translation in 3D space.\n\n:param other: The other translation to rotate around.\n:param rot: The rotation to rotate the translation by.\n\n:returns: The new rotated translation." + }, { "args": [ { @@ -85522,7 +66277,7 @@ ], "declaringClassName": "wpimath.geometry.Translation3d", "functionName": "toVector", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns a 3D translation vector representation of this translation.\n\n:returns: A 3D translation vector representation of this translation." } ], @@ -85861,7 +66616,7 @@ { "defaultValue": "", "name": "func", - "type": "Callable[[float, float, float], float]" + "type": "Callable[[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat], float]" } ], "declaringClassName": "wpimath.interpolation.TimeInterpolatableFloatBuffer", @@ -85900,7 +66655,7 @@ { "defaultValue": "", "name": "sample", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.interpolation.TimeInterpolatableFloatBuffer", @@ -85971,7 +66726,7 @@ { "defaultValue": "", "name": "func", - "type": "Callable[[wpimath.geometry.Pose2d, wpimath.geometry.Pose2d, float], wpimath.geometry.Pose2d]" + "type": "Callable[[wpimath.geometry.Pose2d, wpimath.geometry.Pose2d, typing.SupportsFloat], wpimath.geometry.Pose2d]" } ], "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose2dBuffer", @@ -86081,7 +66836,7 @@ { "defaultValue": "", "name": "func", - "type": "Callable[[wpimath.geometry.Pose3d, wpimath.geometry.Pose3d, float], wpimath.geometry.Pose3d]" + "type": "Callable[[wpimath.geometry.Pose3d, wpimath.geometry.Pose3d, typing.SupportsFloat], wpimath.geometry.Pose3d]" } ], "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose3dBuffer", @@ -86191,7 +66946,7 @@ { "defaultValue": "", "name": "func", - "type": "Callable[[wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d, float], wpimath.geometry.Rotation2d]" + "type": "Callable[[wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d, typing.SupportsFloat], wpimath.geometry.Rotation2d]" } ], "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer", @@ -86301,7 +67056,7 @@ { "defaultValue": "", "name": "func", - "type": "Callable[[wpimath.geometry.Rotation3d, wpimath.geometry.Rotation3d, float], wpimath.geometry.Rotation3d]" + "type": "Callable[[wpimath.geometry.Rotation3d, wpimath.geometry.Rotation3d, typing.SupportsFloat], wpimath.geometry.Rotation3d]" } ], "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer", @@ -86411,7 +67166,7 @@ { "defaultValue": "", "name": "func", - "type": "Callable[[wpimath.geometry.Translation2d, wpimath.geometry.Translation2d, float], wpimath.geometry.Translation2d]" + "type": "Callable[[wpimath.geometry.Translation2d, wpimath.geometry.Translation2d, typing.SupportsFloat], wpimath.geometry.Translation2d]" } ], "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer", @@ -86521,7 +67276,7 @@ { "defaultValue": "", "name": "func", - "type": "Callable[[wpimath.geometry.Translation3d, wpimath.geometry.Translation3d, float], wpimath.geometry.Translation3d]" + "type": "Callable[[wpimath.geometry.Translation3d, wpimath.geometry.Translation3d, typing.SupportsFloat], wpimath.geometry.Translation3d]" } ], "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer", @@ -86647,6 +67402,60 @@ ], "enums": [], "instanceMethods": [ + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.kinematics.ChassisSpeeds" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpimath.kinematics.ChassisSpeeds", + "functionName": "discretize", + "returnType": "wpimath.kinematics.ChassisSpeeds", + "tooltip": "Discretizes a continuous-time chassis speed.\n\nThis function converts a continuous-time chassis speed into a discrete-time\none such that when the discrete-time chassis speed is applied for one\ntimestep, the robot moves as if the velocity components are independent\n(i.e., the robot moves v_x * dt along the x-axis, v_y * dt along the\ny-axis, and omega * dt around the z-axis).\n\nThis is useful for compensating for translational skew when translating and\nrotating a holonomic (swerve or mecanum) drivetrain. However, scaling down\nthe ChassisSpeeds after discretizing (e.g., when desaturating swerve module\nspeeds) rotates the direction of net motion in the opposite direction of\nrotational velocity, introducing a different translational skew which is\nnot accounted for by discretization.\n\n:param dt: The duration of the timestep the speeds should be applied for.\n\n:returns: Discretized ChassisSpeeds." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.kinematics.ChassisSpeeds" + }, + { + "defaultValue": "", + "name": "robotAngle", + "type": "wpimath.geometry.Rotation2d" + } + ], + "declaringClassName": "wpimath.kinematics.ChassisSpeeds", + "functionName": "toFieldRelative", + "returnType": "wpimath.kinematics.ChassisSpeeds", + "tooltip": "Converts this robot-relative set of speeds into a field-relative\nChassisSpeeds object.\n\n:param robotAngle: The angle of the robot as measured by a gyroscope. The\n robot's angle is considered to be zero when it is facing directly away\n from your alliance station wall. Remember that this should be CCW\n positive.\n\n:returns: ChassisSpeeds object representing the speeds in the field's frame\n of reference." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.kinematics.ChassisSpeeds" + }, + { + "defaultValue": "", + "name": "robotAngle", + "type": "wpimath.geometry.Rotation2d" + } + ], + "declaringClassName": "wpimath.kinematics.ChassisSpeeds", + "functionName": "toRobotRelative", + "returnType": "wpimath.kinematics.ChassisSpeeds", + "tooltip": "Converts this field-relative set of speeds into a robot-relative\nChassisSpeeds object.\n\n:param robotAngle: The angle of the robot as measured by a gyroscope. The\n robot's angle is considered to be zero when it is facing directly away\n from your alliance station wall. Remember that this should be CCW\n positive.\n\n:returns: ChassisSpeeds object representing the speeds in the robot's frame\n of reference." + }, { "args": [ { @@ -86706,52 +67515,6 @@ ], "moduleName": "wpimath.kinematics", "staticMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "vx", - "type": "wpimath.units.meters_per_second" - }, - { - "defaultValue": "", - "name": "vy", - "type": "wpimath.units.meters_per_second" - }, - { - "defaultValue": "", - "name": "omega", - "type": "wpimath.units.radians_per_second" - }, - { - "defaultValue": "", - "name": "dt", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpimath.kinematics.ChassisSpeeds", - "functionName": "discretize", - "returnType": "wpimath.kinematics.ChassisSpeeds", - "tooltip": "Discretizes a continuous-time chassis speed.\n\nThis function converts a continuous-time chassis speed into a discrete-time\none such that when the discrete-time chassis speed is applied for one\ntimestep, the robot moves as if the velocity components are independent\n(i.e., the robot moves v_x * dt along the x-axis, v_y * dt along the\ny-axis, and omega * dt around the z-axis).\n\nThis is useful for compensating for translational skew when translating and\nrotating a swerve drivetrain.\n\n:param vx: Forward velocity.\n:param vy: Sideways velocity.\n:param omega: Angular velocity.\n:param dt: The duration of the timestep the speeds should be applied for.\n\n:returns: Discretized ChassisSpeeds." - }, - { - "args": [ - { - "defaultValue": "", - "name": "continuousSpeeds", - "type": "wpimath.kinematics.ChassisSpeeds" - }, - { - "defaultValue": "", - "name": "dt", - "type": "wpimath.units.seconds" - } - ], - "declaringClassName": "wpimath.kinematics.ChassisSpeeds", - "functionName": "discretize", - "returnType": "wpimath.kinematics.ChassisSpeeds", - "tooltip": "Discretizes a continuous-time chassis speed.\n\nThis function converts a continuous-time chassis speed into a discrete-time\none such that when the discrete-time chassis speed is applied for one\ntimestep, the robot moves as if the velocity components are independent\n(i.e., the robot moves v_x * dt along the x-axis, v_y * dt along the\ny-axis, and omega * dt around the z-axis).\n\nThis is useful for compensating for translational skew when translating and\nrotating a swerve drivetrain.\n\n:param continuousSpeeds: The continuous speeds.\n:param dt: The duration of the timestep the speeds should be applied for.\n\n:returns: Discretized ChassisSpeeds." - }, { "args": [ { @@ -86774,98 +67537,6 @@ "functionName": "fromFeet", "returnType": "wpimath.kinematics.ChassisSpeeds", "tooltip": "" - }, - { - "args": [ - { - "defaultValue": "", - "name": "vx", - "type": "wpimath.units.meters_per_second" - }, - { - "defaultValue": "", - "name": "vy", - "type": "wpimath.units.meters_per_second" - }, - { - "defaultValue": "", - "name": "omega", - "type": "wpimath.units.radians_per_second" - }, - { - "defaultValue": "", - "name": "robotAngle", - "type": "wpimath.geometry.Rotation2d" - } - ], - "declaringClassName": "wpimath.kinematics.ChassisSpeeds", - "functionName": "fromFieldRelativeSpeeds", - "returnType": "wpimath.kinematics.ChassisSpeeds", - "tooltip": "Converts a user provided field-relative set of speeds into a robot-relative\nChassisSpeeds object.\n\n:param vx: The component of speed in the x direction relative to the field.\n Positive x is away from your alliance wall.\n:param vy: The component of speed in the y direction relative to the field.\n Positive y is to your left when standing behind the alliance wall.\n:param omega: The angular rate of the robot.\n:param robotAngle: The angle of the robot as measured by a gyroscope. The\n robot's angle is considered to be zero when it is facing directly away from\n your alliance station wall. Remember that this should be CCW positive.\n\n:returns: ChassisSpeeds object representing the speeds in the robot's frame\n of reference." - }, - { - "args": [ - { - "defaultValue": "", - "name": "fieldRelativeSpeeds", - "type": "wpimath.kinematics.ChassisSpeeds" - }, - { - "defaultValue": "", - "name": "robotAngle", - "type": "wpimath.geometry.Rotation2d" - } - ], - "declaringClassName": "wpimath.kinematics.ChassisSpeeds", - "functionName": "fromFieldRelativeSpeeds", - "returnType": "wpimath.kinematics.ChassisSpeeds", - "tooltip": "Converts a user provided field-relative ChassisSpeeds object into a\nrobot-relative ChassisSpeeds object.\n\n:param fieldRelativeSpeeds: The ChassisSpeeds object representing the speeds\n in the field frame of reference. Positive x is away from your alliance\n wall. Positive y is to your left when standing behind the alliance wall.\n:param robotAngle: The angle of the robot as measured by a gyroscope. The\n robot's angle is considered to be zero when it is facing directly away\n from your alliance station wall. Remember that this should be CCW\n positive.\n\n:returns: ChassisSpeeds object representing the speeds in the robot's frame\n of reference." - }, - { - "args": [ - { - "defaultValue": "", - "name": "vx", - "type": "wpimath.units.meters_per_second" - }, - { - "defaultValue": "", - "name": "vy", - "type": "wpimath.units.meters_per_second" - }, - { - "defaultValue": "", - "name": "omega", - "type": "wpimath.units.radians_per_second" - }, - { - "defaultValue": "", - "name": "robotAngle", - "type": "wpimath.geometry.Rotation2d" - } - ], - "declaringClassName": "wpimath.kinematics.ChassisSpeeds", - "functionName": "fromRobotRelativeSpeeds", - "returnType": "wpimath.kinematics.ChassisSpeeds", - "tooltip": "Converts a user provided robot-relative set of speeds into a field-relative\nChassisSpeeds object.\n\n:param vx: The component of speed in the x direction relative to the robot.\n Positive x is towards the robot's front.\n:param vy: The component of speed in the y direction relative to the robot.\n Positive y is towards the robot's left.\n:param omega: The angular rate of the robot.\n:param robotAngle: The angle of the robot as measured by a gyroscope. The\n robot's angle is considered to be zero when it is facing directly away from\n your alliance station wall. Remember that this should be CCW positive.\n\n:returns: ChassisSpeeds object representing the speeds in the field's frame\n of reference." - }, - { - "args": [ - { - "defaultValue": "", - "name": "robotRelativeSpeeds", - "type": "wpimath.kinematics.ChassisSpeeds" - }, - { - "defaultValue": "", - "name": "robotAngle", - "type": "wpimath.geometry.Rotation2d" - } - ], - "declaringClassName": "wpimath.kinematics.ChassisSpeeds", - "functionName": "fromRobotRelativeSpeeds", - "returnType": "wpimath.kinematics.ChassisSpeeds", - "tooltip": "Converts a user provided robot-relative ChassisSpeeds object into a\nfield-relative ChassisSpeeds object.\n\n:param robotRelativeSpeeds: The ChassisSpeeds object representing the speeds\n in the robot frame of reference. Positive x is the towards robot's\n front. Positive y is towards the robot's left.\n:param robotAngle: The angle of the robot as measured by a gyroscope. The\n robot's angle is considered to be zero when it is facing directly away\n from your alliance station wall. Remember that this should be CCW\n positive.\n\n:returns: ChassisSpeeds object representing the speeds in the field's frame\n of reference." } ] }, @@ -86877,14 +67548,14 @@ "args": [ { "defaultValue": "", - "name": "trackWidth", + "name": "trackwidth", "type": "wpimath.units.meters" } ], "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematics", "functionName": "__init__", "returnType": "wpimath.kinematics.DifferentialDriveKinematics", - "tooltip": "Constructs a differential drive kinematics object.\n\n:param trackWidth: The track width of the drivetrain. Theoretically, this is\n the distance between the left wheels and right wheels. However, the\n empirical value may be larger than the physical measured value due to\n scrubbing effects." + "tooltip": "Constructs a differential drive kinematics object.\n\n:param trackwidth: The trackwidth of the drivetrain. Theoretically, this is\n the distance between the left wheels and right wheels. However, the\n empirical value may be larger than the physical measured value due to\n scrubbing effects." } ], "enums": [], @@ -86909,7 +67580,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematics", @@ -87002,7 +67673,7 @@ ], "instanceVariables": [ { - "name": "trackWidth", + "name": "trackwidth", "tooltip": "Differential drive trackwidth.", "type": "wpimath.units.meters", "writable": false @@ -87045,7 +67716,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematicsBase", @@ -87798,7 +68469,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.DifferentialDriveWheelPositions", @@ -88023,7 +68694,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics", @@ -88170,7 +68841,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.MecanumDriveKinematicsBase", @@ -88903,7 +69574,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.MecanumDriveWheelPositions", @@ -88991,8 +69662,8 @@ ], "declaringClassName": "wpimath.kinematics.MecanumDriveWheelSpeeds", "functionName": "desaturate", - "returnType": "None", - "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum.\n\nSometimes, after inverse kinematics, the requested speed from one or\nmore wheels may be above the max attainable speed for the driving motor on\nthat wheel. To fix this issue, one can reduce all the wheel speeds to make\nsure that all requested module speeds are at-or-below the absolute\nthreshold, while maintaining the ratio of speeds between wheels.\n\n:param attainableMaxSpeed: The absolute max speed that a wheel can reach." + "returnType": "wpimath.kinematics.MecanumDriveWheelSpeeds", + "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum.\n\nSometimes, after inverse kinematics, the requested speed from one or\nmore wheels may be above the max attainable speed for the driving motor on\nthat wheel. To fix this issue, one can reduce all the wheel speeds to make\nsure that all requested module speeds are at-or-below the absolute\nthreshold, while maintaining the ratio of speeds between wheels.\n\n:param attainableMaxSpeed: The absolute max speed that a wheel can reach.\n\n:returns: Desaturated MecanumDriveWheelSpeeds." } ], "instanceVariables": [ @@ -89135,7 +69806,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics", @@ -89281,7 +69952,7 @@ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics", "functionName": "desaturateWheelSpeeds", "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]", - "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param attainableMaxSpeed: The absolute max speed that a module can reach." + "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\nScaling down the module speeds rotates the direction of net motion in the\nopposite direction of rotational velocity, which makes discretizing the\nchassis speeds inaccurate because the discretization did not account for\nthis translational skew.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param attainableMaxSpeed: The absolute max speed that a module can reach." }, { "args": [ @@ -89314,7 +69985,7 @@ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics", "functionName": "desaturateWheelSpeeds", "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]", - "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum, as well as getting rid of joystick saturation at edges\nof joystick.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param desiredChassisSpeed: The desired speed of the robot\n:param attainableMaxModuleSpeed: The absolute max speed a module can reach\n:param attainableMaxRobotTranslationSpeed: The absolute max speed the robot\n can reach while translating\n:param attainableMaxRobotRotationSpeed: The absolute max speed the robot can\n reach while rotating" + "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum, as well as getting rid of joystick saturation at edges\nof joystick.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\nScaling down the module speeds rotates the direction of net motion in the\nopposite direction of rotational velocity, which makes discretizing the\nchassis speeds inaccurate because the discretization did not account for\nthis translational skew.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param desiredChassisSpeed: The desired speed of the robot\n:param attainableMaxModuleSpeed: The absolute max speed a module can reach\n:param attainableMaxRobotTranslationSpeed: The absolute max speed the robot\n can reach while translating\n:param attainableMaxRobotRotationSpeed: The absolute max speed the robot can\n reach while rotating" } ] }, @@ -89352,7 +70023,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.SwerveDrive2KinematicsBase", @@ -90119,7 +70790,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics", @@ -90265,7 +70936,7 @@ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics", "functionName": "desaturateWheelSpeeds", "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]", - "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param attainableMaxSpeed: The absolute max speed that a module can reach." + "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\nScaling down the module speeds rotates the direction of net motion in the\nopposite direction of rotational velocity, which makes discretizing the\nchassis speeds inaccurate because the discretization did not account for\nthis translational skew.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param attainableMaxSpeed: The absolute max speed that a module can reach." }, { "args": [ @@ -90298,7 +70969,7 @@ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics", "functionName": "desaturateWheelSpeeds", "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]", - "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum, as well as getting rid of joystick saturation at edges\nof joystick.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param desiredChassisSpeed: The desired speed of the robot\n:param attainableMaxModuleSpeed: The absolute max speed a module can reach\n:param attainableMaxRobotTranslationSpeed: The absolute max speed the robot\n can reach while translating\n:param attainableMaxRobotRotationSpeed: The absolute max speed the robot can\n reach while rotating" + "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum, as well as getting rid of joystick saturation at edges\nof joystick.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\nScaling down the module speeds rotates the direction of net motion in the\nopposite direction of rotational velocity, which makes discretizing the\nchassis speeds inaccurate because the discretization did not account for\nthis translational skew.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param desiredChassisSpeed: The desired speed of the robot\n:param attainableMaxModuleSpeed: The absolute max speed a module can reach\n:param attainableMaxRobotTranslationSpeed: The absolute max speed the robot\n can reach while translating\n:param attainableMaxRobotRotationSpeed: The absolute max speed the robot can\n reach while rotating" } ] }, @@ -90336,7 +71007,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.SwerveDrive3KinematicsBase", @@ -91108,7 +71779,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics", @@ -91254,7 +71925,7 @@ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics", "functionName": "desaturateWheelSpeeds", "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]", - "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param attainableMaxSpeed: The absolute max speed that a module can reach." + "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\nScaling down the module speeds rotates the direction of net motion in the\nopposite direction of rotational velocity, which makes discretizing the\nchassis speeds inaccurate because the discretization did not account for\nthis translational skew.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param attainableMaxSpeed: The absolute max speed that a module can reach." }, { "args": [ @@ -91287,7 +71958,7 @@ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics", "functionName": "desaturateWheelSpeeds", "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]", - "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum, as well as getting rid of joystick saturation at edges\nof joystick.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param desiredChassisSpeed: The desired speed of the robot\n:param attainableMaxModuleSpeed: The absolute max speed a module can reach\n:param attainableMaxRobotTranslationSpeed: The absolute max speed the robot\n can reach while translating\n:param attainableMaxRobotRotationSpeed: The absolute max speed the robot can\n reach while rotating" + "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum, as well as getting rid of joystick saturation at edges\nof joystick.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\nScaling down the module speeds rotates the direction of net motion in the\nopposite direction of rotational velocity, which makes discretizing the\nchassis speeds inaccurate because the discretization did not account for\nthis translational skew.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param desiredChassisSpeed: The desired speed of the robot\n:param attainableMaxModuleSpeed: The absolute max speed a module can reach\n:param attainableMaxRobotTranslationSpeed: The absolute max speed the robot\n can reach while translating\n:param attainableMaxRobotRotationSpeed: The absolute max speed the robot can\n reach while rotating" } ] }, @@ -91325,7 +71996,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.SwerveDrive4KinematicsBase", @@ -92107,7 +72778,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics", @@ -92253,7 +72924,7 @@ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics", "functionName": "desaturateWheelSpeeds", "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]", - "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param attainableMaxSpeed: The absolute max speed that a module can reach." + "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\nScaling down the module speeds rotates the direction of net motion in the\nopposite direction of rotational velocity, which makes discretizing the\nchassis speeds inaccurate because the discretization did not account for\nthis translational skew.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param attainableMaxSpeed: The absolute max speed that a module can reach." }, { "args": [ @@ -92286,7 +72957,7 @@ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics", "functionName": "desaturateWheelSpeeds", "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]", - "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum, as well as getting rid of joystick saturation at edges\nof joystick.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param desiredChassisSpeed: The desired speed of the robot\n:param attainableMaxModuleSpeed: The absolute max speed a module can reach\n:param attainableMaxRobotTranslationSpeed: The absolute max speed the robot\n can reach while translating\n:param attainableMaxRobotRotationSpeed: The absolute max speed the robot can\n reach while rotating" + "tooltip": "Renormalizes the wheel speeds if any individual speed is above the\nspecified maximum, as well as getting rid of joystick saturation at edges\nof joystick.\n\nSometimes, after inverse kinematics, the requested speed\nfrom one or more modules may be above the max attainable speed for the\ndriving motor on that module. To fix this issue, one can reduce all the\nwheel speeds to make sure that all requested module speeds are at-or-below\nthe absolute threshold, while maintaining the ratio of speeds between\nmodules.\n\nScaling down the module speeds rotates the direction of net motion in the\nopposite direction of rotational velocity, which makes discretizing the\nchassis speeds inaccurate because the discretization did not account for\nthis translational skew.\n\n:param moduleStates: Reference to array of module states. The array will be\n mutated with the normalized speeds!\n:param desiredChassisSpeed: The desired speed of the robot\n:param attainableMaxModuleSpeed: The absolute max speed a module can reach\n:param attainableMaxRobotTranslationSpeed: The absolute max speed the robot\n can reach while translating\n:param attainableMaxRobotRotationSpeed: The absolute max speed the robot can\n reach while rotating" } ] }, @@ -92324,7 +72995,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.SwerveDrive6KinematicsBase", @@ -93068,7 +73739,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.kinematics.SwerveModulePosition", @@ -93194,7 +73865,7 @@ { "defaultValue": "", "name": "initialTemperature", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", @@ -93230,7 +73901,7 @@ { "defaultValue": "", "name": "iterations", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.optimization.SimulatedAnnealing", @@ -93285,7 +73956,7 @@ { "defaultValue": "", "name": "iterations", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.path.TravelingSalesman", @@ -93307,22 +73978,22 @@ { "defaultValue": "", "name": "xInitialControlVector", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "xFinalControlVector", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "yInitialControlVector", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "yFinalControlVector", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.spline.CubicHermiteSpline", @@ -93343,7 +74014,7 @@ ], "declaringClassName": "wpimath.spline.Spline3", "functionName": "coefficients", - "returnType": "numpy.ndarray[numpy.float64[6, 4]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[6, 4]\"]", "tooltip": "Returns the coefficients of the spline.\n\n:returns: The coefficients of the spline." }, { @@ -93382,7 +74053,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.spline.Spline3", @@ -93404,22 +74075,22 @@ { "defaultValue": "", "name": "xInitialControlVector", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "xFinalControlVector", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "yInitialControlVector", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "yFinalControlVector", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.spline.QuinticHermiteSpline", @@ -93440,7 +74111,7 @@ ], "declaringClassName": "wpimath.spline.Spline5", "functionName": "coefficients", - "returnType": "numpy.ndarray[numpy.float64[6, 6]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[6, 6]\"]", "tooltip": "Returns the coefficients of the spline.\n\n:returns: The coefficients of the spline." }, { @@ -93479,7 +74150,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.spline.Spline5", @@ -93516,7 +74187,7 @@ ], "declaringClassName": "wpimath.spline.Spline3", "functionName": "coefficients", - "returnType": "numpy.ndarray[numpy.float64[6, 4]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[6, 4]\"]", "tooltip": "Returns the coefficients of the spline.\n\n:returns: The coefficients of the spline." }, { @@ -93555,7 +74226,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.spline.Spline3", @@ -93577,12 +74248,12 @@ { "defaultValue": "", "name": "x", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "y", - "type": "Tuple[float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.spline.Spline3.ControlVector", @@ -93634,7 +74305,7 @@ ], "declaringClassName": "wpimath.spline.Spline5", "functionName": "coefficients", - "returnType": "numpy.ndarray[numpy.float64[6, 6]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[6, 6]\"]", "tooltip": "Returns the coefficients of the spline.\n\n:returns: The coefficients of the spline." }, { @@ -93673,7 +74344,7 @@ { "defaultValue": "", "name": "t", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.spline.Spline5", @@ -93695,12 +74366,12 @@ { "defaultValue": "", "name": "x", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" }, { "defaultValue": "", "name": "y", - "type": "Tuple[float, float, float]" + "type": "Tuple[typing.SupportsFloat, typing.SupportsFloat, typing.SupportsFloat]" } ], "declaringClassName": "wpimath.spline.Spline5.ControlVector", @@ -93799,117 +74470,488 @@ "type": "list[wpimath.spline.QuinticHermiteSpline]" } ], - "declaringClassName": "wpimath.spline.SplineHelper", - "functionName": "optimizeCurvature", - "returnType": "list[wpimath.spline.QuinticHermiteSpline]", - "tooltip": "Optimizes the curvature of 2 or more quintic splines at knot points.\nOverall, this reduces the integral of the absolute value of the second\nderivative across the set of splines.\n\n:param splines: A vector of un-optimized quintic splines.\n\n:returns: A vector of optimized quintic splines." + "declaringClassName": "wpimath.spline.SplineHelper", + "functionName": "optimizeCurvature", + "returnType": "list[wpimath.spline.QuinticHermiteSpline]", + "tooltip": "Optimizes the curvature of 2 or more quintic splines at knot points.\nOverall, this reduces the integral of the absolute value of the second\nderivative across the set of splines.\n\n:param splines: A vector of un-optimized quintic splines.\n\n:returns: A vector of optimized quintic splines." + }, + { + "args": [ + { + "defaultValue": "", + "name": "controlVectors", + "type": "list[wpimath.spline.Spline5.ControlVector]" + } + ], + "declaringClassName": "wpimath.spline.SplineHelper", + "functionName": "quinticSplinesFromControlVectors", + "returnType": "list[wpimath.spline.QuinticHermiteSpline]", + "tooltip": "Returns a set of quintic splines corresponding to the provided control\nvectors. The user is free to set the direction of all waypoints. Continuous\ncurvature is guaranteed throughout the path.\n\n:param controlVectors: The control vectors.\n\n:returns: A vector of quintic hermite splines that interpolate through the\n provided waypoints." + }, + { + "args": [ + { + "defaultValue": "", + "name": "waypoints", + "type": "list[wpimath.geometry.Pose2d]" + } + ], + "declaringClassName": "wpimath.spline.SplineHelper", + "functionName": "quinticSplinesFromWaypoints", + "returnType": "list[wpimath.spline.QuinticHermiteSpline]", + "tooltip": "Returns quintic splines from a set of waypoints.\n\n:param waypoints: The waypoints\n\n:returns: List of quintic splines." + } + ] + }, + { + "className": "wpimath.spline.SplineParameterizer", + "classVariables": [], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "args", + "type": "tuple" + }, + { + "defaultValue": "", + "name": "kwargs", + "type": "dict" + } + ], + "declaringClassName": "wpimath.spline.SplineParameterizer", + "functionName": "__init__", + "returnType": "wpimath.spline.SplineParameterizer", + "tooltip": "Initialize self. See help(type(self)) for accurate signature." + } + ], + "enums": [], + "instanceMethods": [], + "instanceVariables": [], + "moduleName": "wpimath.spline", + "staticMethods": [ + { + "args": [ + { + "defaultValue": "", + "name": "spline", + "type": "wpimath.spline.Spline3" + }, + { + "defaultValue": "0.0", + "name": "t0", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "1.0", + "name": "t1", + "type": "typing.SupportsFloat" + } + ], + "declaringClassName": "wpimath.spline.SplineParameterizer", + "functionName": "parameterize", + "returnType": "list[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]", + "tooltip": "Parametrizes the spline. This method breaks up the spline into various\narcs until their dx, dy, and dtheta are within specific tolerances.\n\n:param spline: The spline to parameterize.\n:param t0: Starting internal spline parameter. It is recommended to leave\n this as default.\n:param t1: Ending internal spline parameter. It is recommended to leave this\n as default.\n\n:returns: A vector of poses and curvatures that represents various points on\n the spline." + }, + { + "args": [ + { + "defaultValue": "", + "name": "spline", + "type": "wpimath.spline.Spline5" + }, + { + "defaultValue": "0.0", + "name": "t0", + "type": "typing.SupportsFloat" + }, + { + "defaultValue": "1.0", + "name": "t1", + "type": "typing.SupportsFloat" + } + ], + "declaringClassName": "wpimath.spline.SplineParameterizer", + "functionName": "parameterize", + "returnType": "list[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]", + "tooltip": "Parametrizes the spline. This method breaks up the spline into various\narcs until their dx, dy, and dtheta are within specific tolerances.\n\n:param spline: The spline to parameterize.\n:param t0: Starting internal spline parameter. It is recommended to leave\n this as default.\n:param t1: Ending internal spline parameter. It is recommended to leave this\n as default.\n\n:returns: A vector of poses and curvatures that represents various points on\n the spline." + } + ] + }, + { + "className": "wpimath.system.LinearSystemLoop_1_1_1", + "classVariables": [], + "constructors": [ + { + "args": [ + { + "defaultValue": "", + "name": "plant", + "type": "wpimath.system.LinearSystem_1_1_1" + }, + { + "defaultValue": "", + "name": "controller", + "type": "wpimath.controller.LinearQuadraticRegulator_1_1" + }, + { + "defaultValue": "", + "name": "observer", + "type": "wpimath.estimator.KalmanFilter_1_1_1" + }, + { + "defaultValue": "", + "name": "maxVoltage", + "type": "wpimath.units.volts" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "__init__", + "returnType": "wpimath.system.LinearSystemLoop_1_1_1", + "tooltip": "Constructs a state-space loop with the given plant, controller, and\nobserver. By default, the initial reference is all zeros. Users should\ncall reset with the initial system state before enabling the loop. This\nconstructor assumes that the input(s) to this system are voltage.\n\n:param plant: State-space plant.\n:param controller: State-space controller.\n:param observer: State-space observer.\n:param maxVoltage: The maximum voltage that can be applied. Commonly 12.\n:param dt: The nominal timestep." + }, + { + "args": [ + { + "defaultValue": "", + "name": "plant", + "type": "wpimath.system.LinearSystem_1_1_1" + }, + { + "defaultValue": "", + "name": "controller", + "type": "wpimath.controller.LinearQuadraticRegulator_1_1" + }, + { + "defaultValue": "", + "name": "observer", + "type": "wpimath.estimator.KalmanFilter_1_1_1" + }, + { + "defaultValue": "", + "name": "clampFunction", + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "__init__", + "returnType": "wpimath.system.LinearSystemLoop_1_1_1", + "tooltip": "Constructs a state-space loop with the given plant, controller, and\nobserver. By default, the initial reference is all zeros. Users should\ncall reset with the initial system state before enabling the loop. This\nconstructor assumes that the input(s) to this system are voltage.\n\n:param plant: State-space plant.\n:param controller: State-space controller.\n:param observer: State-space observer.\n:param clampFunction: The function used to clamp the input vector.\n:param dt: The nominal timestep." + }, + { + "args": [ + { + "defaultValue": "", + "name": "controller", + "type": "wpimath.controller.LinearQuadraticRegulator_1_1" + }, + { + "defaultValue": "", + "name": "feedforward", + "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1" + }, + { + "defaultValue": "", + "name": "observer", + "type": "wpimath.estimator.KalmanFilter_1_1_1" + }, + { + "defaultValue": "", + "name": "maxVoltage", + "type": "wpimath.units.volts" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "__init__", + "returnType": "wpimath.system.LinearSystemLoop_1_1_1", + "tooltip": "Constructs a state-space loop with the given controller, feedforward and\nobserver. By default, the initial reference is all zeros. Users should\ncall reset with the initial system state.\n\n:param controller: State-space controller.\n:param feedforward: Plant inversion feedforward.\n:param observer: State-space observer.\n:param maxVoltage: The maximum voltage that can be applied. Assumes\n that the inputs are voltages." + }, + { + "args": [ + { + "defaultValue": "", + "name": "controller", + "type": "wpimath.controller.LinearQuadraticRegulator_1_1" + }, + { + "defaultValue": "", + "name": "feedforward", + "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1" + }, + { + "defaultValue": "", + "name": "observer", + "type": "wpimath.estimator.KalmanFilter_1_1_1" + }, + { + "defaultValue": "", + "name": "clampFunction", + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "__init__", + "returnType": "wpimath.system.LinearSystemLoop_1_1_1", + "tooltip": "Constructs a state-space loop with the given controller, feedforward,\nobserver and clamp function. By default, the initial reference is all\nzeros. Users should call reset with the initial system state.\n\n:param controller: State-space controller.\n:param feedforward: Plant-inversion feedforward.\n:param observer: State-space observer.\n:param clampFunction: The function used to clamp the input vector." + } + ], + "enums": [], + "instanceMethods": [ + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "U", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Returns the controller's calculated control input u." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + }, + { + "defaultValue": "", + "name": "i", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "U", + "returnType": "float", + "tooltip": "Returns an element of the controller's calculated control input u.\n\n:param i: Row of u." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + }, + { + "defaultValue": "", + "name": "u", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "clampInput", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Clamps input vector between system's minimum and maximum allowable input.\n\n:param u: Input vector to clamp.\n\n:returns: Clamped input vector." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + }, + { + "defaultValue": "", + "name": "y", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "correct", + "returnType": "None", + "tooltip": "Correct the state estimate x-hat using the measurements in y.\n\n:param y: Measurement vector." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "error", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Returns difference between reference r and current state x-hat." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "nextR", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Returns the controller's next reference r." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + }, + { + "defaultValue": "", + "name": "i", + "type": "typing.SupportsInt" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "nextR", + "returnType": "float", + "tooltip": "Returns an element of the controller's next reference r.\n\n:param i: Row of r." + }, + { + "args": [ + { + "defaultValue": "", + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "predict", + "returnType": "None", + "tooltip": "Sets new controller output, projects model forward, and runs observer\nprediction.\n\nAfter calling this, the user should send the elements of u to the\nactuators.\n\n:param dt: Timestep for model update." }, { "args": [ { "defaultValue": "", - "name": "controlVectors", - "type": "list[wpimath.spline.Spline5.ControlVector]" + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + }, + { + "defaultValue": "", + "name": "initialState", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpimath.spline.SplineHelper", - "functionName": "quinticSplinesFromControlVectors", - "returnType": "list[wpimath.spline.QuinticHermiteSpline]", - "tooltip": "Returns a set of quintic splines corresponding to the provided control\nvectors. The user is free to set the direction of all waypoints. Continuous\ncurvature is guaranteed throughout the path.\n\n:param controlVectors: The control vectors.\n\n:returns: A vector of quintic hermite splines that interpolate through the\n provided waypoints." + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "reset", + "returnType": "None", + "tooltip": "Zeroes reference r and controller output u. The previous reference\nof the PlantInversionFeedforward and the initial state estimate of\nthe KalmanFilter are set to the initial state provided.\n\n:param initialState: The initial state." }, { "args": [ { "defaultValue": "", - "name": "waypoints", - "type": "list[wpimath.geometry.Pose2d]" + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + }, + { + "defaultValue": "", + "name": "nextR", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpimath.spline.SplineHelper", - "functionName": "quinticSplinesFromWaypoints", - "returnType": "list[wpimath.spline.QuinticHermiteSpline]", - "tooltip": "Returns quintic splines from a set of waypoints.\n\n:param waypoints: The waypoints\n\n:returns: List of quintic splines." - } - ] - }, - { - "className": "wpimath.spline.SplineParameterizer", - "classVariables": [], - "constructors": [ + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "setNextR", + "returnType": "None", + "tooltip": "Set the next reference r.\n\n:param nextR: Next reference." + }, { "args": [ { "defaultValue": "", - "name": "args", - "type": "tuple" + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" }, { "defaultValue": "", - "name": "kwargs", - "type": "dict" + "name": "xHat", + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpimath.spline.SplineParameterizer", - "functionName": "__init__", - "returnType": "wpimath.spline.SplineParameterizer", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpimath.spline", - "staticMethods": [ + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "setXhat", + "returnType": "None", + "tooltip": "Set the initial state estimate x-hat.\n\n:param xHat: The initial state estimate x-hat." + }, { "args": [ { "defaultValue": "", - "name": "spline", - "type": "wpimath.spline.Spline3" + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" }, { - "defaultValue": "0.0", - "name": "t0", - "type": "float" + "defaultValue": "", + "name": "i", + "type": "typing.SupportsInt" }, { - "defaultValue": "1.0", - "name": "t1", - "type": "float" + "defaultValue": "", + "name": "value", + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpimath.spline.SplineParameterizer", - "functionName": "parameterize", - "returnType": "list[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]", - "tooltip": "Parametrizes the spline. This method breaks up the spline into various\narcs until their dx, dy, and dtheta are within specific tolerances.\n\n:param spline: The spline to parameterize.\n:param t0: Starting internal spline parameter. It is recommended to leave\n this as default.\n:param t1: Ending internal spline parameter. It is recommended to leave this\n as default.\n\n:returns: A vector of poses and curvatures that represents various points on\n the spline." + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "setXhat", + "returnType": "None", + "tooltip": "Set an element of the initial state estimate x-hat.\n\n:param i: Row of x-hat.\n:param value: Value for element of x-hat." }, { "args": [ { "defaultValue": "", - "name": "spline", - "type": "wpimath.spline.Spline5" - }, + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" + } + ], + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "xhat", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", + "tooltip": "Returns the observer's state estimate x-hat." + }, + { + "args": [ { - "defaultValue": "0.0", - "name": "t0", - "type": "float" + "defaultValue": "", + "name": "self", + "type": "wpimath.system.LinearSystemLoop_1_1_1" }, { - "defaultValue": "1.0", - "name": "t1", - "type": "float" + "defaultValue": "", + "name": "i", + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpimath.spline.SplineParameterizer", - "functionName": "parameterize", - "returnType": "list[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]", - "tooltip": "Parametrizes the spline. This method breaks up the spline into various\narcs until their dx, dy, and dtheta are within specific tolerances.\n\n:param spline: The spline to parameterize.\n:param t0: Starting internal spline parameter. It is recommended to leave\n this as default.\n:param t1: Ending internal spline parameter. It is recommended to leave this\n as default.\n\n:returns: A vector of poses and curvatures that represents various points on\n the spline." + "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "functionName": "xhat", + "returnType": "float", + "tooltip": "Returns an element of the observer's state estimate x-hat.\n\n:param i: Row of x-hat." } - ] + ], + "instanceVariables": [], + "moduleName": "wpimath.system", + "staticMethods": [] }, { - "className": "wpimath.system.LinearSystemLoop_1_1_1", + "className": "wpimath.system.LinearSystemLoop_2_1_1", "classVariables": [], "constructors": [ { @@ -93917,17 +74959,17 @@ { "defaultValue": "", "name": "plant", - "type": "wpimath.system.LinearSystem_1_1_1" + "type": "wpimath.system.LinearSystem_2_1_1" }, { "defaultValue": "", "name": "controller", - "type": "wpimath.controller.LinearQuadraticRegulator_1_1" + "type": "wpimath.controller.LinearQuadraticRegulator_2_1" }, { "defaultValue": "", "name": "observer", - "type": "wpimath.estimator.KalmanFilter_1_1_1" + "type": "wpimath.estimator.KalmanFilter_2_1_1" }, { "defaultValue": "", @@ -93940,9 +74982,9 @@ "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "__init__", - "returnType": "wpimath.system.LinearSystemLoop_1_1_1", + "returnType": "wpimath.system.LinearSystemLoop_2_1_1", "tooltip": "Constructs a state-space loop with the given plant, controller, and\nobserver. By default, the initial reference is all zeros. Users should\ncall reset with the initial system state before enabling the loop. This\nconstructor assumes that the input(s) to this system are voltage.\n\n:param plant: State-space plant.\n:param controller: State-space controller.\n:param observer: State-space observer.\n:param maxVoltage: The maximum voltage that can be applied. Commonly 12.\n:param dt: The nominal timestep." }, { @@ -93950,22 +74992,22 @@ { "defaultValue": "", "name": "plant", - "type": "wpimath.system.LinearSystem_1_1_1" + "type": "wpimath.system.LinearSystem_2_1_1" }, { "defaultValue": "", "name": "controller", - "type": "wpimath.controller.LinearQuadraticRegulator_1_1" + "type": "wpimath.controller.LinearQuadraticRegulator_2_1" }, { "defaultValue": "", "name": "observer", - "type": "wpimath.estimator.KalmanFilter_1_1_1" + "type": "wpimath.estimator.KalmanFilter_2_1_1" }, { "defaultValue": "", "name": "clampFunction", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", @@ -93973,9 +75015,9 @@ "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "__init__", - "returnType": "wpimath.system.LinearSystemLoop_1_1_1", + "returnType": "wpimath.system.LinearSystemLoop_2_1_1", "tooltip": "Constructs a state-space loop with the given plant, controller, and\nobserver. By default, the initial reference is all zeros. Users should\ncall reset with the initial system state before enabling the loop. This\nconstructor assumes that the input(s) to this system are voltage.\n\n:param plant: State-space plant.\n:param controller: State-space controller.\n:param observer: State-space observer.\n:param clampFunction: The function used to clamp the input vector.\n:param dt: The nominal timestep." }, { @@ -93983,17 +75025,17 @@ { "defaultValue": "", "name": "controller", - "type": "wpimath.controller.LinearQuadraticRegulator_1_1" + "type": "wpimath.controller.LinearQuadraticRegulator_2_1" }, { "defaultValue": "", "name": "feedforward", - "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1" + "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1" }, { "defaultValue": "", "name": "observer", - "type": "wpimath.estimator.KalmanFilter_1_1_1" + "type": "wpimath.estimator.KalmanFilter_2_1_1" }, { "defaultValue": "", @@ -94001,9 +75043,9 @@ "type": "wpimath.units.volts" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "__init__", - "returnType": "wpimath.system.LinearSystemLoop_1_1_1", + "returnType": "wpimath.system.LinearSystemLoop_2_1_1", "tooltip": "Constructs a state-space loop with the given controller, feedforward and\nobserver. By default, the initial reference is all zeros. Users should\ncall reset with the initial system state.\n\n:param controller: State-space controller.\n:param feedforward: Plant inversion feedforward.\n:param observer: State-space observer.\n:param maxVoltage: The maximum voltage that can be applied. Assumes\n that the inputs are voltages." }, { @@ -94011,27 +75053,27 @@ { "defaultValue": "", "name": "controller", - "type": "wpimath.controller.LinearQuadraticRegulator_1_1" + "type": "wpimath.controller.LinearQuadraticRegulator_2_1" }, { "defaultValue": "", "name": "feedforward", - "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1" + "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1" }, { "defaultValue": "", "name": "observer", - "type": "wpimath.estimator.KalmanFilter_1_1_1" + "type": "wpimath.estimator.KalmanFilter_2_1_1" }, { "defaultValue": "", "name": "clampFunction", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "__init__", - "returnType": "wpimath.system.LinearSystemLoop_1_1_1", + "returnType": "wpimath.system.LinearSystemLoop_2_1_1", "tooltip": "Constructs a state-space loop with the given controller, feedforward,\nobserver and clamp function. By default, the initial reference is all\nzeros. Users should call reset with the initial system state.\n\n:param controller: State-space controller.\n:param feedforward: Plant-inversion feedforward.\n:param observer: State-space observer.\n:param clampFunction: The function used to clamp the input vector." } ], @@ -94042,12 +75084,12 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the controller's calculated control input u." }, { @@ -94055,15 +75097,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" }, { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "U", "returnType": "float", "tooltip": "Returns an element of the controller's calculated control input u.\n\n:param i: Row of u." @@ -94073,17 +75115,17 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" }, { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "clampInput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Clamps input vector between system's minimum and maximum allowable input.\n\n:param u: Input vector to clamp.\n\n:returns: Clamped input vector." }, { @@ -94091,15 +75133,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "correct", "returnType": "None", "tooltip": "Correct the state estimate x-hat using the measurements in y.\n\n:param y: Measurement vector." @@ -94109,12 +75151,12 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "error", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns difference between reference r and current state x-hat." }, { @@ -94122,12 +75164,12 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "nextR", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the controller's next reference r." }, { @@ -94135,15 +75177,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" }, { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "nextR", "returnType": "float", "tooltip": "Returns an element of the controller's next reference r.\n\n:param i: Row of r." @@ -94153,7 +75195,7 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" }, { "defaultValue": "", @@ -94161,7 +75203,7 @@ "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "predict", "returnType": "None", "tooltip": "Sets new controller output, projects model forward, and runs observer\nprediction.\n\nAfter calling this, the user should send the elements of u to the\nactuators.\n\n:param dt: Timestep for model update." @@ -94171,15 +75213,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" }, { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "reset", "returnType": "None", "tooltip": "Zeroes reference r and controller output u. The previous reference\nof the PlantInversionFeedforward and the initial state estimate of\nthe KalmanFilter are set to the initial state provided.\n\n:param initialState: The initial state." @@ -94189,15 +75231,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "setNextR", "returnType": "None", "tooltip": "Set the next reference r.\n\n:param nextR: Next reference." @@ -94207,15 +75249,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" }, { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "setXhat", "returnType": "None", "tooltip": "Set the initial state estimate x-hat.\n\n:param xHat: The initial state estimate x-hat." @@ -94225,20 +75267,20 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" }, { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "setXhat", "returnType": "None", "tooltip": "Set an element of the initial state estimate x-hat.\n\n:param i: Row of x-hat.\n:param value: Value for element of x-hat." @@ -94248,12 +75290,12 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the observer's state estimate x-hat." }, { @@ -94261,15 +75303,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_1_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_1" }, { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", "functionName": "xhat", "returnType": "float", "tooltip": "Returns an element of the observer's state estimate x-hat.\n\n:param i: Row of x-hat." @@ -94280,7 +75322,7 @@ "staticMethods": [] }, { - "className": "wpimath.system.LinearSystemLoop_2_1_1", + "className": "wpimath.system.LinearSystemLoop_2_1_2", "classVariables": [], "constructors": [ { @@ -94288,7 +75330,7 @@ { "defaultValue": "", "name": "plant", - "type": "wpimath.system.LinearSystem_2_1_1" + "type": "wpimath.system.LinearSystem_2_1_2" }, { "defaultValue": "", @@ -94298,7 +75340,7 @@ { "defaultValue": "", "name": "observer", - "type": "wpimath.estimator.KalmanFilter_2_1_1" + "type": "wpimath.estimator.KalmanFilter_2_1_2" }, { "defaultValue": "", @@ -94311,9 +75353,9 @@ "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "__init__", - "returnType": "wpimath.system.LinearSystemLoop_2_1_1", + "returnType": "wpimath.system.LinearSystemLoop_2_1_2", "tooltip": "Constructs a state-space loop with the given plant, controller, and\nobserver. By default, the initial reference is all zeros. Users should\ncall reset with the initial system state before enabling the loop. This\nconstructor assumes that the input(s) to this system are voltage.\n\n:param plant: State-space plant.\n:param controller: State-space controller.\n:param observer: State-space observer.\n:param maxVoltage: The maximum voltage that can be applied. Commonly 12.\n:param dt: The nominal timestep." }, { @@ -94321,7 +75363,7 @@ { "defaultValue": "", "name": "plant", - "type": "wpimath.system.LinearSystem_2_1_1" + "type": "wpimath.system.LinearSystem_2_1_2" }, { "defaultValue": "", @@ -94331,12 +75373,12 @@ { "defaultValue": "", "name": "observer", - "type": "wpimath.estimator.KalmanFilter_2_1_1" + "type": "wpimath.estimator.KalmanFilter_2_1_2" }, { "defaultValue": "", "name": "clampFunction", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" }, { "defaultValue": "", @@ -94344,9 +75386,9 @@ "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "__init__", - "returnType": "wpimath.system.LinearSystemLoop_2_1_1", + "returnType": "wpimath.system.LinearSystemLoop_2_1_2", "tooltip": "Constructs a state-space loop with the given plant, controller, and\nobserver. By default, the initial reference is all zeros. Users should\ncall reset with the initial system state before enabling the loop. This\nconstructor assumes that the input(s) to this system are voltage.\n\n:param plant: State-space plant.\n:param controller: State-space controller.\n:param observer: State-space observer.\n:param clampFunction: The function used to clamp the input vector.\n:param dt: The nominal timestep." }, { @@ -94364,7 +75406,7 @@ { "defaultValue": "", "name": "observer", - "type": "wpimath.estimator.KalmanFilter_2_1_1" + "type": "wpimath.estimator.KalmanFilter_2_1_2" }, { "defaultValue": "", @@ -94372,9 +75414,9 @@ "type": "wpimath.units.volts" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "__init__", - "returnType": "wpimath.system.LinearSystemLoop_2_1_1", + "returnType": "wpimath.system.LinearSystemLoop_2_1_2", "tooltip": "Constructs a state-space loop with the given controller, feedforward and\nobserver. By default, the initial reference is all zeros. Users should\ncall reset with the initial system state.\n\n:param controller: State-space controller.\n:param feedforward: Plant inversion feedforward.\n:param observer: State-space observer.\n:param maxVoltage: The maximum voltage that can be applied. Assumes\n that the inputs are voltages." }, { @@ -94392,17 +75434,17 @@ { "defaultValue": "", "name": "observer", - "type": "wpimath.estimator.KalmanFilter_2_1_1" + "type": "wpimath.estimator.KalmanFilter_2_1_2" }, { "defaultValue": "", "name": "clampFunction", - "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "__init__", - "returnType": "wpimath.system.LinearSystemLoop_2_1_1", + "returnType": "wpimath.system.LinearSystemLoop_2_1_2", "tooltip": "Constructs a state-space loop with the given controller, feedforward,\nobserver and clamp function. By default, the initial reference is all\nzeros. Users should call reset with the initial system state.\n\n:param controller: State-space controller.\n:param feedforward: Plant-inversion feedforward.\n:param observer: State-space observer.\n:param clampFunction: The function used to clamp the input vector." } ], @@ -94413,12 +75455,12 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the controller's calculated control input u." }, { @@ -94426,15 +75468,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" }, { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "U", "returnType": "float", "tooltip": "Returns an element of the controller's calculated control input u.\n\n:param i: Row of u." @@ -94444,17 +75486,17 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" }, { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "clampInput", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Clamps input vector between system's minimum and maximum allowable input.\n\n:param u: Input vector to clamp.\n\n:returns: Clamped input vector." }, { @@ -94462,15 +75504,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" }, { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "correct", "returnType": "None", "tooltip": "Correct the state estimate x-hat using the measurements in y.\n\n:param y: Measurement vector." @@ -94480,12 +75522,12 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "error", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns difference between reference r and current state x-hat." }, { @@ -94493,12 +75535,12 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "nextR", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the controller's next reference r." }, { @@ -94506,15 +75548,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" }, { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "nextR", "returnType": "float", "tooltip": "Returns an element of the controller's next reference r.\n\n:param i: Row of r." @@ -94524,7 +75566,7 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" }, { "defaultValue": "", @@ -94532,7 +75574,7 @@ "type": "wpimath.units.seconds" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "predict", "returnType": "None", "tooltip": "Sets new controller output, projects model forward, and runs observer\nprediction.\n\nAfter calling this, the user should send the elements of u to the\nactuators.\n\n:param dt: Timestep for model update." @@ -94542,15 +75584,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" }, { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "reset", "returnType": "None", "tooltip": "Zeroes reference r and controller output u. The previous reference\nof the PlantInversionFeedforward and the initial state estimate of\nthe KalmanFilter are set to the initial state provided.\n\n:param initialState: The initial state." @@ -94560,15 +75602,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" }, { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "setNextR", "returnType": "None", "tooltip": "Set the next reference r.\n\n:param nextR: Next reference." @@ -94578,15 +75620,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" }, { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "setXhat", "returnType": "None", "tooltip": "Set the initial state estimate x-hat.\n\n:param xHat: The initial state estimate x-hat." @@ -94596,20 +75638,20 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" }, { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "setXhat", "returnType": "None", "tooltip": "Set an element of the initial state estimate x-hat.\n\n:param i: Row of x-hat.\n:param value: Value for element of x-hat." @@ -94619,12 +75661,12 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the observer's state estimate x-hat." }, { @@ -94632,15 +75674,15 @@ { "defaultValue": "", "name": "self", - "type": "wpimath.system.LinearSystemLoop_2_1_1" + "type": "wpimath.system.LinearSystemLoop_2_1_2" }, { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], - "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1", + "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_2", "functionName": "xhat", "returnType": "float", "tooltip": "Returns an element of the observer's state estimate x-hat.\n\n:param i: Row of x-hat." @@ -94707,7 +75749,7 @@ { "defaultValue": "", "name": "clampFunction", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", @@ -94768,7 +75810,7 @@ { "defaultValue": "", "name": "clampFunction", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", @@ -94789,7 +75831,7 @@ ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the controller's calculated control input u." }, { @@ -94802,7 +75844,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", @@ -94820,12 +75862,12 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", "functionName": "clampInput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Clamps input vector between system's minimum and maximum allowable input.\n\n:param u: Input vector to clamp.\n\n:returns: Clamped input vector." }, { @@ -94838,7 +75880,7 @@ { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", @@ -94856,7 +75898,7 @@ ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", "functionName": "error", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns difference between reference r and current state x-hat." }, { @@ -94869,7 +75911,7 @@ ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", "functionName": "nextR", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the controller's next reference r." }, { @@ -94882,7 +75924,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", @@ -94918,7 +75960,7 @@ { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", @@ -94936,7 +75978,7 @@ { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", @@ -94954,7 +75996,7 @@ { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", @@ -94972,12 +76014,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", @@ -94995,7 +76037,7 @@ ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the observer's state estimate x-hat." }, { @@ -95008,7 +76050,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2", @@ -95078,7 +76120,7 @@ { "defaultValue": "", "name": "clampFunction", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" }, { "defaultValue": "", @@ -95139,7 +76181,7 @@ { "defaultValue": "", "name": "clampFunction", - "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]" + "type": "Callable[[typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]], typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", @@ -95160,7 +76202,7 @@ ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", "functionName": "U", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the controller's calculated control input u." }, { @@ -95173,7 +76215,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", @@ -95191,12 +76233,12 @@ { "defaultValue": "", "name": "u", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", "functionName": "clampInput", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Clamps input vector between system's minimum and maximum allowable input.\n\n:param u: Input vector to clamp.\n\n:returns: Clamped input vector." }, { @@ -95209,7 +76251,7 @@ { "defaultValue": "", "name": "y", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", @@ -95227,7 +76269,7 @@ ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", "functionName": "error", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns difference between reference r and current state x-hat." }, { @@ -95240,7 +76282,7 @@ ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", "functionName": "nextR", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns the controller's next reference r." }, { @@ -95253,7 +76295,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", @@ -95289,7 +76331,7 @@ { "defaultValue": "", "name": "initialState", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", @@ -95307,7 +76349,7 @@ { "defaultValue": "", "name": "nextR", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", @@ -95325,7 +76367,7 @@ { "defaultValue": "", "name": "xHat", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", @@ -95343,12 +76385,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", @@ -95366,7 +76408,7 @@ ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", "functionName": "xhat", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns the observer's state estimate x-hat." }, { @@ -95379,7 +76421,7 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3", @@ -95401,22 +76443,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", @@ -95437,7 +76479,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the system matrix A." }, { @@ -95450,12 +76492,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", @@ -95473,7 +76515,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the input matrix B." }, { @@ -95486,12 +76528,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", @@ -95509,7 +76551,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the output matrix C." }, { @@ -95522,12 +76564,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", @@ -95545,7 +76587,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -95558,12 +76600,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", @@ -95581,12 +76623,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -95596,7 +76638,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -95609,17 +76651,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_1", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -95636,22 +76678,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", @@ -95672,7 +76714,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the system matrix A." }, { @@ -95685,12 +76727,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", @@ -95708,7 +76750,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the input matrix B." }, { @@ -95721,12 +76763,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", @@ -95744,7 +76786,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the output matrix C." }, { @@ -95757,12 +76799,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", @@ -95780,7 +76822,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -95793,12 +76835,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", @@ -95816,12 +76858,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -95831,7 +76873,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -95844,17 +76886,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_2", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -95871,22 +76913,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", @@ -95907,7 +76949,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the system matrix A." }, { @@ -95920,12 +76962,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", @@ -95943,7 +76985,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the input matrix B." }, { @@ -95956,12 +76998,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", @@ -95979,7 +77021,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns the output matrix C." }, { @@ -95992,12 +77034,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", @@ -96015,7 +77057,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -96028,12 +77070,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", @@ -96051,12 +77093,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -96066,7 +77108,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -96079,17 +77121,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_1_1_3", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -96106,22 +77148,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[1, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 2]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", @@ -96142,7 +77184,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the system matrix A." }, { @@ -96155,12 +77197,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", @@ -96178,7 +77220,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the input matrix B." }, { @@ -96191,12 +77233,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", @@ -96214,7 +77256,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[1, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 2]\"]", "tooltip": "Returns the output matrix C." }, { @@ -96227,12 +77269,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", @@ -96250,7 +77292,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -96263,12 +77305,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", @@ -96286,12 +77328,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -96301,7 +77343,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -96314,17 +77356,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_1", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -96341,22 +77383,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", @@ -96377,7 +77419,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the system matrix A." }, { @@ -96390,12 +77432,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", @@ -96413,7 +77455,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the input matrix B." }, { @@ -96426,12 +77468,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", @@ -96449,7 +77491,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the output matrix C." }, { @@ -96462,12 +77504,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", @@ -96485,7 +77527,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -96498,12 +77540,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", @@ -96521,12 +77563,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -96536,7 +77578,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -96549,17 +77591,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_2", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -96576,22 +77618,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", @@ -96612,7 +77654,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the system matrix A." }, { @@ -96625,12 +77667,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", @@ -96648,7 +77690,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Returns the input matrix B." }, { @@ -96661,12 +77703,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", @@ -96684,7 +77726,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[3, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 2]\"]", "tooltip": "Returns the output matrix C." }, { @@ -96697,12 +77739,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", @@ -96720,7 +77762,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -96733,12 +77775,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", @@ -96756,12 +77798,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" }, { "defaultValue": "", @@ -96771,7 +77813,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -96784,17 +77826,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[1, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_1_3", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -96811,22 +77853,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[1, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 2]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[1, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 2]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", @@ -96847,7 +77889,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the system matrix A." }, { @@ -96860,12 +77902,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", @@ -96883,7 +77925,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the input matrix B." }, { @@ -96896,12 +77938,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", @@ -96919,7 +77961,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[1, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 2]\"]", "tooltip": "Returns the output matrix C." }, { @@ -96932,12 +77974,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", @@ -96955,7 +77997,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[1, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 2]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -96968,12 +78010,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", @@ -96991,12 +78033,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -97006,7 +78048,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -97019,17 +78061,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_1", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -97046,22 +78088,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", @@ -97082,7 +78124,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the system matrix A." }, { @@ -97095,12 +78137,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", @@ -97118,7 +78160,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the input matrix B." }, { @@ -97131,12 +78173,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", @@ -97154,7 +78196,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the output matrix C." }, { @@ -97167,12 +78209,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", @@ -97190,7 +78232,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -97203,12 +78245,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", @@ -97226,12 +78268,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -97241,7 +78283,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -97254,17 +78296,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_2", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -97281,22 +78323,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", @@ -97317,7 +78359,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the system matrix A." }, { @@ -97330,12 +78372,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", @@ -97353,7 +78395,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the input matrix B." }, { @@ -97366,12 +78408,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", @@ -97389,7 +78431,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[3, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 2]\"]", "tooltip": "Returns the output matrix C." }, { @@ -97402,12 +78444,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", @@ -97425,7 +78467,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[3, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 2]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -97438,12 +78480,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", @@ -97461,12 +78503,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -97476,7 +78518,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -97489,17 +78531,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_2_2_3", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -97516,22 +78558,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[1, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 3]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[1, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[1, 2]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", @@ -97552,7 +78594,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[3, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 3]\"]", "tooltip": "Returns the system matrix A." }, { @@ -97565,12 +78607,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", @@ -97588,7 +78630,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[3, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 2]\"]", "tooltip": "Returns the input matrix B." }, { @@ -97601,12 +78643,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", @@ -97624,7 +78666,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[1, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 3]\"]", "tooltip": "Returns the output matrix C." }, { @@ -97637,12 +78679,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", @@ -97660,7 +78702,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[1, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 2]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -97673,12 +78715,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", @@ -97696,12 +78738,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -97711,7 +78753,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -97724,17 +78766,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_1", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[1, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[1, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -97751,22 +78793,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[2, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 3]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[2, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 2]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", @@ -97787,7 +78829,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[3, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 3]\"]", "tooltip": "Returns the system matrix A." }, { @@ -97800,12 +78842,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", @@ -97823,7 +78865,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[3, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 2]\"]", "tooltip": "Returns the input matrix B." }, { @@ -97836,12 +78878,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", @@ -97859,7 +78901,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[2, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 3]\"]", "tooltip": "Returns the output matrix C." }, { @@ -97872,12 +78914,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", @@ -97895,7 +78937,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[2, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 2]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -97908,12 +78950,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", @@ -97931,12 +78973,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -97946,7 +78988,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -97959,17 +79001,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_2", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[2, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[2, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -97986,22 +79028,22 @@ { "defaultValue": "", "name": "A", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" }, { "defaultValue": "", "name": "B", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" }, { "defaultValue": "", "name": "C", - "type": "numpy.ndarray[numpy.float64[3, 3]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 3]\"]" }, { "defaultValue": "", "name": "D", - "type": "numpy.ndarray[numpy.float64[3, 2]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 2]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", @@ -98022,7 +79064,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", "functionName": "A", - "returnType": "numpy.ndarray[numpy.float64[3, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 3]\"]", "tooltip": "Returns the system matrix A." }, { @@ -98035,12 +79077,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", @@ -98058,7 +79100,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", "functionName": "B", - "returnType": "numpy.ndarray[numpy.float64[3, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 2]\"]", "tooltip": "Returns the input matrix B." }, { @@ -98071,12 +79113,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", @@ -98094,7 +79136,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", "functionName": "C", - "returnType": "numpy.ndarray[numpy.float64[3, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 3]\"]", "tooltip": "Returns the output matrix C." }, { @@ -98107,12 +79149,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", @@ -98130,7 +79172,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", "functionName": "D", - "returnType": "numpy.ndarray[numpy.float64[3, 2]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 2]\"]", "tooltip": "Returns the feedthrough matrix D." }, { @@ -98143,12 +79185,12 @@ { "defaultValue": "", "name": "i", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "j", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", @@ -98166,12 +79208,12 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" }, { "defaultValue": "", @@ -98181,7 +79223,7 @@ ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", "functionName": "calculateX", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Computes the new x given the old x and the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input.\n:param dt: Timestep for model update." }, { @@ -98194,17 +79236,17 @@ { "defaultValue": "", "name": "x", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" }, { "defaultValue": "", "name": "clampedU", - "type": "numpy.ndarray[numpy.float64[2, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[2, 1]\"]" } ], "declaringClassName": "wpimath.system.LinearSystem_3_2_3", "functionName": "calculateY", - "returnType": "numpy.ndarray[numpy.float64[3, 1]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 1]\"]", "tooltip": "Computes the new y given the control input.\n\nThis is used by state observers directly to run updates based on state\nestimate.\n\n:param x: The current state.\n:param clampedU: The control input." } ], @@ -98246,7 +79288,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98372,7 +79414,7 @@ { "defaultValue": "", "name": "gearboxReduction", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98438,7 +79480,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98451,7 +79493,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98464,7 +79506,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98477,7 +79519,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98490,7 +79532,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98503,7 +79545,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98516,7 +79558,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98529,7 +79571,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98542,7 +79584,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98555,7 +79597,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98568,7 +79610,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98581,7 +79623,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98594,7 +79636,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98607,7 +79649,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98620,7 +79662,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98633,7 +79675,7 @@ { "defaultValue": "1", "name": "numMotors", - "type": "int" + "type": "typing.SupportsInt" } ], "declaringClassName": "wpimath.system.plant.DCMotor", @@ -98675,13 +79717,13 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.system.plant.LinearSystemId", "functionName": "DCMotorSystem", "returnType": "wpimath.system.LinearSystem_2_1_2", - "tooltip": "Create a state-space model of a DC motor system. The states of the system\nare [angular position, angular velocity], inputs are [voltage], and outputs\nare [angular position, angular velocity].\n\n:param motor: The motor (or gearbox) attached to the system.\n:param J: the moment of inertia J of the DC motor.\n:param gearing: Gear ratio from motor to output.\n @throws std::domain_error if J <= 0 or gearing <= 0.\n @see https://github.com/wpilibsuite/sysid" + "tooltip": "Create a state-space model of a DC motor system. The states of the system\nare [angular position, angular velocity]\u1d40, inputs are [voltage], and\noutputs are [angular position, angular velocity]\u1d40.\n\n:param motor: The motor (or gearbox) attached to the system.\n:param J: the moment of inertia J of the DC motor.\n:param gearing: Gear ratio from motor to output.\n @throws std::domain_error if J <= 0 or gearing <= 0.\n @see https://github.com/wpilibsuite/sysid" }, { "args": [ @@ -98699,7 +79741,7 @@ "declaringClassName": "wpimath.system.plant.LinearSystemId", "functionName": "DCMotorSystem", "returnType": "wpimath.system.LinearSystem_2_1_2", - "tooltip": "Create a state-space model of a DC motor system from its kV\n(volts/(unit/sec)) and kA (volts/(unit/sec\u00b2)). These constants can be\nfound using SysId. the states of the system are [position, velocity],\ninputs are [voltage], and outputs are [position].\n\nYou MUST use an SI unit (i.e. meters or radians) for the Distance template\nargument. You may still use non-SI units (such as feet or inches) for the\nactual method arguments; they will automatically be converted to SI\ninternally.\n\nThe parameters provided by the user are from this feedforward model:\n\nu = K_v v + K_a a\n\n@throws std::domain_error if kV < 0 or kA <= 0.\n\n:param kV: The velocity gain, in volts/(unit/sec).\n:param kA: The acceleration gain, in volts/(unit/sec\u00b2)." + "tooltip": "Create a state-space model of a DC motor system from its kV\n(volts/(unit/sec)) and kA (volts/(unit/sec\u00b2)). These constants can be\nfound using SysId. the states of the system are [angular position, angular\nvelocity]\u1d40, inputs are [voltage], and outputs are [angular position,\nangular velocity]\u1d40.\n\nYou MUST use an SI unit (i.e. meters or radians) for the Distance template\nargument. You may still use non-SI units (such as feet or inches) for the\nactual method arguments; they will automatically be converted to SI\ninternally.\n\nThe parameters provided by the user are from this feedforward model:\n\nu = K_v v + K_a a\n\n@throws std::domain_error if kV < 0 or kA <= 0.\n\n:param kV: The velocity gain, in volts/(unit/sec).\n:param kA: The acceleration gain, in volts/(unit/sec\u00b2)." }, { "args": [ @@ -98749,13 +79791,13 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.system.plant.LinearSystemId", "functionName": "drivetrainVelocitySystem", "returnType": "wpimath.system.LinearSystem_2_2_2", - "tooltip": "Create a state-space model of differential drive drivetrain. In this model,\nthe states are [left velocity, right velocity], the inputs are [left\nvoltage, right voltage], and the outputs are [left velocity, right\nvelocity]\n\n:param motor: The motor (or gearbox) driving the drivetrain.\n:param mass: The mass of the robot in kilograms.\n:param r: The radius of the wheels in meters.\n:param rb: The radius of the base (half of the track width), in meters.\n:param J: The moment of inertia of the robot.\n:param gearing: Gear ratio from motor to wheel.\n @throws std::domain_error if mass <= 0, r <= 0, rb <= 0, J <= 0, or\n gearing <= 0." + "tooltip": "Create a state-space model of differential drive drivetrain. In this model,\nthe states are [left velocity, right velocity]\u1d40, the inputs are [left\nvoltage, right voltage], and the outputs are [left velocity, right\nvelocity]\u1d40.\n\n:param motor: The motor (or gearbox) driving the drivetrain.\n:param mass: The mass of the robot in kilograms.\n:param r: The radius of the wheels in meters.\n:param rb: The radius of the base (half of the trackwidth), in meters.\n:param J: The moment of inertia of the robot.\n:param gearing: Gear ratio from motor to wheel.\n @throws std::domain_error if mass <= 0, r <= 0, rb <= 0, J <= 0, or\n gearing <= 0." }, { "args": [ @@ -98777,13 +79819,13 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.system.plant.LinearSystemId", "functionName": "elevatorSystem", "returnType": "wpimath.system.LinearSystem_2_1_2", - "tooltip": "Create a state-space model of the elevator system. The states of the system\nare [position, velocity], inputs are [voltage], and outputs are [position].\n\n:param motor: The motor (or gearbox) attached to the carriage.\n:param mass: The mass of the elevator carriage, in kilograms.\n:param radius: The radius of the elevator's driving drum, in meters.\n:param gearing: Gear ratio from motor to carriage.\n @throws std::domain_error if mass <= 0, radius <= 0, or gearing <= 0." + "tooltip": "Create a state-space model of the elevator system. The states of the system\nare [position, velocity]\u1d40, inputs are [voltage], and outputs are [position,\nvelocity]\u1d40.\n\n:param motor: The motor (or gearbox) attached to the carriage.\n:param mass: The mass of the elevator carriage, in kilograms.\n:param radius: The radius of the elevator's driving drum, in meters.\n:param gearing: Gear ratio from motor to carriage.\n @throws std::domain_error if mass <= 0, radius <= 0, or gearing <= 0." }, { "args": [ @@ -98800,7 +79842,7 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.system.plant.LinearSystemId", @@ -98884,8 +79926,8 @@ ], "declaringClassName": "wpimath.system.plant.LinearSystemId", "functionName": "identifyPositionSystemMeters", - "returnType": "wpimath.system.LinearSystem_2_1_1", - "tooltip": "Create a state-space model for a 1 DOF position system from its kV\n(volts/(unit/sec)) and kA (volts/(unit/sec\u00b2)). These constants can be\nfound using SysId. the states of the system are [position, velocity],\ninputs are [voltage], and outputs are [position].\n\nYou MUST use an SI unit (i.e. meters or radians) for the Distance template\nargument. You may still use non-SI units (such as feet or inches) for the\nactual method arguments; they will automatically be converted to SI\ninternally.\n\nThe parameters provided by the user are from this feedforward model:\n\nu = K_v v + K_a a\n\n@throws std::domain_error if kV < 0 or kA <= 0.\n@see https://github.com/wpilibsuite/sysid\n\n:param kV: The velocity gain, in volts/(unit/sec).\n:param kA: The acceleration gain, in volts/(unit/sec\u00b2)." + "returnType": "wpimath.system.LinearSystem_2_1_2", + "tooltip": "Create a state-space model for a 1 DOF position system from its kV\n(volts/(unit/sec)) and kA (volts/(unit/sec\u00b2)). These constants can be\nfound using SysId. the states of the system are [position, velocity]\u1d40,\ninputs are [voltage], and outputs are [position, velocity]\u1d40.\n\nYou MUST use an SI unit (i.e. meters or radians) for the Distance template\nargument. You may still use non-SI units (such as feet or inches) for the\nactual method arguments; they will automatically be converted to SI\ninternally.\n\nThe parameters provided by the user are from this feedforward model:\n\nu = K_v v + K_a a\n\n@throws std::domain_error if kV < 0 or kA <= 0.\n@see https://github.com/wpilibsuite/sysid\n\n:param kV: The velocity gain, in volts/(unit/sec).\n:param kA: The acceleration gain, in volts/(unit/sec\u00b2)." }, { "args": [ @@ -98902,7 +79944,7 @@ ], "declaringClassName": "wpimath.system.plant.LinearSystemId", "functionName": "identifyPositionSystemRadians", - "returnType": "wpimath.system.LinearSystem_2_1_1", + "returnType": "wpimath.system.LinearSystem_2_1_2", "tooltip": "" }, { @@ -98956,13 +79998,13 @@ { "defaultValue": "", "name": "gearing", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.system.plant.LinearSystemId", "functionName": "singleJointedArmSystem", "returnType": "wpimath.system.LinearSystem_2_1_2", - "tooltip": "Create a state-space model of a single-jointed arm system.The states of the\nsystem are [angle, angular velocity], inputs are [voltage], and outputs are\n[angle].\n\n:param motor: The motor (or gearbox) attached to the arm.\n:param J: The moment of inertia J of the arm.\n:param gearing: Gear ratio from motor to arm.\n @throws std::domain_error if J <= 0 or gearing <= 0." + "tooltip": "Create a state-space model of a single-jointed arm system.The states of the\nsystem are [angle, angular velocity]\u1d40, inputs are [voltage], and outputs\nare [angle, angular velocity]\u1d40.\n\n:param motor: The motor (or gearbox) attached to the arm.\n:param J: The moment of inertia J of the arm.\n:param gearing: Gear ratio from motor to arm.\n @throws std::domain_error if J <= 0 or gearing <= 0." } ] }, @@ -99469,7 +80511,7 @@ { "defaultValue": "", "name": "i", - "type": "float" + "type": "typing.SupportsFloat" } ], "declaringClassName": "wpimath.trajectory.Trajectory.State", @@ -100031,93 +81073,6 @@ } ] }, - { - "className": "wpimath.trajectory.TrajectoryUtil", - "classVariables": [], - "constructors": [ - { - "args": [ - { - "defaultValue": "", - "name": "args", - "type": "tuple" - }, - { - "defaultValue": "", - "name": "kwargs", - "type": "dict" - } - ], - "declaringClassName": "wpimath.trajectory.TrajectoryUtil", - "functionName": "__init__", - "returnType": "wpimath.trajectory.TrajectoryUtil", - "tooltip": "Initialize self. See help(type(self)) for accurate signature." - } - ], - "enums": [], - "instanceMethods": [], - "instanceVariables": [], - "moduleName": "wpimath.trajectory", - "staticMethods": [ - { - "args": [ - { - "defaultValue": "", - "name": "jsonStr", - "type": "str" - } - ], - "declaringClassName": "wpimath.trajectory.TrajectoryUtil", - "functionName": "deserializeTrajectory", - "returnType": "wpimath.trajectory.Trajectory", - "tooltip": "Serializes a Trajectory to PathWeaver-style JSON.\n\n:param jsonStr: the string containing the serialized JSON\n\n:returns: the trajectory represented by the JSON" - }, - { - "args": [ - { - "defaultValue": "", - "name": "path", - "type": "str" - } - ], - "declaringClassName": "wpimath.trajectory.TrajectoryUtil", - "functionName": "fromPathweaverJson", - "returnType": "wpimath.trajectory.Trajectory", - "tooltip": "Imports a Trajectory from a JSON file exported from PathWeaver.\n\n:param path: The path of the json file to import from.\n\n:returns: The trajectory represented by the file." - }, - { - "args": [ - { - "defaultValue": "", - "name": "trajectory", - "type": "wpimath.trajectory.Trajectory" - } - ], - "declaringClassName": "wpimath.trajectory.TrajectoryUtil", - "functionName": "serializeTrajectory", - "returnType": "str", - "tooltip": "Deserializes a Trajectory from JSON exported from PathWeaver.\n\n:param trajectory: the trajectory to export\n\n:returns: the string containing the serialized JSON" - }, - { - "args": [ - { - "defaultValue": "", - "name": "trajectory", - "type": "wpimath.trajectory.Trajectory" - }, - { - "defaultValue": "", - "name": "path", - "type": "str" - } - ], - "declaringClassName": "wpimath.trajectory.TrajectoryUtil", - "functionName": "toPathweaverJson", - "returnType": "None", - "tooltip": "Exports a Trajectory to a PathWeaver-style JSON file.\n\n:param trajectory: the trajectory to export\n:param path: the path of the file to export to" - } - ] - }, { "className": "wpimath.trajectory.TrapezoidProfile", "classVariables": [], @@ -100200,7 +81155,7 @@ "declaringClassName": "wpimath.trajectory.TrapezoidProfile", "functionName": "timeLeftUntil", "returnType": "wpimath.units.seconds", - "tooltip": "Returns the time left until a target distance in the profile is reached.\n\n:param target: The target distance.\n\n:returns: The time left until a target distance in the profile is reached." + "tooltip": "Returns the time left until a target distance in the profile is reached.\n\n:param target: The target distance.\n\n:returns: The time left until a target distance in the profile is reached, or\n zero if no goal was set." }, { "args": [ @@ -100213,7 +81168,7 @@ "declaringClassName": "wpimath.trajectory.TrapezoidProfile", "functionName": "totalTime", "returnType": "wpimath.units.seconds", - "tooltip": "Returns the total time the profile takes to reach the goal.\n\n:returns: The total time the profile takes to reach the goal." + "tooltip": "Returns the total time the profile takes to reach the goal.\n\n:returns: The total time the profile takes to reach the goal, or zero if no\n goal was set." } ], "instanceVariables": [], @@ -100227,12 +81182,12 @@ { "args": [ { - "defaultValue": "", + "defaultValue": "0", "name": "maxVelocity", "type": "wpimath.units.units_per_second" }, { - "defaultValue": "", + "defaultValue": "0", "name": "maxAcceleration", "type": "wpimath.units.units_per_second_squared" } @@ -100240,7 +81195,7 @@ "declaringClassName": "wpimath.trajectory.TrapezoidProfile.Constraints", "functionName": "__init__", "returnType": "wpimath.trajectory.TrapezoidProfile.Constraints", - "tooltip": "Constructs constraints for a Trapezoid Profile.\n\n:param maxVelocity: Maximum velocity.\n:param maxAcceleration: Maximum acceleration." + "tooltip": "Constructs constraints for a Trapezoid Profile.\n\n:param maxVelocity: Maximum velocity, must be non-negative.\n:param maxAcceleration: Maximum acceleration, must be non-negative." } ], "enums": [], @@ -100386,7 +81341,7 @@ "declaringClassName": "wpimath.trajectory.TrapezoidProfileRadians", "functionName": "timeLeftUntil", "returnType": "wpimath.units.seconds", - "tooltip": "Returns the time left until a target distance in the profile is reached.\n\n:param target: The target distance.\n\n:returns: The time left until a target distance in the profile is reached." + "tooltip": "Returns the time left until a target distance in the profile is reached.\n\n:param target: The target distance.\n\n:returns: The time left until a target distance in the profile is reached, or\n zero if no goal was set." }, { "args": [ @@ -100399,7 +81354,7 @@ "declaringClassName": "wpimath.trajectory.TrapezoidProfileRadians", "functionName": "totalTime", "returnType": "wpimath.units.seconds", - "tooltip": "Returns the total time the profile takes to reach the goal.\n\n:returns: The total time the profile takes to reach the goal." + "tooltip": "Returns the total time the profile takes to reach the goal.\n\n:returns: The total time the profile takes to reach the goal, or zero if no\n goal was set." } ], "instanceVariables": [], @@ -100413,12 +81368,12 @@ { "args": [ { - "defaultValue": "", + "defaultValue": "0", "name": "maxVelocity", "type": "wpimath.units.radians_per_second" }, { - "defaultValue": "", + "defaultValue": "0", "name": "maxAcceleration", "type": "wpimath.units.radians_per_second_squared" } @@ -100426,7 +81381,7 @@ "declaringClassName": "wpimath.trajectory.TrapezoidProfileRadians.Constraints", "functionName": "__init__", "returnType": "wpimath.trajectory.TrapezoidProfileRadians.Constraints", - "tooltip": "Constructs constraints for a Trapezoid Profile.\n\n:param maxVelocity: Maximum velocity.\n:param maxAcceleration: Maximum acceleration." + "tooltip": "Constructs constraints for a Trapezoid Profile.\n\n:param maxVelocity: Maximum velocity, must be non-negative.\n:param maxAcceleration: Maximum acceleration, must be non-negative." } ], "enums": [], @@ -101790,60 +82745,7 @@ ], "modules": [ { - "enums": [ - { - "enumClassName": "wpilib.AnalogTriggerType", - "enumValues": [ - "kFallingPulse", - "kInWindow", - "kRisingPulse", - "kState" - ], - "moduleName": "wpilib", - "tooltip": "Defines the state in which the AnalogTrigger triggers.\n\nMembers:\n\n kInWindow : In window.\n\n kState : State.\n\n kRisingPulse : Rising Pulse.\n\n kFallingPulse : Falling pulse." - }, - { - "enumClassName": "wpilib.CompressorConfigType", - "enumValues": [ - "Analog", - "Digital", - "Disabled", - "Hybrid" - ], - "moduleName": "wpilib", - "tooltip": "Compressor config type.\n\nMembers:\n\n Disabled : Disabled.\n\n Digital : Digital.\n\n Analog : Analog.\n\n Hybrid : Hybrid." - }, - { - "enumClassName": "wpilib.PneumaticsModuleType", - "enumValues": [ - "CTREPCM", - "REVPH" - ], - "moduleName": "wpilib", - "tooltip": "Pneumatics module type.\n\nMembers:\n\n CTREPCM : CTRE PCM.\n\n REVPH : REV PH." - }, - { - "enumClassName": "wpilib.RadioLEDState", - "enumValues": [ - "kGreen", - "kOff", - "kOrange", - "kRed" - ], - "moduleName": "wpilib", - "tooltip": "State for the radio led.\n\nMembers:\n\n kOff : ///< Off.\n\n kGreen : ///< Green.\n\n kRed : ///< Red.\n\n kOrange : ///< Orange." - }, - { - "enumClassName": "wpilib.RuntimeType", - "enumValues": [ - "kRoboRIO", - "kRoboRIO2", - "kSimulation" - ], - "moduleName": "wpilib", - "tooltip": "Runtime type.\n\nMembers:\n\n kRoboRIO : roboRIO 1.0.\n\n kRoboRIO2 : roboRIO 2.0.\n\n kSimulation : Simulation runtime." - } - ], + "enums": [], "functions": [ { "args": [], @@ -101855,7 +82757,7 @@ "args": [], "functionName": "getDeployDirectory", "returnType": "str", - "tooltip": "Obtains the deploy directory of the program, which is the remote location\nthe deploy directory is deployed to by default. On the roboRIO, this is\n/home/lvuser/py/deploy. In simulation, it is where the simulation was launched\nfrom, in the subdirectory \"deploy\" (`dirname(robot.py)`/deploy).\n\n:returns: The result of the operating directory lookup" + "tooltip": "Obtains the deploy directory of the program, which is the remote location\nthe deploy directory is deployed to by default. On the robot, this is\n/home/systemcore/py/deploy. In simulation, it is where the simulation was launched\nfrom, in the subdirectory \"deploy\" (`dirname(robot.py)`/deploy).\n\n:returns: The result of the operating directory lookup" }, { "args": [], @@ -101867,7 +82769,7 @@ "args": [], "functionName": "getOperatingDirectory", "returnType": "str", - "tooltip": "Obtains the operating directory of the program. On the roboRIO, this\nis /home/lvuser/py. In simulation, it is the location of robot.py\n\n:returns: The result of the operating directory lookup." + "tooltip": "Obtains the operating directory of the program. On the robot, this\nis /home/systemcore/py. In simulation, it is the location of robot.py\n\n:returns: The result of the operating directory lookup." }, { "args": [], @@ -101919,7 +82821,7 @@ { "defaultValue": "", "name": "priority", - "type": "int" + "type": "typing.SupportsInt" } ], "functionName": "setCurrentThreadPriority", @@ -101949,19 +82851,7 @@ "moduleVariables": [] }, { - "enums": [ - { - "enumClassName": "wpilib.counter.EdgeConfiguration", - "enumValues": [ - "kBoth", - "kFallingEdge", - "kNone", - "kRisingEdge" - ], - "moduleName": "wpilib.counter", - "tooltip": "Edge configuration.\n\nMembers:\n\n kNone : No edge configuration (neither rising nor falling).\n\n kRisingEdge : Rising edge configuration.\n\n kFallingEdge : Falling edge configuration.\n\n kBoth : Both rising and falling edges configuration." - } - ], + "enums": [], "functions": [], "moduleName": "wpilib.counter", "moduleVariables": [] @@ -101984,79 +82874,6 @@ "moduleName": "wpilib.interfaces", "moduleVariables": [] }, - { - "enums": [ - { - "enumClassName": "wpilib.shuffleboard.BuiltInLayouts", - "enumValues": [ - "kGrid", - "kList" - ], - "moduleName": "wpilib.shuffleboard", - "tooltip": "The types of layouts bundled with Shuffleboard.\n\n
{@code\nShuffleboardLayout myList = Shuffleboard::GetTab(\"My Tab\")\n.GetLayout(BuiltinLayouts::kList, \"My List\");\n}
\n\nMembers:\n\n kList : Groups components in a vertical list. New widgets added to the layout will\nbe placed at the bottom of the list. \nCustom properties: \n\n\n\n
NameTypeDefault ValueNotes
Label positionString\"BOTTOM\"The position of component labels inside the grid. One of\n``[\"TOP\", \"LEFT\", \"BOTTOM\", \"RIGHT\", \"HIDDEN\"``
\n\n kGrid : Groups components in an *n* x *m* grid. Grid layouts default to\n3x3. \nCustom properties: \n\n\n\n\n\n\n\n
NameTypeDefault ValueNotes
Number of columnsNumber3Must be in the\nrange [1,15]
Number of rowsNumber3Must be in the\nrange [1,15]
Label position String\"BOTTOM\"The position of component labels inside the grid.\nOne of ``[\"TOP\", \"LEFT\", \"BOTTOM\", \"RIGHT\", \"HIDDEN\"``
" - }, - { - "enumClassName": "wpilib.shuffleboard.BuiltInWidgets", - "enumValues": [ - "k3AxisAccelerometer", - "kAccelerometer", - "kBooleanBox", - "kCameraStream", - "kComboBoxChooser", - "kCommand", - "kDial", - "kDifferentialDrive", - "kEncoder", - "kField", - "kGraph", - "kGyro", - "kMecanumDrive", - "kMotorController", - "kNumberBar", - "kNumberSlider", - "kPIDCommand", - "kPIDController", - "kPowerDistribution", - "kRelay", - "kSplitButtonChooser", - "kTextView", - "kToggleButton", - "kToggleSwitch", - "kVoltageView" - ], - "moduleName": "wpilib.shuffleboard", - "tooltip": "The types of the widgets bundled with Shuffleboard.\n\nFor example, setting a number to be displayed with a slider:\n
{@code\nNetworkTableEntry example = Shuffleboard.getTab(\"My Tab\")\n.add(\"My Number\", 0)\n.withWidget(BuiltInWidgets.kNumberSlider)\n.getEntry();\n}
\n\nEach value in this enum goes into detail on what data types that widget\ncan support, as well as the custom properties that widget uses.\n\nMembers:\n\n kTextView : Displays a value with a simple text field.\nSupported types:\n\n- String\n- Number\n- Boolean\n\nThis widget has no custom properties.\n\n kNumberSlider : Displays a number with a controllable slider.\nSupported types:\n\n- Number\n\nCustom properties:\n\n\n\n
NameTypeDefault ValueNotes
MinNumber-1.0The minimum value of the\nslider
MaxNumber1.0The maximum\nvalue of the slider
Block\nincrementNumber0.0625 How much to move the\nslider by with the arrow keys
\n\n kNumberBar : Displays a number with a view-only bar.\nSupported types:\n\n- Number\n\nCustom properties:\n\n\n\n\n
NameTypeDefault ValueNotes
MinNumber-1.0The minimum value of the\nbar
MaxNumber1.0The maximum\nvalue of the bar
CenterNumber0The center (\"zero\") value\nof the bar
\n\n kDial : Displays a number with a view-only dial. Displayed values are rounded to\nthe nearest integer. \nSupported types: - Number\n\nCustom properties:\n\n\n\n
NameTypeDefault ValueNotes
MinNumber0The minimum value of the\ndial
MaxNumber100The maximum\nvalue of the dial
Show\nvalueBooleantrue Whether or not to show the\nvalue as text
\n\n kGraph : Displays a number with a graph. **NOTE:** graphs can be taxing\non the computer running the dashboard. Keep the number of visible data\npoints to a minimum. Making the widget smaller also helps with performance,\nbut may cause the graph to become difficult to read. \nSupported types:\n\n- Number\n- Number array\n\nCustom properties:\n\n\n\n\n
NameTypeDefault ValueNotes
Visible timeNumber30How long, in seconds, should past data be visible for
\n\n kBooleanBox : Displays a boolean value as a large colored box.\nSupported types:\n\n- Boolean\n\nCustom properties:\n\n\n\n\n\n\n
NameTypeDefault ValueNotes
Color when trueColor\"green\"Can be specified as a string (``\"#00FF00\"``) or a rgba integer\n(``0x00FF0000``)\n
Color when falseColor\"red\"Can be specified as a string or a number
\n\n kToggleButton : Displays a boolean with a large interactive toggle button.\nSupported types:\n\n- Boolean\n\nThis widget has no custom properties.\n\n kToggleSwitch : Displays a boolean with a fixed-size toggle switch.\nSupported types:\n\n- Boolean\n\nThis widget has no custom properties.\n\n kVoltageView : Displays an analog input or a raw number with a number bar.\nSupported types:\n\n- Number\n- AnalogInput\n\nCustom properties:\n\n\n\n\n\n\n
NameTypeDefault ValueNotes
MinNumber0The minimum value of the\nbar
MaxNumber5The maximum\nvalue of the bar
CenterNumber0The center (\"zero\") value\nof the bar
OrientationString\"HORIZONTAL\"The orientation of the bar. One of {@code [\"HORIZONTAL\",\n\"VERTICAL\"]}
Number of tick\nmarksNumber5 The number of discrete ticks on the\nbar
\n\n kPowerDistribution : Displays a PowerDistribution. \nSupported types: -\nPowerDistribution\n\nCustom properties:\n\n\n\n\n
NameTypeDefault ValueNotes
Show voltage and current valuesBooleantrueWhether or not to display the voltage and current draw
\n\n kComboBoxChooser : Displays a SendableChooser with a dropdown combo box with a list of\noptions.\nSupported types:\n\n- SendableChooser\n\nThis widget has no custom properties.\n\n kSplitButtonChooser : Displays a SendableChooserwith a toggle button for each available option.\nSupported types:\n\n- SendableChooser\n\nThis widget has no custom properties.\n\n kEncoder : Displays an Encoder displaying its speed,\ntotal traveled distance, and its distance per tick. \nSupported types:\n\n- Encoder\n\nThis widget has no custom properties.\n\n kMotorController : Displays a MotorController.\nThe motor controller will be controllable from the dashboard when test mode\nis enabled, but will otherwise be view-only. \nSupported types:\n- PWMMotorController\n- DMC60\n- Jaguar\n- PWMTalonSRX\n- PWMVictorSPX\n- SD540\n- Spark\n- Talon\n- Victor\n- VictorSP\n- MotorControllerGroup\n- Any custom subclass of ``SpeedContorller``\n\nCustom properties:\n\n\n\n\n
NameTypeDefault ValueNotes
OrientationString\"HORIZONTAL\"One of ``[\"HORIZONTAL\", \"VERTICAL\"]``
\n\n kCommand : Displays a command with a toggle button. Pressing the button will start the\ncommand, and the button will automatically release when the command\ncompletes. \nSupported types: - Command - CommandGroup\n- Any custom subclass of ``Command`` or ``CommandGroup``\n\nThis widget has no custom properties.\n\n kPIDCommand : Displays a PID command with a checkbox and an editor for the PIDF\nconstants. Selecting the checkbox will start the command, and the checkbox\nwill automatically deselect when the command completes. \nSupported\ntypes: - PIDCommand\n- Any custom subclass of ``PIDCommand``\n\nThis widget has no custom properties.\n\n kPIDController : Displays a PID controller with an editor for the PIDF constants and a\ntoggle switch for enabling and disabling the controller. \nSupported\ntypes: - PIDController\n\nThis widget has no custom properties.\n\n kAccelerometer : Displays an accelerometer with a number bar displaying the magnitude of the\nacceleration and text displaying the exact value. \nSupported types:\n- AnalogAccelerometer\n\nCustom properties:\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDefault ValueNotes
MinNumber-1The minimum acceleration value to display
MaxNumber1The maximum acceleration value to display
Show textBooleantrueShow or hide the acceleration values
PrecisionNumber2How many numbers to display after the decimal point
Show tick marksBooleanfalseShow or hide the tick marks on the number bars
\n\n k3AxisAccelerometer : Displays a 3-axis accelerometer with a number bar for each axis'\nacceleration. \nSupported types: - ADXL345_I2C -\nADXL345_SPI - ADXL362\n\nCustom properties:\n\n\n\n\n\n\n\n\n
NameTypeDefault ValueNotes
RangeRangek16GThe accelerometer\nrange
Show valueBooleantrueShow or hide the acceleration values
PrecisionNumber2How many numbers to display after the decimal point
Show tick marksBooleanfalseShow or hide the tick marks on the number bars
\n\n kGyro : Displays a gyro with a dial from 0 to 360 degrees.\nSupported types:\n\n- ADXRS450_Gyro\n- AnalogGyro\n- Any custom subclass of ``GyroBase`` (such as a MXP gyro)\n\nCustom properties:\n\n\n\n\n\n\n
NameTypeDefault ValueNotes
Major tick\nspacingNumber45Degrees
Starting angleNumber180How far to rotate the entire dial, in degrees
Show tick mark ringBooleantrue
\n\n kRelay : Displays a relay with toggle buttons for each supported mode (off, on,\nforward, reverse). \nSupported types: - Relay\n\nThis widget has no custom properties.\n\n kDifferentialDrive : Displays a differential drive with a widget that displays the speed of each\nside of the drivebase and a vector for the direction and rotation of the\ndrivebase. The widget will be controllable if the robot is in test mode.\nSupported types:\n\n- DifferentialDrive\n\nCustom properties:\n\n\n\n\n\n
NameTypeDefault ValueNotes
Number of wheelsNumber4Must be a\npositive even integer\n
Wheel diameterNumber80Pixels
Show velocity vectorsBooleantrue
\n\n kMecanumDrive : Displays a mecanum drive with a widget that displays the speed of each\nwheel, and vectors for the direction and rotation of the drivebase. The\nwidget will be controllable if the robot is in test mode. \nSupported\ntypes: - MecanumDrive\n\nCustom properties:\n\n\n\n
NameTypeDefault ValueNotes
Show velocity vectorsBooleantrue
\n\n kCameraStream : Displays a camera stream.\nSupported types:\n\n- VideoSource (as long as it is streaming on an MJPEG server)\n\nCustom properties:\n\n\n\n\n\n\n\n\n\n
NameTypeDefault ValueNotes
Show crosshairBooleantrueShow or hide a crosshair on the image
Crosshair colorColor\"white\"Can be a string or a rgba integer
Show controlsBooleantrueShow or hide the\nstream controls\n
RotationString\"NONE\"Rotates the displayed image. One of {@code [\"NONE\", \"QUARTER_CW\",\n\"QUARTER_CCW\", \"HALF\"]}\n
\n\n kField : Displays a field2d object.\nSupported types:\n\n- Field2d" - }, - { - "enumClassName": "wpilib.shuffleboard.ShuffleboardEventImportance", - "enumValues": [ - "kCritical", - "kHigh", - "kLow", - "kNormal", - "kTrivial" - ], - "moduleName": "wpilib.shuffleboard", - "tooltip": "Members:\n\n kTrivial\n\n kLow\n\n kNormal\n\n kHigh\n\n kCritical" - } - ], - "functions": [ - { - "args": [ - { - "defaultValue": "", - "name": "importance", - "type": "wpilib.shuffleboard.ShuffleboardEventImportance" - } - ], - "functionName": "shuffleboardEventImportanceName", - "returnType": "str", - "tooltip": "Returns name of the given enum.\n\n:returns: Name of the given enum." - } - ], - "moduleName": "wpilib.shuffleboard", - "moduleVariables": [] - }, { "enums": [], "functions": [ @@ -102143,20 +82960,7 @@ "moduleVariables": [] }, { - "enums": [ - { - "enumClassName": "wpilib.sysid.State", - "enumValues": [ - "kDynamicForward", - "kDynamicReverse", - "kNone", - "kQuasistaticForward", - "kQuasistaticReverse" - ], - "moduleName": "wpilib.sysid", - "tooltip": "Possible state of a SysId routine.\n\nMembers:\n\n kQuasistaticForward : Quasistatic forward test.\n\n kQuasistaticReverse : Quasistatic reverse test.\n\n kDynamicForward : Dynamic forward test.\n\n kDynamicReverse : Dynamic reverse test.\n\n kNone : No test." - } - ], + "enums": [], "functions": [], "moduleName": "wpilib.sysid", "moduleVariables": [] @@ -102181,17 +82985,17 @@ { "defaultValue": "", "name": "value", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "deadband", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "1.0", "name": "maxMagnitude", - "type": "float" + "type": "typing.SupportsFloat" } ], "functionName": "applyDeadband", @@ -102203,12 +83007,12 @@ { "defaultValue": "", "name": "x", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "y", - "type": "int" + "type": "typing.SupportsInt" } ], "functionName": "floorDiv", @@ -102220,12 +83024,12 @@ { "defaultValue": "", "name": "x", - "type": "int" + "type": "typing.SupportsInt" }, { "defaultValue": "", "name": "y", - "type": "int" + "type": "typing.SupportsInt" } ], "functionName": "floorMod", @@ -102237,17 +83041,17 @@ { "defaultValue": "", "name": "input", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "minimumInput", - "type": "float" + "type": "typing.SupportsFloat" }, { "defaultValue": "", "name": "maximumInput", - "type": "float" + "type": "typing.SupportsFloat" } ], "functionName": "inputModulus", @@ -102275,6 +83079,60 @@ "functionName": "objectToRobotPose", "returnType": "wpimath.geometry.Pose3d", "tooltip": "" + }, + { + "args": [ + { + "defaultValue": "", + "name": "current", + "type": "wpimath.geometry.Translation2d" + }, + { + "defaultValue": "", + "name": "next", + "type": "wpimath.geometry.Translation2d" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + }, + { + "defaultValue": "", + "name": "maxVelocity", + "type": "wpimath.units.meters_per_second" + } + ], + "functionName": "slewRateLimit", + "returnType": "wpimath.geometry.Translation2d", + "tooltip": "Limits translation velocity.\n\n:param current: Translation at current timestep.\n:param next: Translation at next timestep.\n:param dt: Timestep duration.\n:param maxVelocity: Maximum translation velocity.\n\n:returns: Returns the next Translation2d limited to maxVelocity" + }, + { + "args": [ + { + "defaultValue": "", + "name": "current", + "type": "wpimath.geometry.Translation3d" + }, + { + "defaultValue": "", + "name": "next", + "type": "wpimath.geometry.Translation3d" + }, + { + "defaultValue": "", + "name": "dt", + "type": "wpimath.units.seconds" + }, + { + "defaultValue": "", + "name": "maxVelocity", + "type": "wpimath.units.meters_per_second" + } + ], + "functionName": "slewRateLimit", + "returnType": "wpimath.geometry.Translation3d", + "tooltip": "Limits translation velocity.\n\n:param current: Translation at current timestep.\n:param next: Translation at next timestep.\n:param dt: Timestep duration.\n:param maxVelocity: Maximum translation velocity.\n\n:returns: Returns the next Translation3d limited to maxVelocity" } ], "moduleName": "wpimath", @@ -102306,11 +83164,11 @@ { "defaultValue": "", "name": "rotation", - "type": "numpy.ndarray[numpy.float64[3, 1]]" + "type": "typing.Annotated[numpy.typing.ArrayLike, numpy.float64, \"[3, 1]\"]" } ], "functionName": "rotationVectorToMatrix", - "returnType": "numpy.ndarray[numpy.float64[3, 3]]", + "returnType": "typing.Annotated[numpy.typing.NDArray[numpy.float64], \"[3, 3]\"]", "tooltip": "Applies the hat operator to a rotation vector.\n\nIt takes a rotation vector and returns the corresponding matrix\nrepresentation of the Lie algebra element (a 3x3 rotation matrix).\n\n:param rotation: The rotation vector.\n\n:returns: The rotation vector as a 3x3 rotation matrix." } ], @@ -102645,8 +83503,6 @@ ], "ntcore.NTSendable": [ "wpilib.ADXL345_I2C", - "wpilib.ADXL345_SPI", - "wpilib.ADXL362", "wpilib.Field2d", "wpilib.Mechanism2d" ], @@ -102730,11 +83586,6 @@ "ntcore.StructArrayTopic", "ntcore.StructTopic" ], - "wpilib.DigitalSource": [ - "wpilib.AnalogTriggerOutput", - "wpilib.DigitalInput", - "wpilib.DigitalOutput" - ], "wpilib.IterativeRobotBase": [ "wpilib.TimedRobot" ], @@ -102742,17 +83593,13 @@ "wpilib.MechanismLigament2d" ], "wpilib.MotorSafety": [ - "wpilib.NidecBrushless", "wpilib.PWMMotorController", - "wpilib.Relay", "wpilib.drive.RobotDriveBase" ], - "wpilib.PWM": [ - "wpilib.Servo" - ], "wpilib.PWMMotorController": [ "wpilib.DMC60", "wpilib.Jaguar", + "wpilib.Koors40", "wpilib.PWMSparkFlex", "wpilib.PWMSparkMax", "wpilib.PWMTalonFX", @@ -102761,6 +83608,7 @@ "wpilib.PWMVictorSPX", "wpilib.SD540", "wpilib.Spark", + "wpilib.SparkMini", "wpilib.Talon", "wpilib.Victor", "wpilib.VictorSP" @@ -102786,7 +83634,6 @@ "wpilib.event.NetworkBooleanEvent" ], "wpilib.interfaces.CounterBase": [ - "wpilib.Counter", "wpilib.Encoder" ], "wpilib.interfaces.GenericHID": [ @@ -102798,114 +83645,8 @@ ], "wpilib.interfaces.MotorController": [ "wpilib.MotorControllerGroup", - "wpilib.NidecBrushless", "wpilib.PWMMotorController" ], - "wpilib.shuffleboard.ShuffleboardComponentBase": [ - "wpilib.shuffleboard._ComplexComponent", - "wpilib.shuffleboard._LayoutComponent", - "wpilib.shuffleboard._SimpleComponent", - "wpilib.shuffleboard._SuppliedValueComponent_bool", - "wpilib.shuffleboard._SuppliedValueComponent_double", - "wpilib.shuffleboard._SuppliedValueComponent_float", - "wpilib.shuffleboard._SuppliedValueComponent_integer", - "wpilib.shuffleboard._SuppliedValueComponent_string", - "wpilib.shuffleboard._SuppliedValueComponent_vector_bool", - "wpilib.shuffleboard._SuppliedValueComponent_vector_double", - "wpilib.shuffleboard._SuppliedValueComponent_vector_float", - "wpilib.shuffleboard._SuppliedValueComponent_vector_int", - "wpilib.shuffleboard._SuppliedValueComponent_vector_raw", - "wpilib.shuffleboard._SuppliedValueComponent_vector_string" - ], - "wpilib.shuffleboard.ShuffleboardContainer": [ - "wpilib.shuffleboard.ShuffleboardLayout", - "wpilib.shuffleboard.ShuffleboardTab" - ], - "wpilib.shuffleboard.ShuffleboardValue": [ - "wpilib.shuffleboard.ShuffleboardComponentBase", - "wpilib.shuffleboard.ShuffleboardContainer" - ], - "wpilib.shuffleboard._ComplexComponent": [ - "wpilib.shuffleboard._ComplexWidget" - ], - "wpilib.shuffleboard._ComplexWidget": [ - "wpilib.shuffleboard.ComplexWidget" - ], - "wpilib.shuffleboard._LayoutComponent": [ - "wpilib.shuffleboard.ShuffleboardLayout" - ], - "wpilib.shuffleboard._SimpleComponent": [ - "wpilib.shuffleboard._SimpleWidget" - ], - "wpilib.shuffleboard._SimpleWidget": [ - "wpilib.shuffleboard.SimpleWidget" - ], - "wpilib.shuffleboard._SuppliedValueComponent_bool": [ - "wpilib.shuffleboard._SuppliedValueWidget_bool" - ], - "wpilib.shuffleboard._SuppliedValueComponent_double": [ - "wpilib.shuffleboard._SuppliedValueWidget_double" - ], - "wpilib.shuffleboard._SuppliedValueComponent_float": [ - "wpilib.shuffleboard._SuppliedValueWidget_float" - ], - "wpilib.shuffleboard._SuppliedValueComponent_integer": [ - "wpilib.shuffleboard._SuppliedValueWidget_integer" - ], - "wpilib.shuffleboard._SuppliedValueComponent_string": [ - "wpilib.shuffleboard._SuppliedValueWidget_string" - ], - "wpilib.shuffleboard._SuppliedValueComponent_vector_bool": [ - "wpilib.shuffleboard._SuppliedValueWidget_vector_bool" - ], - "wpilib.shuffleboard._SuppliedValueComponent_vector_double": [ - "wpilib.shuffleboard._SuppliedValueWidget_vector_double" - ], - "wpilib.shuffleboard._SuppliedValueComponent_vector_float": [ - "wpilib.shuffleboard._SuppliedValueWidget_vector_float" - ], - "wpilib.shuffleboard._SuppliedValueComponent_vector_int": [ - "wpilib.shuffleboard._SuppliedValueWidget_vector_int" - ], - "wpilib.shuffleboard._SuppliedValueComponent_vector_raw": [ - "wpilib.shuffleboard._SuppliedValueWidget_vector_raw" - ], - "wpilib.shuffleboard._SuppliedValueComponent_vector_string": [ - "wpilib.shuffleboard._SuppliedValueWidget_vector_string" - ], - "wpilib.shuffleboard._SuppliedValueWidget_bool": [ - "wpilib.shuffleboard.SuppliedBoolValueWidget" - ], - "wpilib.shuffleboard._SuppliedValueWidget_double": [ - "wpilib.shuffleboard.SuppliedDoubleValueWidget" - ], - "wpilib.shuffleboard._SuppliedValueWidget_float": [ - "wpilib.shuffleboard.SuppliedFloatValueWidget" - ], - "wpilib.shuffleboard._SuppliedValueWidget_integer": [ - "wpilib.shuffleboard.SuppliedIntegerValueWidget" - ], - "wpilib.shuffleboard._SuppliedValueWidget_string": [ - "wpilib.shuffleboard.SuppliedStringValueWidget" - ], - "wpilib.shuffleboard._SuppliedValueWidget_vector_bool": [ - "wpilib.shuffleboard.SuppliedBoolListValueWidget" - ], - "wpilib.shuffleboard._SuppliedValueWidget_vector_double": [ - "wpilib.shuffleboard.SuppliedDoubleListValueWidget" - ], - "wpilib.shuffleboard._SuppliedValueWidget_vector_float": [ - "wpilib.shuffleboard.SuppliedFloatListValueWidget" - ], - "wpilib.shuffleboard._SuppliedValueWidget_vector_int": [ - "wpilib.shuffleboard.SuppliedIntListValueWidget" - ], - "wpilib.shuffleboard._SuppliedValueWidget_vector_raw": [ - "wpilib.shuffleboard.SuppliedRawValueWidget" - ], - "wpilib.shuffleboard._SuppliedValueWidget_vector_string": [ - "wpilib.shuffleboard.SuppliedStringListValueWidget" - ], "wpilib.simulation.GenericHIDSim": [ "wpilib.simulation.JoystickSim", "wpilib.simulation.PS4ControllerSim", @@ -103036,21 +83777,12 @@ ], "wpiutil.Sendable": [ "ntcore.NTSendable", - "wpilib.ADIS16448_IMU", - "wpilib.ADIS16470_IMU", - "wpilib.ADXRS450_Gyro", "wpilib.AnalogAccelerometer", "wpilib.AnalogEncoder", "wpilib.AnalogGyro", "wpilib.AnalogInput", - "wpilib.AnalogOutput", "wpilib.AnalogPotentiometer", - "wpilib.AnalogTrigger", - "wpilib.AnalogTriggerOutput", - "wpilib.BuiltInAccelerometer", "wpilib.Compressor", - "wpilib.Counter", - "wpilib.DigitalGlitchFilter", "wpilib.DigitalInput", "wpilib.DigitalOutput", "wpilib.DoubleSolenoid", @@ -103058,20 +83790,17 @@ "wpilib.DutyCycleEncoder", "wpilib.Encoder", "wpilib.MotorControllerGroup", - "wpilib.NidecBrushless", "wpilib.PS4Controller", "wpilib.PS5Controller", "wpilib.PWM", "wpilib.PWMMotorController", "wpilib.PowerDistribution", - "wpilib.Relay", "wpilib.SendableChooserBase", + "wpilib.Servo", "wpilib.SharpIR", "wpilib.Solenoid", "wpilib.StadiaController", - "wpilib.Ultrasonic", "wpilib.XboxController", - "wpilib.counter.ExternalDirectionCounter", "wpilib.counter.Tachometer", "wpilib.counter.UpDownCounter", "wpilib.drive.DifferentialDrive", @@ -103083,58 +83812,6 @@ ], "wpiutil.SendableBuilder": [ "ntcore.NTSendableBuilder" - ], - "wpiutil.log.DataLog": [ - "wpiutil.DataLogBackgroundWriter", - "wpiutil.DataLogWriter" - ], - "wpiutil.log.DataLogEntry": [ - "wpiutil.log.StructArrayLogEntry", - "wpiutil.log.StructLogEntry", - "wpiutil.log._BooleanArrayLogEntryImpl", - "wpiutil.log._BooleanLogEntryImpl", - "wpiutil.log._DoubleArrayLogEntryImpl", - "wpiutil.log._DoubleLogEntryImpl", - "wpiutil.log._FloatArrayLogEntryImpl", - "wpiutil.log._FloatLogEntryImpl", - "wpiutil.log._IntegerArrayLogEntryImpl", - "wpiutil.log._IntegerLogEntryImpl", - "wpiutil.log._RawLogEntryImpl", - "wpiutil.log._StringArrayLogEntryImpl", - "wpiutil.log._StringLogEntryImpl" - ], - "wpiutil.log._BooleanArrayLogEntryImpl": [ - "wpiutil.log.BooleanArrayLogEntry" - ], - "wpiutil.log._BooleanLogEntryImpl": [ - "wpiutil.log.BooleanLogEntry" - ], - "wpiutil.log._DoubleArrayLogEntryImpl": [ - "wpiutil.log.DoubleArrayLogEntry" - ], - "wpiutil.log._DoubleLogEntryImpl": [ - "wpiutil.log.DoubleLogEntry" - ], - "wpiutil.log._FloatArrayLogEntryImpl": [ - "wpiutil.log.FloatArrayLogEntry" - ], - "wpiutil.log._FloatLogEntryImpl": [ - "wpiutil.log.FloatLogEntry" - ], - "wpiutil.log._IntegerArrayLogEntryImpl": [ - "wpiutil.log.IntegerArrayLogEntry" - ], - "wpiutil.log._IntegerLogEntryImpl": [ - "wpiutil.log.IntegerLogEntry" - ], - "wpiutil.log._RawLogEntryImpl": [ - "wpiutil.log.RawLogEntry" - ], - "wpiutil.log._StringArrayLogEntryImpl": [ - "wpiutil.log.StringArrayLogEntry" - ], - "wpiutil.log._StringLogEntryImpl": [ - "wpiutil.log.StringLogEntry" ] } } \ No newline at end of file