\n\n:param points: Reference to the spline points.\n:param constraints: A vector of various velocity and acceleration\n constraints.\n:param startVelocity: The start velocity for the trajectory.\n:param endVelocity: The end velocity for the trajectory.\n:param maxVelocity: The max velocity for the trajectory.\n:param maxAcceleration: The max acceleration for the trajectory.\n:param reversed: Whether the robot should move backwards. Note that the\n robot will still move from a -> b -> ... -> z as defined in the waypoints.\n\n:returns: The trajectory.", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrajectoryParameterizer", "FUNC": "timeParameterizeTrajectory"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myList"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myList"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "TrajectoryParameterizer",
- contents: contents,
- className: "wpimath.trajectory.TrajectoryParameterizer",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.TrajectoryUtil.ts b/src/blocks/generated/class_wpimath.trajectory.TrajectoryUtil.ts
deleted file mode 100644
index e02330a9..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.TrajectoryUtil.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.TrajectoryUtil
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTrajectory"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.Trajectory", "args": [{"name": "jsonStr", "type": "str"}], "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", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrajectoryUtil", "FUNC": "deserializeTrajectory"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTrajectory"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.Trajectory", "args": [{"name": "path", "type": "str"}], "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.", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrajectoryUtil", "FUNC": "fromPathweaverJson"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "str", "args": [{"name": "trajectory", "type": "wpimath.trajectory.Trajectory"}], "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", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrajectoryUtil", "FUNC": "serializeTrajectory"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrajectory"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "None", "args": [{"name": "trajectory", "type": "wpimath.trajectory.Trajectory"}, {"name": "path", "type": "str"}], "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", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrajectoryUtil", "FUNC": "toPathweaverJson"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrajectory"}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "TrajectoryUtil",
- contents: contents,
- className: "wpimath.trajectory.TrajectoryUtil",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfile.Constraints.ts b/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfile.Constraints.ts
deleted file mode 100644
index a3befcbc..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfile.Constraints.ts
+++ /dev/null
@@ -1,32 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as getPythonVariable from "../mrc_get_python_variable";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.TrapezoidProfile.Constraints
-
-export function initialize() {
- getPythonVariable.initializeInstanceVariableGetter("wpimath.trajectory.TrapezoidProfile.Constraints", "wpimath.units.units_per_second_squared", ["maxAcceleration"], ["Maximum acceleration."]);
- getPythonVariable.initializeInstanceVariableGetter("wpimath.trajectory.TrapezoidProfile.Constraints", "wpimath.units.units_per_second", ["maxVelocity"], ["Maximum velocity."]);
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 3 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.TrapezoidProfile.Constraints", "varType": "wpimath.units.units_per_second_squared", "importModule": "", "selfLabel": "constraints", "selfType": "wpimath.trajectory.TrapezoidProfile.Constraints"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile.Constraints", "VAR": "maxAcceleration"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myConstraints"}}}}}},
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.TrapezoidProfile.Constraints", "varType": "wpimath.units.units_per_second", "importModule": "", "selfLabel": "constraints", "selfType": "wpimath.trajectory.TrapezoidProfile.Constraints"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile.Constraints", "VAR": "maxVelocity"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myConstraints"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myConstraints"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.TrapezoidProfile.Constraints", "args": [{"name": "maxVelocity", "type": "wpimath.units.units_per_second"}, {"name": "maxAcceleration", "type": "wpimath.units.units_per_second_squared"}], "tooltip": "Constructs constraints for a Trapezoid Profile.\n\n:param maxVelocity: Maximum velocity.\n:param maxAcceleration: Maximum acceleration.", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile.Constraints"}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "Constraints",
- contents: contents,
- className: "wpimath.trajectory.TrapezoidProfile.Constraints",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfile.State.ts b/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfile.State.ts
deleted file mode 100644
index a4d612b9..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfile.State.ts
+++ /dev/null
@@ -1,32 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as getPythonVariable from "../mrc_get_python_variable";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.TrapezoidProfile.State
-
-export function initialize() {
- getPythonVariable.initializeInstanceVariableGetter("wpimath.trajectory.TrapezoidProfile.State", "float", ["position"], ["The position at this state."]);
- getPythonVariable.initializeInstanceVariableGetter("wpimath.trajectory.TrapezoidProfile.State", "wpimath.units.units_per_second", ["velocity"], ["The velocity at this state."]);
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 3 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.TrapezoidProfile.State", "varType": "float", "importModule": "", "selfLabel": "state", "selfType": "wpimath.trajectory.TrapezoidProfile.State"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile.State", "VAR": "position"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myState"}}}}}},
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.TrapezoidProfile.State", "varType": "wpimath.units.units_per_second", "importModule": "", "selfLabel": "state", "selfType": "wpimath.trajectory.TrapezoidProfile.State"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile.State", "VAR": "velocity"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myState"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myState"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.TrapezoidProfile.State", "args": [{"name": "position", "type": "float"}, {"name": "velocity", "type": "wpimath.units.units_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile.State"}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "State",
- contents: contents,
- className: "wpimath.trajectory.TrapezoidProfile.State",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfile.ts b/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfile.ts
deleted file mode 100644
index a33a9660..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfile.ts
+++ /dev/null
@@ -1,31 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.TrapezoidProfile
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 5 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTrapezoidProfile"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.TrapezoidProfile", "args": [{"name": "constraints", "type": "wpimath.trajectory.TrapezoidProfile.Constraints"}], "tooltip": "Constructs a TrapezoidProfile.\n\n:param constraints: The constraints on the profile, like maximum velocity.", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myConstraints"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myState"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.TrapezoidProfile.State", "args": [{"name": "trapezoidProfile", "type": "wpimath.trajectory.TrapezoidProfile"}, {"name": "t", "type": "wpimath.units.seconds"}, {"name": "current", "type": "wpimath.trajectory.TrapezoidProfile.State"}, {"name": "goal", "type": "wpimath.trajectory.TrapezoidProfile.State"}], "tooltip": "Calculates the position and velocity for the profile at a time t where the\ncurrent state is at time t = 0.\n\n:param t: How long to advance from the current state toward the desired\n state.\n:param current: The current state.\n:param goal: The desired state when the profile is complete.\n\n:returns: The position and velocity of the profile at time t.", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile", "FUNC": "calculate"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrapezoidProfile"}}}}, "ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myState"}}}}, "ARG3": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myState"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "bool", "args": [{"name": "trapezoidProfile", "type": "wpimath.trajectory.TrapezoidProfile"}, {"name": "t", "type": "wpimath.units.seconds"}], "tooltip": "Returns true if the profile has reached the goal.\n\nThe profile has reached the goal if the time since the profile started has\nexceeded the profile's total time.\n\n:param t: The time since the beginning of the profile.\n\n:returns: True if the profile has reached the goal.", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile", "FUNC": "isFinished"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrapezoidProfile"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.seconds", "args": [{"name": "trapezoidProfile", "type": "wpimath.trajectory.TrapezoidProfile"}, {"name": "target", "type": "float"}], "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.", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile", "FUNC": "timeLeftUntil"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrapezoidProfile"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.seconds", "args": [{"name": "trapezoidProfile", "type": "wpimath.trajectory.TrapezoidProfile"}], "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.", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfile", "FUNC": "totalTime"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrapezoidProfile"}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "TrapezoidProfile",
- contents: contents,
- className: "wpimath.trajectory.TrapezoidProfile",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.Constraints.ts b/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.Constraints.ts
deleted file mode 100644
index 58beefbb..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.Constraints.ts
+++ /dev/null
@@ -1,32 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as getPythonVariable from "../mrc_get_python_variable";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.TrapezoidProfileRadians.Constraints
-
-export function initialize() {
- getPythonVariable.initializeInstanceVariableGetter("wpimath.trajectory.TrapezoidProfileRadians.Constraints", "wpimath.units.radians_per_second_squared", ["maxAcceleration"], ["Maximum acceleration."]);
- getPythonVariable.initializeInstanceVariableGetter("wpimath.trajectory.TrapezoidProfileRadians.Constraints", "wpimath.units.radians_per_second", ["maxVelocity"], ["Maximum velocity."]);
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 3 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.TrapezoidProfileRadians.Constraints", "varType": "wpimath.units.radians_per_second_squared", "importModule": "", "selfLabel": "constraints", "selfType": "wpimath.trajectory.TrapezoidProfileRadians.Constraints"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians.Constraints", "VAR": "maxAcceleration"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myConstraints"}}}}}},
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.TrapezoidProfileRadians.Constraints", "varType": "wpimath.units.radians_per_second", "importModule": "", "selfLabel": "constraints", "selfType": "wpimath.trajectory.TrapezoidProfileRadians.Constraints"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians.Constraints", "VAR": "maxVelocity"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myConstraints"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myConstraints"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.TrapezoidProfileRadians.Constraints", "args": [{"name": "maxVelocity", "type": "wpimath.units.radians_per_second"}, {"name": "maxAcceleration", "type": "wpimath.units.radians_per_second_squared"}], "tooltip": "Constructs constraints for a Trapezoid Profile.\n\n:param maxVelocity: Maximum velocity.\n:param maxAcceleration: Maximum acceleration.", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians.Constraints"}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "Constraints",
- contents: contents,
- className: "wpimath.trajectory.TrapezoidProfileRadians.Constraints",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.State.ts b/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.State.ts
deleted file mode 100644
index 87406fd8..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.State.ts
+++ /dev/null
@@ -1,32 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as getPythonVariable from "../mrc_get_python_variable";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.TrapezoidProfileRadians.State
-
-export function initialize() {
- getPythonVariable.initializeInstanceVariableGetter("wpimath.trajectory.TrapezoidProfileRadians.State", "wpimath.units.radians", ["position"], ["The position at this state."]);
- getPythonVariable.initializeInstanceVariableGetter("wpimath.trajectory.TrapezoidProfileRadians.State", "wpimath.units.radians_per_second", ["velocity"], ["The velocity at this state."]);
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 3 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.TrapezoidProfileRadians.State", "varType": "wpimath.units.radians", "importModule": "", "selfLabel": "state", "selfType": "wpimath.trajectory.TrapezoidProfileRadians.State"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians.State", "VAR": "position"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myState"}}}}}},
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.TrapezoidProfileRadians.State", "varType": "wpimath.units.radians_per_second", "importModule": "", "selfLabel": "state", "selfType": "wpimath.trajectory.TrapezoidProfileRadians.State"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians.State", "VAR": "velocity"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myState"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myState"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.TrapezoidProfileRadians.State", "args": [{"name": "position", "type": "wpimath.units.radians"}, {"name": "velocity", "type": "wpimath.units.radians_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians.State"}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "State",
- contents: contents,
- className: "wpimath.trajectory.TrapezoidProfileRadians.State",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.ts b/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.ts
deleted file mode 100644
index d1f55491..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.ts
+++ /dev/null
@@ -1,31 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.TrapezoidProfileRadians
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 5 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTrapezoidProfileRadians"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.TrapezoidProfileRadians", "args": [{"name": "constraints", "type": "wpimath.trajectory.TrapezoidProfileRadians.Constraints"}], "tooltip": "Constructs a TrapezoidProfile.\n\n:param constraints: The constraints on the profile, like maximum velocity.", "importModule": "wpimath.trajectory"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myConstraints"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myState"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.TrapezoidProfileRadians.State", "args": [{"name": "trapezoidProfileRadians", "type": "wpimath.trajectory.TrapezoidProfileRadians"}, {"name": "t", "type": "wpimath.units.seconds"}, {"name": "current", "type": "wpimath.trajectory.TrapezoidProfileRadians.State"}, {"name": "goal", "type": "wpimath.trajectory.TrapezoidProfileRadians.State"}], "tooltip": "Calculates the position and velocity for the profile at a time t where the\ncurrent state is at time t = 0.\n\n:param t: How long to advance from the current state toward the desired\n state.\n:param current: The current state.\n:param goal: The desired state when the profile is complete.\n\n:returns: The position and velocity of the profile at time t.", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians", "FUNC": "calculate"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrapezoidProfileRadians"}}}}, "ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myState"}}}}, "ARG3": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myState"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "bool", "args": [{"name": "trapezoidProfileRadians", "type": "wpimath.trajectory.TrapezoidProfileRadians"}, {"name": "t", "type": "wpimath.units.seconds"}], "tooltip": "Returns true if the profile has reached the goal.\n\nThe profile has reached the goal if the time since the profile started has\nexceeded the profile's total time.\n\n:param t: The time since the beginning of the profile.\n\n:returns: True if the profile has reached the goal.", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians", "FUNC": "isFinished"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrapezoidProfileRadians"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.seconds", "args": [{"name": "trapezoidProfileRadians", "type": "wpimath.trajectory.TrapezoidProfileRadians"}, {"name": "target", "type": "wpimath.units.radians"}], "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.", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians", "FUNC": "timeLeftUntil"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrapezoidProfileRadians"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.seconds", "args": [{"name": "trapezoidProfileRadians", "type": "wpimath.trajectory.TrapezoidProfileRadians"}], "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.", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.TrapezoidProfileRadians", "FUNC": "totalTime"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrapezoidProfileRadians"}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "TrapezoidProfileRadians",
- contents: contents,
- className: "wpimath.trajectory.TrapezoidProfileRadians",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.CentripetalAccelerationConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.CentripetalAccelerationConstraint.ts
deleted file mode 100644
index 3c0c9c89..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.CentripetalAccelerationConstraint.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.CentripetalAccelerationConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myCentripetalAccelerationConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint", "args": [{"name": "maxCentripetalAcceleration", "type": "wpimath.units.meters_per_second_squared"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myCentripetalAccelerationConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint", "args": [{"name": "maxCentripetalAcceleration", "type": "wpimath.units.feet_per_second_squared"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint", "FUNC": "fromFps"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "centripetalAccelerationConstraint", "type": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myCentripetalAccelerationConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "centripetalAccelerationConstraint", "type": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myCentripetalAccelerationConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "CentripetalAccelerationConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.CentripetalAccelerationConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint.ts
deleted file mode 100644
index 79bbd764..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myDifferentialDriveKinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.DifferentialDriveKinematics"}, {"name": "maxSpeed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myDifferentialDriveKinematics"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myDifferentialDriveKinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.DifferentialDriveKinematics"}, {"name": "maxSpeed", "type": "wpimath.units.feet_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint", "FUNC": "fromFps"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myDifferentialDriveKinematics"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "differentialDriveKinematicsConstraint", "type": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myDifferentialDriveKinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "differentialDriveKinematicsConstraint", "type": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myDifferentialDriveKinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "DifferentialDriveKinematicsConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint.ts
deleted file mode 100644
index c3aeb54d..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint.ts
+++ /dev/null
@@ -1,29 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 3 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myDifferentialDriveVoltageConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint", "args": [{"name": "feedforward", "type": "wpimath.controller.SimpleMotorFeedforwardMeters"}, {"name": "kinematics", "type": "wpimath.kinematics.DifferentialDriveKinematics"}, {"name": "maxVoltage", "type": "wpimath.units.volts"}], "tooltip": "Creates a new DifferentialDriveVoltageConstraint.\n\n:param feedforward: A feedforward component describing the behavior of the\n drive.\n:param kinematics: A kinematics component describing the drive geometry.\n:param maxVoltage: The maximum voltage available to the motors while\n following the path. Should be somewhat less than the nominal battery\n voltage (12V) to account for \"voltage sag\" due to current draw.", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySimpleMotorFeedforwardMeters"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myDifferentialDriveKinematics"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "differentialDriveVoltageConstraint", "type": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myDifferentialDriveVoltageConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "differentialDriveVoltageConstraint", "type": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myDifferentialDriveVoltageConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "DifferentialDriveVoltageConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.EllipticalRegionConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.EllipticalRegionConstraint.ts
deleted file mode 100644
index 0292f092..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.EllipticalRegionConstraint.ts
+++ /dev/null
@@ -1,31 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.EllipticalRegionConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 5 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myEllipticalRegionConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.EllipticalRegionConstraint", "args": [{"name": "center", "type": "wpimath.geometry.Translation2d"}, {"name": "xWidth", "type": "wpimath.units.meters"}, {"name": "yWidth", "type": "wpimath.units.meters"}, {"name": "rotation", "type": "wpimath.geometry.Rotation2d"}, {"name": "constraint", "type": "wpimath.trajectory.constraint.TrajectoryConstraint"}], "tooltip": "Constructs a new EllipticalRegionConstraint.\n\n:deprecated: Use constructor taking Ellipse2d instead.\n\n:param center: The center of the ellipse in which to enforce the constraint.\n:param xWidth: The width of the ellipse in which to enforce the constraint.\n:param yWidth: The height of the ellipse in which to enforce the constraint.\n:param rotation: The rotation to apply to all radii around the origin.\n:param constraint: The constraint to enforce when the robot is within the\n region.", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.EllipticalRegionConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTranslation2d"}}}}, "ARG3": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myRotation2d"}}}}, "ARG4": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrajectoryConstraint"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myEllipticalRegionConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.EllipticalRegionConstraint", "args": [{"name": "ellipse", "type": "wpimath.geometry.Ellipse2d"}, {"name": "constraint", "type": "wpimath.trajectory.constraint.TrajectoryConstraint"}], "tooltip": "Constructs a new EllipticalRegionConstraint.\n\n:param ellipse: The ellipse in which to enforce the constraint.\n:param constraint: The constraint to enforce when the robot is within the\n region.", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.EllipticalRegionConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myEllipse2d"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrajectoryConstraint"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myEllipticalRegionConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.constraint.EllipticalRegionConstraint", "args": [{"name": "center", "type": "wpimath.geometry.Translation2d"}, {"name": "xWidth", "type": "wpimath.units.feet"}, {"name": "yWidth", "type": "wpimath.units.feet"}, {"name": "rotation", "type": "wpimath.geometry.Rotation2d"}, {"name": "constraint", "type": "wpimath.trajectory.constraint.TrajectoryConstraint"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.EllipticalRegionConstraint", "FUNC": "fromFeet"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTranslation2d"}}}}, "ARG3": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myRotation2d"}}}}, "ARG4": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrajectoryConstraint"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "ellipticalRegionConstraint", "type": "wpimath.trajectory.constraint.EllipticalRegionConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.EllipticalRegionConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myEllipticalRegionConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "ellipticalRegionConstraint", "type": "wpimath.trajectory.constraint.EllipticalRegionConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.EllipticalRegionConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myEllipticalRegionConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "EllipticalRegionConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.EllipticalRegionConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.MaxVelocityConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.MaxVelocityConstraint.ts
deleted file mode 100644
index 0059af50..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.MaxVelocityConstraint.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.MaxVelocityConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMaxVelocityConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.MaxVelocityConstraint", "args": [{"name": "maxVelocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "Constructs a new MaxVelocityConstraint.\n\n:param maxVelocity: The max velocity.", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.MaxVelocityConstraint"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMaxVelocityConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.constraint.MaxVelocityConstraint", "args": [{"name": "maxVelocity", "type": "wpimath.units.feet_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.MaxVelocityConstraint", "FUNC": "fromFps"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "maxVelocityConstraint", "type": "wpimath.trajectory.constraint.MaxVelocityConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.MaxVelocityConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMaxVelocityConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "maxVelocityConstraint", "type": "wpimath.trajectory.constraint.MaxVelocityConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.MaxVelocityConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMaxVelocityConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "MaxVelocityConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.MaxVelocityConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint.ts
deleted file mode 100644
index 155d86aa..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMecanumDriveKinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.MecanumDriveKinematics"}, {"name": "maxSpeed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMecanumDriveKinematics"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMecanumDriveKinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.MecanumDriveKinematics"}, {"name": "maxSpeed", "type": "wpimath.units.feet_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint", "FUNC": "fromFps"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMecanumDriveKinematics"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "mecanumDriveKinematicsConstraint", "type": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMecanumDriveKinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "mecanumDriveKinematicsConstraint", "type": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMecanumDriveKinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "MecanumDriveKinematicsConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.RectangularRegionConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.RectangularRegionConstraint.ts
deleted file mode 100644
index 79fef3e9..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.RectangularRegionConstraint.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.RectangularRegionConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myRectangularRegionConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.RectangularRegionConstraint", "args": [{"name": "bottomLeftPoint", "type": "wpimath.geometry.Translation2d"}, {"name": "topRightPoint", "type": "wpimath.geometry.Translation2d"}, {"name": "constraint", "type": "wpimath.trajectory.constraint.TrajectoryConstraint"}], "tooltip": "Constructs a new RectangularRegionConstraint.\n\n:deprecated: Use constructor taking Rectangle2d instead.\n\n:param bottomLeftPoint: The bottom left point of the rectangular region in\n which to enforce the constraint.\n:param topRightPoint: The top right point of the rectangular region in which\n to enforce the constraint.\n:param constraint: The constraint to enforce when the robot is within the\n region.", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.RectangularRegionConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTranslation2d"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTranslation2d"}}}}, "ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrajectoryConstraint"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myRectangularRegionConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.RectangularRegionConstraint", "args": [{"name": "rectangle", "type": "wpimath.geometry.Rectangle2d"}, {"name": "constraint", "type": "wpimath.trajectory.constraint.TrajectoryConstraint"}], "tooltip": "Constructs a new RectangularRegionConstraint.\n\n:param rectangle: The rectangular region in which to enforce the constraint.\n:param constraint: The constraint to enforce when the robot is within the\n region.", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.RectangularRegionConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myRectangle2d"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrajectoryConstraint"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "rectangularRegionConstraint", "type": "wpimath.trajectory.constraint.RectangularRegionConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.RectangularRegionConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myRectangularRegionConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "rectangularRegionConstraint", "type": "wpimath.trajectory.constraint.RectangularRegionConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.RectangularRegionConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myRectangularRegionConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "RectangularRegionConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.RectangularRegionConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint.ts
deleted file mode 100644
index a77e7a02..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySwerveDrive2KinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.SwerveDrive2Kinematics"}, {"name": "maxSpeed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive2Kinematics"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySwerveDrive2KinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.SwerveDrive2Kinematics"}, {"name": "maxSpeed", "type": "wpimath.units.feet_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint", "FUNC": "fromFps"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive2Kinematics"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "swerveDrive2KinematicsConstraint", "type": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive2KinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "swerveDrive2KinematicsConstraint", "type": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive2KinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "SwerveDrive2KinematicsConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint.ts
deleted file mode 100644
index b42d318a..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySwerveDrive3KinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.SwerveDrive3Kinematics"}, {"name": "maxSpeed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive3Kinematics"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySwerveDrive3KinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.SwerveDrive3Kinematics"}, {"name": "maxSpeed", "type": "wpimath.units.feet_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint", "FUNC": "fromFps"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive3Kinematics"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "swerveDrive3KinematicsConstraint", "type": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive3KinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "swerveDrive3KinematicsConstraint", "type": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive3KinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "SwerveDrive3KinematicsConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint.ts
deleted file mode 100644
index c08d06c7..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySwerveDrive4KinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.SwerveDrive4Kinematics"}, {"name": "maxSpeed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive4Kinematics"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySwerveDrive4KinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.SwerveDrive4Kinematics"}, {"name": "maxSpeed", "type": "wpimath.units.feet_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint", "FUNC": "fromFps"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive4Kinematics"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "swerveDrive4KinematicsConstraint", "type": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive4KinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "swerveDrive4KinematicsConstraint", "type": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive4KinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "SwerveDrive4KinematicsConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint.ts
deleted file mode 100644
index 1d1e7090..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySwerveDrive6KinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.SwerveDrive6Kinematics"}, {"name": "maxSpeed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive6Kinematics"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySwerveDrive6KinematicsConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "static", "returnType": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint", "args": [{"name": "kinematics", "type": "wpimath.kinematics.SwerveDrive6Kinematics"}, {"name": "maxSpeed", "type": "wpimath.units.feet_per_second"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint", "FUNC": "fromFps"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive6Kinematics"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "swerveDrive6KinematicsConstraint", "type": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive6KinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "swerveDrive6KinematicsConstraint", "type": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySwerveDrive6KinematicsConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "SwerveDrive6KinematicsConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.TrajectoryConstraint.MinMax.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.TrajectoryConstraint.MinMax.ts
deleted file mode 100644
index 94f64d78..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.TrajectoryConstraint.MinMax.ts
+++ /dev/null
@@ -1,36 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as getPythonVariable from "../mrc_get_python_variable";
-import * as setPythonVariable from "../mrc_set_python_variable";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.TrajectoryConstraint.MinMax
-
-export function initialize() {
- getPythonVariable.initializeInstanceVariableGetter("wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "wpimath.units.meters_per_second_squared", ["maxAcceleration", "minAcceleration"], ["The maximum acceleration.", "The minimum acceleration."]);
- setPythonVariable.initializeInstanceVariableSetter("wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "wpimath.units.meters_per_second_squared", ["maxAcceleration", "minAcceleration"], ["The maximum acceleration.", "The minimum acceleration."]);
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 6 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "varType": "wpimath.units.meters_per_second_squared", "importModule": "", "selfLabel": "minMax", "selfType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "VAR": "maxAcceleration"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMinMax"}}}}}},
- {"kind": "block", "type": "mrc_set_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "varType": "wpimath.units.meters_per_second_squared", "importModule": "", "selfLabel": "minMax", "selfType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "VAR": "maxAcceleration"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMinMax"}}}}}},
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "varType": "wpimath.units.meters_per_second_squared", "importModule": "", "selfLabel": "minMax", "selfType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "VAR": "minAcceleration"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMinMax"}}}}}},
- {"kind": "block", "type": "mrc_set_python_variable", "extraState": {"varKind": "instance", "moduleOrClassName": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "varType": "wpimath.units.meters_per_second_squared", "importModule": "", "selfLabel": "minMax", "selfType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "VAR": "minAcceleration"}, "inputs": {"SELF": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMinMax"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "minAcceleration", "type": "wpimath.units.meters_per_second_squared"}, {"name": "maxAcceleration", "type": "wpimath.units.meters_per_second_squared"}], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax"}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "MinMax",
- contents: contents,
- className: "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/class_wpimath.trajectory.constraint.TrajectoryConstraint.ts b/src/blocks/generated/class_wpimath.trajectory.constraint.TrajectoryConstraint.ts
deleted file mode 100644
index 17549438..00000000
--- a/src/blocks/generated/class_wpimath.trajectory.constraint.TrajectoryConstraint.ts
+++ /dev/null
@@ -1,29 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for class wpimath.trajectory.constraint.TrajectoryConstraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 3 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTrajectoryConstraint"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "constructor", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint", "args": [], "tooltip": "", "importModule": "wpimath.trajectory.constraint"}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.TrajectoryConstraint"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.units.meters_per_second", "args": [{"name": "trajectoryConstraint", "type": "wpimath.trajectory.constraint.TrajectoryConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "velocity", "type": "wpimath.units.meters_per_second"}], "tooltip": "Returns the max velocity given the current pose and curvature.\n\n:param pose: The pose at the current point in the trajectory.\n:param curvature: The curvature at the current point in the trajectory.\n:param velocity: The velocity at the current point in the trajectory before\n constraints are applied.\n\n:returns: The absolute maximum velocity.", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.TrajectoryConstraint", "FUNC": "maxVelocity"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrajectoryConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myMinMax"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "instance", "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax", "args": [{"name": "trajectoryConstraint", "type": "wpimath.trajectory.constraint.TrajectoryConstraint"}, {"name": "pose", "type": "wpimath.geometry.Pose2d"}, {"name": "curvature", "type": "wpimath.units.radians_per_meter"}, {"name": "speed", "type": "wpimath.units.meters_per_second"}], "tooltip": "Returns the minimum and maximum allowable acceleration for the trajectory\ngiven pose, curvature, and speed.\n\n:param pose: The pose at the current point in the trajectory.\n:param curvature: The curvature at the current point in the trajectory.\n:param speed: The speed at the current point in the trajectory.\n\n:returns: The min and max acceleration bounds.", "importModule": ""}, "fields": {"MODULE_OR_CLASS": "wpimath.trajectory.constraint.TrajectoryConstraint", "FUNC": "minMaxAcceleration"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTrajectoryConstraint"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose2d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonClassCategory = {
- kind: "category",
- name: "TrajectoryConstraint",
- contents: contents,
- className: "wpimath.trajectory.constraint.TrajectoryConstraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_hal.exceptions.ts b/src/blocks/generated/module_hal.exceptions.ts
deleted file mode 100644
index f7f184a3..00000000
--- a/src/blocks/generated/module_hal.exceptions.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module hal.exceptions
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "exceptions",
- contents: contents,
- moduleName: "hal.exceptions",
- packageName: "hal",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_hal.simulation.ts b/src/blocks/generated/module_hal.simulation.ts
deleted file mode 100644
index 6fd662aa..00000000
--- a/src/blocks/generated/module_hal.simulation.ts
+++ /dev/null
@@ -1,461 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as pythonEnum from "../mrc_get_python_enum_value";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module hal.simulation
-
-export function initialize() {
- pythonEnum.initializeEnum("hal.simulation.AnalogTriggerMode", ["HALSIM_AnalogTriggerAveraged", "HALSIM_AnalogTriggerDutyCycle", "HALSIM_AnalogTriggerFiltered", "HALSIM_AnalogTriggerUnassigned"], "Members:\n\n HALSIM_AnalogTriggerUnassigned\n\n HALSIM_AnalogTriggerFiltered\n\n HALSIM_AnalogTriggerDutyCycle\n\n HALSIM_AnalogTriggerAveraged");
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 432 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAccelerometerActiveCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAccelerometerRangeCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAccelerometerXCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAccelerometerYCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAccelerometerZCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAddressableLEDDataCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAddressableLEDInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAddressableLEDLengthCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAddressableLEDOutputPortCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAddressableLEDRunningCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAllSimPeriodicCallbacks"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogGyroAngleCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogGyroInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogGyroRateCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogInAccumulatorCenterCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogInAccumulatorCountCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogInAccumulatorDeadbandCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogInAccumulatorInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogInAccumulatorValueCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogInAverageBitsCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogInInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogInOversampleBitsCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogInVoltageCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogOutInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogOutVoltageCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogTriggerInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogTriggerTriggerLowerBoundCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogTriggerTriggerModeCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelAnalogTriggerTriggerUpperBoundCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelCTREPCMClosedLoopEnabledCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelCTREPCMCompressorCurrentCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelCTREPCMCompressorOnCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelCTREPCMInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelCTREPCMPressureSwitchCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "channel", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelCTREPCMSolenoidOutputCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDIOFilterIndexCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDIOInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDIOIsInputCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDIOPulseLengthCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDIOValueCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDigitalPWMDutyCycleCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDigitalPWMInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDigitalPWMPinCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDriverStationAllianceStationIdCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDriverStationAutonomousCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDriverStationDsAttachedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDriverStationEStopCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDriverStationEnabledCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDriverStationFmsAttachedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDriverStationMatchTimeCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDriverStationNewDataCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDriverStationTestCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDutyCycleFrequencyCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDutyCycleInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelDutyCycleOutputCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelEncoderCountCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelEncoderDirectionCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelEncoderDistancePerPulseCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelEncoderInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelEncoderMaxPeriodCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelEncoderPeriodCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelEncoderResetCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelEncoderReverseDirectionCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelEncoderSamplesToAverageCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelJoystickAxesCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelJoystickButtonsCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelJoystickDescriptorCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelJoystickOutputsCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelJoystickPOVsCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelMatchInfoCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelPWMInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelPWMPeriodScaleCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelPWMPositionCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelPWMSpeedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelPWMZeroLatchCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "channel", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelPowerDistributionCurrentCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelPowerDistributionInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelPowerDistributionTemperatureCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelPowerDistributionVoltageCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelREVPHCompressorConfigTypeCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelREVPHCompressorCurrentCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelREVPHCompressorOnCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelREVPHInitializedCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelREVPHPressureSwitchCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "channel", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelREVPHSolenoidOutputCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRelayForwardCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRelayInitializedForwardCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRelayInitializedReverseCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRelayReverseCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioBrownoutVoltageCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioCPUTempCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioCommentsCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioFPGAButtonCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioRadioLEDStateCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioSerialNumberCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioTeamNumberCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserActive3V3Callback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserActive5VCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserActive6VCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserCurrent3V3Callback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserCurrent5VCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserCurrent6VCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserFaults3V3Callback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserFaults5VCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserFaults6VCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserVoltage3V3Callback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserVoltage5VCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioUserVoltage6VCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioVInCurrentCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelRoboRioVInVoltageCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelSPIAccelerometerActiveCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelSPIAccelerometerRangeCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelSPIAccelerometerXCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelSPIAccelerometerYCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "uid", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "cancelSPIAccelerometerZCallback"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "findAddressableLEDForChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "findAnalogTriggerForChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "findDigitalPWMForChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "findDutyCycleForChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "findEncoderForChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAccelerometerActive"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myAccelerometerRange"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.AccelerometerRange", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAccelerometerRange"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAccelerometerX"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAccelerometerY"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAccelerometerZ"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}, {"name": "data", "type": "hal.AddressableLEDData"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAddressableLEDData"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAddressableLEDData"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAddressableLEDInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAddressableLEDLength"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAddressableLEDOutputPort"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAddressableLEDRunning"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogGyroAngle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogGyroInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogGyroRate"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogInAccumulatorCenter"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogInAccumulatorCount"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogInAccumulatorDeadband"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogInAccumulatorInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogInAccumulatorValue"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogInAverageBits"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogInInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogInOversampleBits"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogInSimDevice"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogInVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogOutInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogOutVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogTriggerInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogTriggerTriggerLowerBound"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myAnalogTriggerMode"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.simulation.AnalogTriggerMode", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogTriggerTriggerMode"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getAnalogTriggerTriggerUpperBound"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getCTREPCMAllSolenoids"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getCTREPCMClosedLoopEnabled"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getCTREPCMCompressorCurrent"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getCTREPCMCompressorOn"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getCTREPCMInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getCTREPCMPressureSwitch"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}, {"name": "channel", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getCTREPCMSolenoidOutput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDIOFilterIndex"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDIOInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDIOIsInput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDIOPulseLength"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDIOSimDevice"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDIOValue"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDigitalPWMDutyCycle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDigitalPWMInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDigitalPWMPin"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myAllianceStationID"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.AllianceStationID", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDriverStationAllianceStationId"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDriverStationAutonomous"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDriverStationDsAttached"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDriverStationEStop"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDriverStationEnabled"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDriverStationFmsAttached"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDriverStationMatchTime"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDriverStationTest"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDutyCycleDigitalChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDutyCycleFrequency"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDutyCycleInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDutyCycleOutput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getDutyCycleSimDevice"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderCount"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderDigitalChannelA"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderDigitalChannelB"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderDirection"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderDistance"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderDistancePerPulse"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderMaxPeriod"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderPeriod"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderRate"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderReset"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderReverseDirection"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderSamplesToAverage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getEncoderSimDevice"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "joystickNum", "type": "int"}, {"name": "axes", "type": "hal.JoystickAxes"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getJoystickAxes"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickAxes"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "joystickNum", "type": "int"}, {"name": "buttons", "type": "hal.JoystickButtons"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getJoystickButtons"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickButtons"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int, int]", "args": [{"name": "stick", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getJoystickCounts"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "joystickNum", "type": "int"}, {"name": "descriptor", "type": "hal.JoystickDescriptor"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getJoystickDescriptor"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickDescriptor"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int, int]", "args": [{"name": "joystickNum", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getJoystickOutputs"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "joystickNum", "type": "int"}, {"name": "povs", "type": "hal.JoystickPOVs"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getJoystickPOVs"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickPOVs"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "info", "type": "hal.MatchInfo"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getMatchInfo"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMatchInfo"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getNextNotifierTimeout"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "arr", "type": "hal.simulation.NotifierInfo"}, {"name": "size", "type": "int"}], "tooltip": "Gets detailed information about each notifier.\n\n:param arr: array of information to be filled\n:param size: size of arr\n\n:returns: Number of notifiers; note: may be larger than passed-in size", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getNotifierInfo"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myNotifierInfo"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getNumNotifiers"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPWMInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPWMPeriodScale"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPWMPosition"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPWMPulseMicrosecond"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPWMSpeed"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPWMZeroLatch"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}, {"name": "length", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPowerDistributionAllCurrents"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}, {"name": "channel", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPowerDistributionCurrent"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPowerDistributionInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPowerDistributionTemperature"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getPowerDistributionVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getProgramStarted"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getREVPHAllSolenoids"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myREVPHCompressorConfigType"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.REVPHCompressorConfigType", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getREVPHCompressorConfigType"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getREVPHCompressorCurrent"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getREVPHCompressorOn"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getREVPHInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getREVPHPressureSwitch"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}, {"name": "channel", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getREVPHSolenoidOutput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRelayForward"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRelayInitializedForward"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRelayInitializedReverse"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRelayReverse"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioBrownoutVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioCPUTemp"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "str", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioComments"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioFPGAButton"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myHAL_RadioLEDState"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.HAL_RadioLEDState", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioRadioLEDState"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "str", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioSerialNumber"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioTeamNumber"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserActive3V3"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserActive5V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserActive6V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserCurrent3V3"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserCurrent5V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserCurrent6V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserFaults3V3"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserFaults5V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserFaults6V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserVoltage3V3"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserVoltage5V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioUserVoltage6V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioVInCurrent"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getRoboRioVInVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getSPIAccelerometerActive"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getSPIAccelerometerRange"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getSPIAccelerometerX"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getSPIAccelerometerY"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getSPIAccelerometerZ"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "name", "type": "str"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getSimDeviceHandle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "str", "args": [{"name": "handle", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getSimDeviceName"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getSimValueDeviceHandle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "device", "type": "int"}, {"name": "name", "type": "str"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "getSimValueHandle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "name", "type": "str"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "isSimDeviceEnabled"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "isTimingPaused"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "notifyDriverStationNewData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "pauseTiming"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySimCB"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.simulation.SimCB", "args": [{"name": "callback", "type": "Callable[[], None]"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "registerSimPeriodicAfterCallback"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myCallable"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySimCB"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.simulation.SimCB", "args": [{"name": "callback", "type": "Callable[[], None]"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "registerSimPeriodicBeforeCallback"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myCallable"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySimValueCB"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.simulation.SimValueCB", "args": [{"name": "value", "type": "hal.SimValue"}, {"name": "callback", "type": "Callable[[str, int, hal._wpiHal.SimValueDirection, hal._wpiHal.Value], None]"}, {"name": "initialNotify", "type": "bool"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "registerSimValueChangedCallback"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySimValue"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myCallable"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySimValueCB"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.simulation.SimValueCB", "args": [{"name": "device", "type": "hal.SimDevice"}, {"name": "callback", "type": "Callable[[str, int, hal._wpiHal.SimValueDirection, hal._wpiHal.Value], None]"}, {"name": "initialNotify", "type": "bool"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "registerSimValueCreatedCallback"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySimDevice"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myCallable"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySimValueCB"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.simulation.SimValueCB", "args": [{"name": "value", "type": "hal.SimValue"}, {"name": "callback", "type": "Callable[[str, int, hal._wpiHal.SimValueDirection, hal._wpiHal.Value], None]"}, {"name": "initialNotify", "type": "bool"}], "tooltip": "Register a callback for HAL_SimValueReset(). The callback is called with the\nold value.\n\n:param value: simulated value handle\n:param param: parameter for callback\n:param callback: callback\n:param initialNotify: ignored (present for consistency)", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "registerSimValueResetCallback"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySimValue"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myCallable"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetAccelerometerData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetAddressableLEDData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetAllSimData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetAnalogGyroData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetAnalogInData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetAnalogOutData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetAnalogTriggerData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetCTREPCMData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetDIOData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetDigitalPWMData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetDriverStationData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetDutyCycleData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetEncoderData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetGlobalHandles"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetPWMData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetPowerDistributionData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetREVPHData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetRelayData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetRoboRioData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetSPIAccelerometerData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resetSimDeviceData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "restartTiming"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "resumeTiming"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "active", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAccelerometerActive"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "range", "type": "hal.AccelerometerRange"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAccelerometerRange"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAccelerometerRange"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "x", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAccelerometerX"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "y", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAccelerometerY"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "z", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAccelerometerZ"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "data", "type": "hal.AddressableLEDData"}, {"name": "length", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAddressableLEDData"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAddressableLEDData"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAddressableLEDInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "length", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAddressableLEDLength"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "outputPort", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAddressableLEDOutputPort"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "running", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAddressableLEDRunning"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "angle", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogGyroAngle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogGyroInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "rate", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogGyroRate"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "accumulatorCenter", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogInAccumulatorCenter"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "accumulatorCount", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogInAccumulatorCount"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "accumulatorDeadband", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogInAccumulatorDeadband"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "accumulatorInitialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogInAccumulatorInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "accumulatorValue", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogInAccumulatorValue"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "averageBits", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogInAverageBits"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogInInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "oversampleBits", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogInOversampleBits"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "voltage", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogInVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogOutInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "voltage", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogOutVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogTriggerInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "triggerLowerBound", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogTriggerTriggerLowerBound"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "triggerMode", "type": "hal.simulation.AnalogTriggerMode"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogTriggerTriggerMode"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAnalogTriggerMode"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "triggerUpperBound", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setAnalogTriggerTriggerUpperBound"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "values", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setCTREPCMAllSolenoids"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "closedLoopEnabled", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setCTREPCMClosedLoopEnabled"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "compressorCurrent", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setCTREPCMCompressorCurrent"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "compressorOn", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setCTREPCMCompressorOn"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "solenoidInitialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setCTREPCMInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "pressureSwitch", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setCTREPCMPressureSwitch"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "channel", "type": "int"}, {"name": "solenoidOutput", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setCTREPCMSolenoidOutput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "filterIndex", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDIOFilterIndex"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDIOInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "isInput", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDIOIsInput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "pulseLength", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDIOPulseLength"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "value", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDIOValue"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "dutyCycle", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDigitalPWMDutyCycle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDigitalPWMInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "pin", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDigitalPWMPin"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "allianceStationId", "type": "hal.AllianceStationID"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDriverStationAllianceStationId"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAllianceStationID"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "autonomous", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDriverStationAutonomous"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "dsAttached", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDriverStationDsAttached"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "eStop", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDriverStationEStop"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "enabled", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDriverStationEnabled"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "fmsAttached", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDriverStationFmsAttached"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "matchTime", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDriverStationMatchTime"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "test", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDriverStationTest"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "frequency", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDutyCycleFrequency"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDutyCycleInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "output", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setDutyCycleOutput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "count", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderCount"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "direction", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderDirection"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "distance", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderDistance"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "distancePerPulse", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderDistancePerPulse"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "maxPeriod", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderMaxPeriod"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "period", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderPeriod"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "rate", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderRate"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "reset", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderReset"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "reverseDirection", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderReverseDirection"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "samplesToAverage", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEncoderSamplesToAverage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "name", "type": "str"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setEventName"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "message", "type": "str"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setGameSpecificMessage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "joystickNum", "type": "int"}, {"name": "axes", "type": "hal.JoystickAxes"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickAxes"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickAxes"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "axis", "type": "int"}, {"name": "value", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickAxis"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "count", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickAxisCount"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "axis", "type": "int"}, {"name": "type", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickAxisType"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "button", "type": "int"}, {"name": "state", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickButton"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "count", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickButtonCount"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "joystickNum", "type": "int"}, {"name": "buttons", "type": "hal.JoystickButtons"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickButtons"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickButtons"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "buttons", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickButtonsValue"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "joystickNum", "type": "int"}, {"name": "descriptor", "type": "hal.JoystickDescriptor"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickDescriptor"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickDescriptor"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "isXbox", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickIsXbox"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "name", "type": "str"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickName"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "joystickNum", "type": "int"}, {"name": "outputs", "type": "int"}, {"name": "leftRumble", "type": "int"}, {"name": "rightRumble", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickOutputs"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "pov", "type": "int"}, {"name": "value", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickPOV"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "count", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickPOVCount"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "joystickNum", "type": "int"}, {"name": "povs", "type": "hal.JoystickPOVs"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickPOVs"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickPOVs"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "stick", "type": "int"}, {"name": "type", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setJoystickType"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "info", "type": "hal.MatchInfo"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setMatchInfo"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMatchInfo"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "matchNumber", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setMatchNumber"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "type", "type": "hal.MatchType"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setMatchType"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMatchType"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPWMInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "periodScale", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPWMPeriodScale"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "position", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPWMPosition"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "microsecondPulseTime", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPWMPulseMicrosecond"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "speed", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPWMSpeed"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "zeroLatch", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPWMZeroLatch"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "currents", "type": "float"}, {"name": "length", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPowerDistributionAllCurrents"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "channel", "type": "int"}, {"name": "current", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPowerDistributionCurrent"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPowerDistributionInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "temperature", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPowerDistributionTemperature"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "voltage", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setPowerDistributionVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setProgramStarted"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "values", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setREVPHAllSolenoids"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "configType", "type": "hal.REVPHCompressorConfigType"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setREVPHCompressorConfigType"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myREVPHCompressorConfigType"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "compressorCurrent", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setREVPHCompressorCurrent"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "compressorOn", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setREVPHCompressorOn"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "solenoidInitialized", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setREVPHInitialized"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "pressureSwitch", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setREVPHPressureSwitch"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "channel", "type": "int"}, {"name": "solenoidOutput", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setREVPHSolenoidOutput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "forward", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRelayForward"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initializedForward", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRelayInitializedForward"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "initializedReverse", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRelayInitializedReverse"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "reverse", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRelayReverse"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "replayNumber", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setReplayNumber"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "brownoutVoltage", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioBrownoutVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "cpuTemp", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioCPUTemp"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "comments", "type": "str"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioComments"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "fPGAButton", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioFPGAButton"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "state", "type": "hal.HAL_RadioLEDState"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioRadioLEDState"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myHAL_RadioLEDState"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "serialNumber", "type": "str"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioSerialNumber"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "teamNumber", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioTeamNumber"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userActive3V3", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserActive3V3"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userActive5V", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserActive5V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userActive6V", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserActive6V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userCurrent3V3", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserCurrent3V3"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userCurrent5V", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserCurrent5V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userCurrent6V", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserCurrent6V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userFaults3V3", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserFaults3V3"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userFaults5V", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserFaults5V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userFaults6V", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserFaults6V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userVoltage3V3", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserVoltage3V3"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userVoltage5V", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserVoltage5V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "userVoltage6V", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioUserVoltage6V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "vInCurrent", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioVInCurrent"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "vInVoltage", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRoboRioVInVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "type", "type": "hal.RuntimeType"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setRuntimeType"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myRuntimeType"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "active", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setSPIAccelerometerActive"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "range", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setSPIAccelerometerRange"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "x", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setSPIAccelerometerX"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "y", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setSPIAccelerometerY"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "index", "type": "int"}, {"name": "z", "type": "float"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setSPIAccelerometerZ"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "prefix", "type": "str"}, {"name": "enabled", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "setSimDeviceEnabled"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "delta", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "stepTiming"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "delta", "type": "int"}], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "stepTimingAsync"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "hal.simulation"}, "fields": {"MODULE_OR_CLASS": "hal.simulation", "FUNC": "waitForProgramStart"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.simulation.AnalogTriggerMode", "importModule": "hal.simulation"}, "fields": {"ENUM_TYPE": "hal.simulation.AnalogTriggerMode", "ENUM_VALUE": "HALSIM_AnalogTriggerAveraged"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.simulation.AnalogTriggerMode", "importModule": "hal.simulation"}, "fields": {"ENUM_TYPE": "hal.simulation.AnalogTriggerMode", "ENUM_VALUE": "HALSIM_AnalogTriggerDutyCycle"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.simulation.AnalogTriggerMode", "importModule": "hal.simulation"}, "fields": {"ENUM_TYPE": "hal.simulation.AnalogTriggerMode", "ENUM_VALUE": "HALSIM_AnalogTriggerFiltered"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.simulation.AnalogTriggerMode", "importModule": "hal.simulation"}, "fields": {"ENUM_TYPE": "hal.simulation.AnalogTriggerMode", "ENUM_VALUE": "HALSIM_AnalogTriggerUnassigned"}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "simulation",
- contents: contents,
- moduleName: "hal.simulation",
- packageName: "hal.simulation",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_hal.ts b/src/blocks/generated/module_hal.ts
deleted file mode 100644
index 5594975c..00000000
--- a/src/blocks/generated/module_hal.ts
+++ /dev/null
@@ -1,818 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as pythonEnum from "../mrc_get_python_enum_value";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module hal
-
-export function initialize() {
- pythonEnum.initializeEnum("hal.AccelerometerRange", ["k2G", "k4G", "k8G"], "The acceptable accelerometer ranges.\n\nMembers:\n\n k2G\n\n k4G\n\n k8G");
- pythonEnum.initializeEnum("hal.AllianceStationID", ["kBlue1", "kBlue2", "kBlue3", "kRed1", "kRed2", "kRed3", "kUnknown"], "Members:\n\n kUnknown : Unknown Alliance Station\n\n kRed1 : Red Alliance Station 1\n\n kRed2 : Red Alliance Station 2\n\n kRed3 : Red Alliance Station 3\n\n kBlue1 : Blue Alliance Station 1\n\n kBlue2 : Blue Alliance Station 2\n\n kBlue3 : Blue Alliance Station 3");
- pythonEnum.initializeEnum("hal.AnalogTriggerType", ["kFallingPulse", "kInWindow", "kRisingPulse", "kState"], "The type of analog trigger to trigger on.\n\nMembers:\n\n kInWindow\n\n kState\n\n kRisingPulse\n\n kFallingPulse");
- pythonEnum.initializeEnum("hal.CANDeviceType", ["kAccelerometer", "kBroadcast", "kFirmwareUpdate", "kGearToothSensor", "kGyroSensor", "kIOBreakout", "kMiscellaneous", "kMotorController", "kPneumatics", "kPowerDistribution", "kRelayController", "kRobotController", "kServoController", "kUltrasonicSensor"], "The CAN device type.\n\nTeams should use HAL_CAN_Dev_kMiscellaneous\n\nMembers:\n\n kBroadcast : Broadcast.\n\n kRobotController : Robot controller.\n\n kMotorController : Motor controller.\n\n kRelayController : Relay controller.\n\n kGyroSensor : Gyro sensor.\n\n kAccelerometer : Accelerometer.\n\n kUltrasonicSensor : Ultrasonic sensor.\n\n kGearToothSensor : Gear tooth sensor.\n\n kPowerDistribution : Power distribution.\n\n kPneumatics : Pneumatics.\n\n kMiscellaneous : Miscellaneous.\n\n kIOBreakout : IO breakout.\n\n kServoController\n\n kFirmwareUpdate : Firmware update.");
- pythonEnum.initializeEnum("hal.CANManufacturer", ["kAndyMark", "kBroadcast", "kCTRE", "kCopperforge", "kDEKA", "kGrapple", "kKauaiLabs", "kLM", "kMS", "kNI", "kPWF", "kREV", "kReduxRobotics", "kStudica", "kTeamUse", "kTheThriftyBot", "kVividHosting"], "The CAN manufacturer ID.\n\nTeams should use HAL_CAN_Man_kTeamUse.\n\nMembers:\n\n kBroadcast : Broadcast.\n\n kNI : National Instruments.\n\n kLM : Luminary Micro.\n\n kDEKA : DEKA Research and Development Corp.\n\n kCTRE : Cross the Road Electronics.\n\n kREV : REV robotics.\n\n kGrapple : Grapple.\n\n kMS : MindSensors.\n\n kTeamUse : Team use.\n\n kKauaiLabs : Kauai Labs.\n\n kCopperforge : Copperforge.\n\n kPWF : Playing With Fusion.\n\n kStudica : Studica.\n\n kTheThriftyBot : TheThriftyBot.\n\n kReduxRobotics : Redux Robotics.\n\n kAndyMark : AndyMark.\n\n kVividHosting : Vivid-Hosting.");
- pythonEnum.initializeEnum("hal.CounterMode", ["kExternalDirection", "kPulseLength", "kSemiperiod", "kTwoPulse"], "The counter mode.\n\nMembers:\n\n kTwoPulse : Two pulse mode.\n\n kSemiperiod : Semi-period mode.\n\n kPulseLength : Pulse length mode.\n\n kExternalDirection : External direction mode.");
- pythonEnum.initializeEnum("hal.EncoderEncodingType", ["Encoder_k1X", "Encoder_k2X", "Encoder_k4X"], "The encoding scaling of the encoder.\n\nMembers:\n\n Encoder_k1X\n\n Encoder_k2X\n\n Encoder_k4X");
- pythonEnum.initializeEnum("hal.EncoderIndexingType", ["kResetOnFallingEdge", "kResetOnRisingEdge", "kResetWhileHigh", "kResetWhileLow"], "The type of index pulse for the encoder.\n\nMembers:\n\n kResetWhileHigh\n\n kResetWhileLow\n\n kResetOnFallingEdge\n\n kResetOnRisingEdge");
- pythonEnum.initializeEnum("hal.HAL_RadioLEDState", ["HAL_RadioLED_kGreen", "HAL_RadioLED_kOff", "HAL_RadioLED_kOrange", "HAL_RadioLED_kRed"], "Members:\n\n HAL_RadioLED_kOff\n\n HAL_RadioLED_kGreen\n\n HAL_RadioLED_kRed\n\n HAL_RadioLED_kOrange");
- pythonEnum.initializeEnum("hal.HandleEnum", ["AddressableLED", "AnalogGyro", "AnalogInput", "AnalogOutput", "AnalogTrigger", "CAN", "CTREPCM", "CTREPDP", "Compressor", "Counter", "DIO", "DMA", "DigitalPWM", "DutyCycle", "Encoder", "FPGAEncoder", "Interrupt", "Notifier", "PWM", "Port", "REVPDH", "REVPH", "Relay", "SerialPort", "SimulationJni", "Solenoid", "Undefined", "Vendor"], "Enum of HAL handle types. Vendors/Teams should use Vendor (17).\n\nMembers:\n\n Undefined\n\n DIO\n\n Port\n\n Notifier\n\n Interrupt\n\n AnalogOutput\n\n AnalogInput\n\n AnalogTrigger\n\n Relay\n\n PWM\n\n DigitalPWM\n\n Counter\n\n FPGAEncoder\n\n Encoder\n\n Compressor\n\n Solenoid\n\n AnalogGyro\n\n Vendor\n\n SimulationJni\n\n CAN\n\n SerialPort\n\n DutyCycle\n\n DMA\n\n AddressableLED\n\n CTREPCM\n\n CTREPDP\n\n REVPDH\n\n REVPH");
- pythonEnum.initializeEnum("hal.I2CPort", ["kInvalid", "kMXP", "kOnboard"], "Members:\n\n kInvalid\n\n kOnboard\n\n kMXP");
- pythonEnum.initializeEnum("hal.MatchType", ["elimination", "none", "practice", "qualification"], "Members:\n\n none\n\n practice\n\n qualification\n\n elimination");
- pythonEnum.initializeEnum("hal.PowerDistributionType", ["kAutomatic", "kCTRE", "kRev"], "The types of power distribution devices.\n\nMembers:\n\n kAutomatic : Automatically determines the module type\n\n kCTRE : CTRE (Cross The Road Electronics) Power Distribution Panel (PDP).\n\n kRev : REV Power Distribution Hub (PDH).");
- pythonEnum.initializeEnum("hal.REVPHCompressorConfigType", ["kAnalog", "kDigital", "kDisabled", "kHybrid"], "The compressor configuration type\n\nMembers:\n\n kDisabled : Disabled.\n\n kDigital : Digital.\n\n kAnalog : Analog.\n\n kHybrid : Hybrid.");
- pythonEnum.initializeEnum("hal.RuntimeType", ["HAL_Runtime_RoboRIO", "HAL_Runtime_RoboRIO2", "HAL_Runtime_Simulation"], "Runtime type.\n\nMembers:\n\n HAL_Runtime_RoboRIO : roboRIO 1.0\n\n HAL_Runtime_RoboRIO2 : roboRIO 2.0\n\n HAL_Runtime_Simulation : Simulation runtime");
- pythonEnum.initializeEnum("hal.SPIMode", ["kMode0", "kMode1", "kMode2", "kMode3"], "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.");
- pythonEnum.initializeEnum("hal.SPIPort", ["kInvalid", "kMXP", "kOnboardCS0", "kOnboardCS1", "kOnboardCS2", "kOnboardCS3"], "SPI port.\n\nMembers:\n\n kInvalid : Invalid port number.\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.");
- pythonEnum.initializeEnum("hal.SerialPort", ["MXP", "Onboard", "USB1", "USB2"], "Members:\n\n Onboard\n\n MXP\n\n USB1\n\n USB2");
- pythonEnum.initializeEnum("hal.SimValueDirection", ["HAL_SimValueBidir", "HAL_SimValueInput", "HAL_SimValueOutput"], "Direction of a simulated value (from the perspective of user code).\n\nMembers:\n\n HAL_SimValueInput : input to user code from the simulator\n\n HAL_SimValueOutput : output from user code to the simulator\n\n HAL_SimValueBidir : bidirectional between user code and simulator");
- pythonEnum.initializeEnum("hal.Type", ["BOOLEAN", "DOUBLE", "ENUM", "INT", "LONG", "UNASSIGNED"], "Members:\n\n UNASSIGNED\n\n BOOLEAN\n\n DOUBLE\n\n ENUM\n\n INT\n\n LONG");
- pythonEnum.initializeEnum("hal.tInstances", ["kADXL345_I2C", "kADXL345_SPI", "kCANPlugin_2CAN", "kCANPlugin_BlackJagBridge", "kCommand2_Scheduler", "kCommand_Scheduler", "kDashboard_AdvantageScope", "kDashboard_Elastic", "kDashboard_FRCWebComponents", "kDashboard_Glass", "kDashboard_LabVIEW", "kDashboard_QFRCDashboard", "kDashboard_Shuffleboard", "kDashboard_SmartDashboard", "kDashboard_Unknown", "kDataLogLocation_Onboard", "kDataLogLocation_USB", "kDriverStationCIO_Analog", "kDriverStationCIO_DigitalIn", "kDriverStationCIO_DigitalOut", "kDriverStationEIO_Acceleration", "kDriverStationEIO_AnalogIn", "kDriverStationEIO_AnalogOut", "kDriverStationEIO_Button", "kDriverStationEIO_DigitalIn", "kDriverStationEIO_DigitalOut", "kDriverStationEIO_Encoder", "kDriverStationEIO_FixedDigitalOut", "kDriverStationEIO_LED", "kDriverStationEIO_PWM", "kDriverStationEIO_TouchSlider", "kFramework_AdvantageKit", "kFramework_CommandControl", "kFramework_Iterative", "kFramework_MagicBot", "kFramework_ROS", "kFramework_RobotBuilder", "kFramework_Simple", "kFramework_Timed", "kKinematics_DifferentialDrive", "kKinematics_MecanumDrive", "kKinematics_SwerveDrive", "kLanguage_CPlusPlus", "kLanguage_DotNet", "kLanguage_Java", "kLanguage_Kotlin", "kLanguage_LabVIEW", "kLanguage_Python", "kLanguage_Rust", "kLoggingFramework_AdvantageKit", "kLoggingFramework_DogLog", "kLoggingFramework_Epilogue", "kLoggingFramework_Monologue", "kLoggingFramework_Other", "kOdometry_DifferentialDrive", "kOdometry_MecanumDrive", "kOdometry_SwerveDrive", "kPDP_CTRE", "kPDP_REV", "kPDP_Unknown", "kRobotDrive2_DifferentialArcade", "kRobotDrive2_DifferentialCurvature", "kRobotDrive2_DifferentialTank", "kRobotDrive2_KilloughCartesian", "kRobotDrive2_KilloughPolar", "kRobotDrive2_MecanumCartesian", "kRobotDrive2_MecanumPolar", "kRobotDriveSwerve_AdvantageKit", "kRobotDriveSwerve_CTRE", "kRobotDriveSwerve_MaxSwerve", "kRobotDriveSwerve_Other", "kRobotDriveSwerve_YAGSL", "kRobotDrive_ArcadeButtonSpin", "kRobotDrive_ArcadeRatioCurve", "kRobotDrive_ArcadeStandard", "kRobotDrive_MecanumCartesian", "kRobotDrive_MecanumPolar", "kRobotDrive_Tank", "kSmartDashboard_Instance", "kSmartDashboard_LiveWindow"], "Members:\n\n kLanguage_LabVIEW\n\n kLanguage_CPlusPlus\n\n kLanguage_Java\n\n kLanguage_Python\n\n kLanguage_DotNet\n\n kLanguage_Kotlin\n\n kLanguage_Rust\n\n kCANPlugin_BlackJagBridge\n\n kCANPlugin_2CAN\n\n kFramework_Iterative\n\n kFramework_Simple\n\n kFramework_CommandControl\n\n kFramework_Timed\n\n kFramework_ROS\n\n kFramework_RobotBuilder\n\n kFramework_AdvantageKit\n\n kFramework_MagicBot\n\n kRobotDrive_ArcadeStandard\n\n kRobotDrive_ArcadeButtonSpin\n\n kRobotDrive_ArcadeRatioCurve\n\n kRobotDrive_Tank\n\n kRobotDrive_MecanumPolar\n\n kRobotDrive_MecanumCartesian\n\n kRobotDrive2_DifferentialArcade\n\n kRobotDrive2_DifferentialTank\n\n kRobotDrive2_DifferentialCurvature\n\n kRobotDrive2_MecanumCartesian\n\n kRobotDrive2_MecanumPolar\n\n kRobotDrive2_KilloughCartesian\n\n kRobotDrive2_KilloughPolar\n\n kRobotDriveSwerve_Other\n\n kRobotDriveSwerve_YAGSL\n\n kRobotDriveSwerve_CTRE\n\n kRobotDriveSwerve_MaxSwerve\n\n kRobotDriveSwerve_AdvantageKit\n\n kDriverStationCIO_Analog\n\n kDriverStationCIO_DigitalIn\n\n kDriverStationCIO_DigitalOut\n\n kDriverStationEIO_Acceleration\n\n kDriverStationEIO_AnalogIn\n\n kDriverStationEIO_AnalogOut\n\n kDriverStationEIO_Button\n\n kDriverStationEIO_LED\n\n kDriverStationEIO_DigitalIn\n\n kDriverStationEIO_DigitalOut\n\n kDriverStationEIO_FixedDigitalOut\n\n kDriverStationEIO_PWM\n\n kDriverStationEIO_Encoder\n\n kDriverStationEIO_TouchSlider\n\n kADXL345_SPI\n\n kADXL345_I2C\n\n kCommand_Scheduler\n\n kCommand2_Scheduler\n\n kSmartDashboard_Instance\n\n kSmartDashboard_LiveWindow\n\n kKinematics_DifferentialDrive\n\n kKinematics_MecanumDrive\n\n kKinematics_SwerveDrive\n\n kOdometry_DifferentialDrive\n\n kOdometry_MecanumDrive\n\n kOdometry_SwerveDrive\n\n kDashboard_Unknown\n\n kDashboard_Glass\n\n kDashboard_SmartDashboard\n\n kDashboard_Shuffleboard\n\n kDashboard_Elastic\n\n kDashboard_LabVIEW\n\n kDashboard_AdvantageScope\n\n kDashboard_QFRCDashboard\n\n kDashboard_FRCWebComponents\n\n kDataLogLocation_Onboard\n\n kDataLogLocation_USB\n\n kLoggingFramework_Other\n\n kLoggingFramework_Epilogue\n\n kLoggingFramework_Monologue\n\n kLoggingFramework_AdvantageKit\n\n kLoggingFramework_DogLog\n\n kPDP_CTRE\n\n kPDP_REV\n\n kPDP_Unknown");
- pythonEnum.initializeEnum("hal.tResourceType", ["kResourceType_ADIS16448", "kResourceType_ADIS16470", "kResourceType_ADXL345", "kResourceType_ADXL362", "kResourceType_ADXRS450", "kResourceType_Accelerometer", "kResourceType_AddressableLEDs", "kResourceType_AnalogChannel", "kResourceType_AnalogOutput", "kResourceType_AnalogTrigger", "kResourceType_AnalogTriggerOutput", "kResourceType_AxisCamera", "kResourceType_BangBangController", "kResourceType_Button", "kResourceType_CAN", "kResourceType_CANJaguar", "kResourceType_CANPlugin", "kResourceType_CANTalonSRX", "kResourceType_CANifier", "kResourceType_CTRE_future1", "kResourceType_CTRE_future10", "kResourceType_CTRE_future11", "kResourceType_CTRE_future12", "kResourceType_CTRE_future13", "kResourceType_CTRE_future14", "kResourceType_CTRE_future2", "kResourceType_CTRE_future3", "kResourceType_CTRE_future4", "kResourceType_CTRE_future5", "kResourceType_CTRE_future6", "kResourceType_CTRE_future7", "kResourceType_CTRE_future8", "kResourceType_CTRE_future9", "kResourceType_ChoreoTrajectory", "kResourceType_ChoreoTrigger", "kResourceType_Command", "kResourceType_Compressor", "kResourceType_Controller", "kResourceType_Counter", "kResourceType_Dashboard", "kResourceType_DataLogManager", "kResourceType_DigilentDMC60", "kResourceType_DigitalGlitchFilter", "kResourceType_DigitalInput", "kResourceType_DigitalOutput", "kResourceType_DriverStationCIO", "kResourceType_DriverStationEIO", "kResourceType_DriverStationLCD", "kResourceType_DutyCycle", "kResourceType_Encoder", "kResourceType_ExponentialProfile", "kResourceType_Framework", "kResourceType_FusionVenom", "kResourceType_GearTooth", "kResourceType_Gyro", "kResourceType_HiTechnicAccel", "kResourceType_HiTechnicColorSensor", "kResourceType_HiTechnicCompass", "kResourceType_I2C", "kResourceType_Jaguar", "kResourceType_Joystick", "kResourceType_Kinect", "kResourceType_KinectStick", "kResourceType_Kinematics", "kResourceType_Koors40", "kResourceType_Language", "kResourceType_LaserShark", "kResourceType_LinearFilter", "kResourceType_LoggingFramework", "kResourceType_MindsensorsSD540", "kResourceType_Module", "kResourceType_NavX", "kResourceType_NidecBrushless", "kResourceType_Odometry", "kResourceType_PCM", "kResourceType_PCVideoServer", "kResourceType_PDP", "kResourceType_PIDController", "kResourceType_PIDController2", "kResourceType_PS4Controller", "kResourceType_PWFSEN36005", "kResourceType_PWM", "kResourceType_PWMTalonSRX", "kResourceType_PWMVictorSPX", "kResourceType_PathFindingCommand", "kResourceType_PathPlannerAuto", "kResourceType_PathPlannerPath", "kResourceType_PathWeaverTrajectory", "kResourceType_PhotonCamera", "kResourceType_PhotonPoseEstimator", "kResourceType_PigeonIMU", "kResourceType_Pixy", "kResourceType_Pixy2", "kResourceType_Preferences", "kResourceType_ProfiledPIDController", "kResourceType_Redux_future1", "kResourceType_Redux_future2", "kResourceType_Redux_future3", "kResourceType_Redux_future4", "kResourceType_Redux_future5", "kResourceType_Relay", "kResourceType_RevSPARK", "kResourceType_RevServoHub", "kResourceType_RevSparkFlexCAN", "kResourceType_RevSparkFlexPWM", "kResourceType_RevSparkMaxCAN", "kResourceType_RevSparkMaxPWM", "kResourceType_RobotDrive", "kResourceType_SPI", "kResourceType_SRF08", "kResourceType_ScanseSweep", "kResourceType_SerialPort", "kResourceType_Servo", "kResourceType_Shuffleboard", "kResourceType_SmartDashboard", "kResourceType_Solenoid", "kResourceType_Talon", "kResourceType_TalonFX", "kResourceType_Task", "kResourceType_ThriftyNova", "kResourceType_TrapezoidProfile", "kResourceType_Ultrasonic", "kResourceType_Units", "kResourceType_UsbCamera", "kResourceType_Victor", "kResourceType_VictorSP", "kResourceType_XboxController"], "Members:\n\n kResourceType_Controller\n\n kResourceType_Module\n\n kResourceType_Language\n\n kResourceType_CANPlugin\n\n kResourceType_Accelerometer\n\n kResourceType_ADXL345\n\n kResourceType_AnalogChannel\n\n kResourceType_AnalogTrigger\n\n kResourceType_AnalogTriggerOutput\n\n kResourceType_CANJaguar\n\n kResourceType_Compressor\n\n kResourceType_Counter\n\n kResourceType_Dashboard\n\n kResourceType_DigitalInput\n\n kResourceType_DigitalOutput\n\n kResourceType_DriverStationCIO\n\n kResourceType_DriverStationEIO\n\n kResourceType_DriverStationLCD\n\n kResourceType_Encoder\n\n kResourceType_GearTooth\n\n kResourceType_Gyro\n\n kResourceType_I2C\n\n kResourceType_Framework\n\n kResourceType_Jaguar\n\n kResourceType_Joystick\n\n kResourceType_Kinect\n\n kResourceType_KinectStick\n\n kResourceType_PIDController\n\n kResourceType_Preferences\n\n kResourceType_PWM\n\n kResourceType_Relay\n\n kResourceType_RobotDrive\n\n kResourceType_SerialPort\n\n kResourceType_Servo\n\n kResourceType_Solenoid\n\n kResourceType_SPI\n\n kResourceType_Task\n\n kResourceType_Ultrasonic\n\n kResourceType_Victor\n\n kResourceType_Button\n\n kResourceType_Command\n\n kResourceType_AxisCamera\n\n kResourceType_PCVideoServer\n\n kResourceType_SmartDashboard\n\n kResourceType_Talon\n\n kResourceType_HiTechnicColorSensor\n\n kResourceType_HiTechnicAccel\n\n kResourceType_HiTechnicCompass\n\n kResourceType_SRF08\n\n kResourceType_AnalogOutput\n\n kResourceType_VictorSP\n\n kResourceType_PWMTalonSRX\n\n kResourceType_CANTalonSRX\n\n kResourceType_ADXL362\n\n kResourceType_ADXRS450\n\n kResourceType_RevSPARK\n\n kResourceType_MindsensorsSD540\n\n kResourceType_DigitalGlitchFilter\n\n kResourceType_ADIS16448\n\n kResourceType_PDP\n\n kResourceType_PCM\n\n kResourceType_PigeonIMU\n\n kResourceType_NidecBrushless\n\n kResourceType_CANifier\n\n kResourceType_TalonFX\n\n kResourceType_CTRE_future1\n\n kResourceType_CTRE_future2\n\n kResourceType_CTRE_future3\n\n kResourceType_CTRE_future4\n\n kResourceType_CTRE_future5\n\n kResourceType_CTRE_future6\n\n kResourceType_LinearFilter\n\n kResourceType_XboxController\n\n kResourceType_UsbCamera\n\n kResourceType_NavX\n\n kResourceType_Pixy\n\n kResourceType_Pixy2\n\n kResourceType_ScanseSweep\n\n kResourceType_Shuffleboard\n\n kResourceType_CAN\n\n kResourceType_DigilentDMC60\n\n kResourceType_PWMVictorSPX\n\n kResourceType_RevSparkMaxPWM\n\n kResourceType_RevSparkMaxCAN\n\n kResourceType_ADIS16470\n\n kResourceType_PIDController2\n\n kResourceType_ProfiledPIDController\n\n kResourceType_Kinematics\n\n kResourceType_Odometry\n\n kResourceType_Units\n\n kResourceType_TrapezoidProfile\n\n kResourceType_DutyCycle\n\n kResourceType_AddressableLEDs\n\n kResourceType_FusionVenom\n\n kResourceType_CTRE_future7\n\n kResourceType_CTRE_future8\n\n kResourceType_CTRE_future9\n\n kResourceType_CTRE_future10\n\n kResourceType_CTRE_future11\n\n kResourceType_CTRE_future12\n\n kResourceType_CTRE_future13\n\n kResourceType_CTRE_future14\n\n kResourceType_ExponentialProfile\n\n kResourceType_PS4Controller\n\n kResourceType_PhotonCamera\n\n kResourceType_PhotonPoseEstimator\n\n kResourceType_PathPlannerPath\n\n kResourceType_PathPlannerAuto\n\n kResourceType_PathFindingCommand\n\n kResourceType_Redux_future1\n\n kResourceType_Redux_future2\n\n kResourceType_Redux_future3\n\n kResourceType_Redux_future4\n\n kResourceType_Redux_future5\n\n kResourceType_RevSparkFlexCAN\n\n kResourceType_RevSparkFlexPWM\n\n kResourceType_BangBangController\n\n kResourceType_DataLogManager\n\n kResourceType_LoggingFramework\n\n kResourceType_ChoreoTrajectory\n\n kResourceType_ChoreoTrigger\n\n kResourceType_PathWeaverTrajectory\n\n kResourceType_Koors40\n\n kResourceType_ThriftyNova\n\n kResourceType_RevServoHub\n\n kResourceType_PWFSEN36005\n\n kResourceType_LaserShark");
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 768 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "sessionHandle", "type": "int"}], "tooltip": "Closes a CAN stream.\n\n:param sessionHandle: the session to close", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "CAN_CloseStreamSession"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int, int, int, int, int]", "args": [], "tooltip": "Gets CAN status information.\n\n:param out: percentBusUtilization the bus utilization\n:param out: busOffCount the number of bus off errors\n:param out: txFullCount the number of tx full errors\n:param out: receiveErrorCount the number of receive errors\n:param out: transmitErrorCount the number of transmit errors\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "CAN_GetCANStatus"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "messageID", "type": "int"}, {"name": "messageIDMask", "type": "int"}, {"name": "maxMessages", "type": "int"}], "tooltip": "Opens a CAN stream.\n\n:param out: sessionHandle output for the session handle\n:param in: messageID the message ID to read\n:param in: messageIDMask the message ID mask\n:param in: maxMessages the maximum number of messages to stream\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "CAN_OpenStreamSession"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int, int, int]", "args": [{"name": "messageIDMask", "type": "int"}, {"name": "data", "type": "Buffer"}], "tooltip": "Receives a CAN message.\n\n:param out: messageID store for the received message ID\n:param in: messageIDMask the message ID mask to look for\n:param out: data data output (8 bytes)\n:param out: dataSize data length (0-8 bytes)\n:param out: timeStamp the packet received timestamp (based off of\n CLOCK_MONOTONIC)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "CAN_ReceiveMessage"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "messageID", "type": "int"}, {"name": "data", "type": "Buffer"}, {"name": "periodMs", "type": "int"}], "tooltip": "Sends a CAN message.\n\n:param in: messageID the CAN ID to send\n:param in: data the data to send (0-8 bytes)\n:param in: dataSize the size of the data to send (0-8 bytes)\n:param in: periodMs the period to repeat the packet at. Use\n HAL_CAN_SEND_PERIOD_NO_REPEAT to not repeat.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "CAN_SendMessage"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[hal._wpiHal.HAL_RadioLEDState, int]", "args": [], "tooltip": "Get the state of the \"Radio\" LED.\n\n:param out: status the error code, or 0 for success\n\n:returns: The state of the LED.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "HAL_GetRadioLEDState"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "state", "type": "hal.HAL_RadioLEDState"}], "tooltip": "Set the state of the \"Radio\" LED.\n\n:param state: The state to set the LED to.\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "HAL_SetRadioLEDState"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myHAL_RadioLEDState"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Allocates a DO PWM Generator.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: the allocated digital PWM handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "allocateDigitalPWM"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Calibrates the analog gyro.\n\nThis happens by calculating the average value of the gyro over 5 seconds, and\nsetting that as the center. Note that this call blocks for 5 seconds to\nperform this.\n\n:param in: handle the gyro handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "calibrateAnalogGyro"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "notifierHandle", "type": "int"}], "tooltip": "Cancels the next notifier alarm.\n\nThis does not cause HAL_WaitForNotifierAlarm to return.\n\n:param in: notifierHandle the notifier handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "cancelNotifierAlarm"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "Checks that the analog output channel number is valid.\nVerifies that the analog channel number is one of the legal channel numbers.\nChannel numbers are 0-based.\n\n:param in: channel The analog output channel number.\n\n:returns: Analog channel is valid", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkAnalogInputChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "module", "type": "int"}], "tooltip": "Checks that the analog module number is valid.\n\n:param in: module The analog module number.\n\n:returns: Analog module is valid and present", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkAnalogModule"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "Checks that the analog output channel number is valid.\n\nVerifies that the analog channel number is one of the legal channel numbers.\nChannel numbers are 0-based.\n\n:returns: Analog channel is valid", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkAnalogOutputChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "Checks if a solenoid channel number is valid.\n\n:param in: channel the channel to check\n\n:returns: true if the channel is valid, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkCTREPCMSolenoidChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "Checks if a DIO channel is valid.\n\n:param channel: the channel number to check\n\n:returns: true if the channel is valid, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkDIOChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "Checks if a pwm channel is valid.\n\n:param channel: the channel to check\n\n:returns: true if the channel is valid, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkPWMChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "channel", "type": "int"}], "tooltip": "Checks if a PowerDistribution channel is valid.\n\n:param handle: the module handle\n:param channel: the channel to check\n\n:returns: true if the channel is valid, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkPowerDistributionChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "module", "type": "int"}, {"name": "type", "type": "hal.PowerDistributionType"}], "tooltip": "Checks if a PowerDistribution module is valid.\n\n:param module: the module to check\n:param type: the type of module\n\n:returns: true if the module is valid, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkPowerDistributionModule"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPowerDistributionType"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "module", "type": "int"}], "tooltip": "Checks if a PH module (CAN ID) is valid.\n\n:param in: module the module to check\n\n:returns: true if the module is valid, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkREVPHModuleNumber"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "Checks if a solenoid channel number is valid.\n\n:param in: channel the channel to check\n\n:returns: true if the channel is valid, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkREVPHSolenoidChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "Checks if a relay channel is valid.\n\n:param channel: the channel to check\n\n:returns: true if the channel is valid, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "checkRelayChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "analogTriggerHandle", "type": "int"}], "tooltip": "Frees an analog trigger.\n\n:param in: analogTriggerHandle the trigger handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "cleanAnalogTrigger"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}], "tooltip": "Frees a CAN device\n\n:param handle: the CAN handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "cleanCAN"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "interruptHandle", "type": "int"}], "tooltip": "Frees an interrupt.\n\n:param interruptHandle: the interrupt handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "cleanInterrupts"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "notifierHandle", "type": "int"}], "tooltip": "Cleans a notifier.\n\nNote this also stops a notifier if it is already running.\n\n:param in: notifierHandle the notifier handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "cleanNotifier"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}], "tooltip": "Cleans a PowerDistribution module.\n\n:param handle: the module handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "cleanPowerDistribution"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Clears all sticky faults on this device.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "clearAllCTREPCMStickyFaults"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Disables the down counting source to the counter.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "clearCounterDownSource"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Disables the up counting source to the counter.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "clearCounterUpSource"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Clears any PowerDistribution sticky faults.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "clearPowerDistributionStickyFaults"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Clears the sticky faults.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "clearREVPHStickyFaults"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Clears the receive buffer of the serial port.\n\n:param in: handle the serial port handle\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "clearSerial"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "port", "type": "hal.I2CPort"}], "tooltip": "Closes an I2C port\n\n:param port: The I2C port, 0 for the on-board, 1 for the MXP.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "closeI2C"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myI2CPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "port", "type": "hal.SPIPort"}], "tooltip": "Closes the SPI port.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for MXP", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "closeSPI"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}], "tooltip": "Closes a serial port.\n\n:param in: handle the serial port handle to close", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "closeSerial"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "csToSclkTicks", "type": "int"}, {"name": "stallTicks", "type": "int"}, {"name": "pow2BytesPerRead", "type": "int"}], "tooltip": "Configure the Auto SPI Stall time between reads.\n\n:param in: port The number of the port to use. 0-3 for Onboard\n CS0-CS2, 4 for MXP.\n:param in: csToSclkTicks the number of ticks to wait before asserting the\n cs pin\n:param in: stallTicks the number of ticks to stall for\n:param in: pow2BytesPerRead the number of bytes to read before stalling\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "configureSPIAutoStall"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "index", "type": "int"}, {"name": "handleType", "type": "hal.HandleEnum"}, {"name": "version", "type": "int"}], "tooltip": "Create a handle for a specific index, type and version.\n\nNote the version is not checked on the roboRIO.\n\n:param index: the index\n:param handleType: the handle type\n:param version: the handle version\n\n:returns: the created handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "createHandle"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myHandleEnum"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}, {"name": "module", "type": "int"}], "tooltip": "Create a port handle.\n\n:param channel: the channel\n:param module: the module\n\n:returns: port handle for the module and channel", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "createPortHandle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "Create a port handle for SPI.\n\n:param channel: the SPI channel\n\n:returns: port handle for the channel", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "createPortHandleForSPI"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Disables a termination character for reads.\n\n:param in: handle the serial port handle\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "disableSerialTermination"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "terminator", "type": "str"}], "tooltip": "Sets the termination character that terminates a read.\n\nBy default this is disabled.\n\n:param in: handle the serial port handle\n:param in: terminator the termination character to set\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "enableSerialTermination"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Causes HAL_RunMain() to exit.\n\nIf HAL_SetMain() has been called, this calls the exit function provided\nto that function.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "exitMain"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "unexpandedLower", "type": "int"}], "tooltip": "Given an 32 bit FPGA time, expand it to the nearest likely 64 bit FPGA time.\n\nNote: This is making the assumption that the timestamp being converted is\nalways in the past. If you call this with a future timestamp, it probably\nwill make it in the past. If you wait over 70 minutes between capturing the\nbottom 32 bits of the timestamp and expanding it, you will be off by\nmultiples of 1<<32 microseconds.\n\n:param in: unexpandedLower 32 bit FPGA time\n:param out: status the error code, or 0 for success\n\n:returns: The current time in microseconds according to the FPGA (since FPGA\n reset) as a 64 bit number.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "expandFPGATime"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "index", "type": "int"}], "tooltip": "Fire a single solenoid shot.\n\n:param in: handle the PCM handle\n:param in: index solenoid index\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "fireCTREPCMOneShot"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "index", "type": "int"}, {"name": "durMs", "type": "int"}], "tooltip": "Fire a single solenoid shot for the specified duration.\n\n:param in: handle the PH handle\n:param in: index solenoid index\n:param in: durMs shot duration in ms\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "fireREVPHOneShot"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Flushes the serial write buffer out to the port.\n\n:param in: handle the serial port handle\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "flushSerial"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}], "tooltip": "Immediately forces an SPI read to happen.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP.\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "forceSPIAutoRead"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}], "tooltip": "Free the Addressable LED Handle.\n\n:param in: handle the Addressable LED handle to free", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeAddressableLED"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}], "tooltip": "Frees an analog gyro.\n\n:param handle: the gyro handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeAnalogGyro"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Frees an analog input port.\n\n:param analogPortHandle: Handle to the analog port.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeAnalogInputPort"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "analogOutputHandle", "type": "int"}], "tooltip": "Frees an analog output port.\n\n:param analogOutputHandle: the analog output handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeAnalogOutputPort"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}], "tooltip": "Frees a PCM handle.\n\n:param in: handle the PCMhandle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeCTREPCM"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Frees a counter.\n\n:param in: counterHandle the counter handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeCounter"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "dioPortHandle", "type": "int"}], "tooltip": "Frees a DIO port.\n\n:param dioPortHandle: the DIO channel handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeDIOPort"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "pwmGenerator", "type": "int"}], "tooltip": "Frees the resource associated with a DO PWM generator.\n\n:param in: pwmGenerator the digital PWM handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeDigitalPWM"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "dutyCycleHandle", "type": "int"}], "tooltip": "Free a DutyCycle.\n\n:param dutyCycleHandle: the duty cycle handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeDutyCycle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Frees an encoder.\n\n:param in: encoderHandle the encoder handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeEncoder"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "pwmPortHandle", "type": "int"}], "tooltip": "Frees a PWM port.\n\n:param in: pwmPortHandle the pwm handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freePWMPort"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}], "tooltip": "Frees a PH handle.\n\n:param in: handle the PH handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeREVPH"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "relayPortHandle", "type": "int"}], "tooltip": "Frees a relay port.\n\n:param relayPortHandle: the relay handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeRelayPort"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}], "tooltip": "Frees an SPI automatic accumulator.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP.\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "freeSPIAuto"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "Gets the x-axis acceleration.\n\nThis is a floating point value in units of 1 g-force.\n\n:returns: the X acceleration", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAccelerometerX"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "Gets the y-axis acceleration.\n\nThis is a floating point value in units of 1 g-force.\n\n:returns: the Y acceleration", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAccelerometerY"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [], "tooltip": "Gets the z-axis acceleration.\n\nThis is a floating point value in units of 1 g-force.\n\n:returns: the Z acceleration", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAccelerometerZ"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Read the number of accumulated values.\n\nRead the count of the accumulated values since the accumulator was last\nReset().\n\n:param in: analogPortHandle Handle to the analog port.\n:param out: status Error status variable. 0 on success.\n\n:returns: The number of times samples from the channel were accumulated.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAccumulatorCount"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int, int]", "args": [{"name": "analogPortHandle", "type": "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 in: analogPortHandle Handle to the analog port.\n:param in: value Pointer to the 64-bit accumulated output.\n:param in: count Pointer to the number of accumulation cycles.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAccumulatorOutput"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Read the accumulated value.\n\nRead the value that has been accumulating on channel 1.\nThe accumulator is attached after the oversample and average engine.\n\n:param in: analogPortHandle Handle to the analog port.\n:param out: status Error status variable. 0 on success.\n\n:returns: The 64-bit value accumulated since the last Reset().", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAccumulatorValue"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "axes", "type": "hal.JoystickAxes"}, {"name": "povs", "type": "hal.JoystickPOVs"}, {"name": "buttons", "type": "hal.JoystickButtons"}], "tooltip": "", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAllJoystickData"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickAxes"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickPOVs"}}}}, "ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickButtons"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[hal._wpiHal.AllianceStationID, int]", "args": [], "tooltip": "Gets the current alliance station ID.\n\n:param out: status the error code, or 0 for success\n\n:returns: the alliance station ID", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAllianceStation"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Gets the number of averaging bits.\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 FPGA.\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: Bits to average.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogAverageBits"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Gets a sample from the output of the oversample and average engine for the\nchannel.\n\nThe sample is 12-bit + the value configured in SetOversampleBits().\nThe value configured in SetAverageBits() will cause this value to be averaged\n2**bits number of samples. This is not a sliding window. The sample will not\nchange until 2**(OversampleBits + AverageBits) samples have been acquired\nfrom the module on this channel. Use GetAverageVoltage() to get the analog\nvalue in calibrated units.\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: A sample from the oversample and average engine for the channel.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogAverageValue"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Gets a scaled sample from the output of the oversample and average engine for\nthe channel.\n\nThe value is scaled to units of Volts using the calibrated scaling data from\nGetLSBWeight() and GetOffset(). Using oversampling will cause this value to\nbe higher resolution, but it will update more slowly. Using averaging will\ncause this value to be more stable, but it will update more slowly.\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: A scaled sample from the output of the oversample and average engine\n for the channel.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogAverageVoltage"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the gyro angle in degrees.\n\n:param in: handle the gyro handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the gyro angle in degrees", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogGyroAngle"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the calibrated gyro center.\n\nCan be used to not repeat a calibration but reconstruct the gyro object.\n\n:param in: handle the gyro handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the gyro center", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogGyroCenter"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the calibrated gyro offset.\n\nCan be used to not repeat a calibration but reconstruct the gyro object.\n\n:param in: handle the gyro handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the gyro offset", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogGyroOffset"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the gyro rate in degrees/second.\n\n:param in: handle the gyro handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the gyro rate in degrees/second", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogGyroRate"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Gets the factory scaling least significant bit weight constant.\nThe least significant bit weight constant for the channel that was calibrated\nin manufacturing and stored in an eeprom in the module.\n\nVolts = ((LSB_Weight * 1e-9) * raw) - (Offset * 1e-9)\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: Least significant bit weight.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogLSBWeight"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Gets the factory scaling offset constant.\nThe offset constant for the channel that was calibrated in manufacturing and\nstored in an eeprom in the module.\n\nVolts = ((LSB_Weight * 1e-9) * raw) - (Offset * 1e-9)\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status Error status variable. 0 on success.\n\n:returns: Offset constant.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogOffset"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "analogOutputHandle", "type": "int"}], "tooltip": "Gets the current analog output value.\n\n:param in: analogOutputHandle the analog output handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current output voltage (0-5v)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogOutput"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Gets the number of oversample bits.\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:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: Bits to oversample.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogOversampleBits"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Gets the current sample rate.\n\nThis assumes one entry in the scan list.\nThis is a global setting for the Athena and effects all channels.\n\n:param out: status the error code, or 0 for success\n\n:returns: Sample rate.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogSampleRate"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogTriggerHandle", "type": "int"}], "tooltip": "Get the FPGA index for the AnalogTrigger.\n\n:param in: analogTriggerHandle the trigger handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the FPGA index", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogTriggerFPGAIndex"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogTriggerHandle", "type": "int"}], "tooltip": "Returns the InWindow output of the analog trigger.\n\nTrue if the analog input is between the upper and lower limits.\n\n:param in: analogTriggerHandle the trigger handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the InWindow output of the analog trigger", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogTriggerInWindow"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogTriggerHandle", "type": "int"}, {"name": "type", "type": "hal.AnalogTriggerType"}], "tooltip": "Gets the state of the analog trigger output.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: type the type of trigger to trigger on\n:param out: status Error status variable. 0 on success.\n\n:returns: the state of the analog trigger output", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogTriggerOutput"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAnalogTriggerType"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogTriggerHandle", "type": "int"}], "tooltip": "Returns 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:param in: analogTriggerHandle the trigger handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the TriggerState output of the analog trigger", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogTriggerTriggerState"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Gets a sample straight from the channel on this module.\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:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: A sample straight from the channel on this module.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogValue"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "analogPortHandle", "type": "int"}, {"name": "rawValue", "type": "int"}], "tooltip": "Get the analog voltage from a raw value.\n\n:param in: analogPortHandle Handle to the analog port the values were read\n from.\n:param in: rawValue The raw analog value\n:param out: status Error status variable. 0 on success.\n\n:returns: The voltage relating to the value", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogValueToVolts"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Gets a scaled sample straight from the channel on this module.\n\nThe value is scaled to units of Volts using the calibrated scaling data from\nGetLSBWeight() and GetOffset().\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: A scaled sample straight from the channel on this module.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogVoltage"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogPortHandle", "type": "int"}, {"name": "voltage", "type": "float"}], "tooltip": "Converts a voltage to a raw value for a specified channel.\n\nThis process depends on the calibration of each channel, so the channel must\nbe specified.\n\n@todo This assumes raw values. Oversampling not supported as is.\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param in: voltage The voltage to convert.\n:param out: status the error code, or 0 for success\n\n:returns: The raw value for the channel.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getAnalogVoltsToValue"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets if the system is in a browned out state.\n\n:param out: status the error code, or 0 for success\n\n:returns: true if the system is in a low voltage brown out, false otherwise", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getBrownedOut"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Get the current brownout voltage setting.\n\n:param out: status the error code, or 0 for success\n\n:returns: The brownout voltage", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getBrownoutVoltage"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Reads the current value of the millisecond-resolution timer that the CAN API\nfunctions use as a time base.\n\n:returns: Current value of timer used as a base time by the CAN API in\n milliseconds.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCANPacketBaseTime"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Get the current CPU temperature in degrees Celsius\n\n:param out: status the error code, or 0 for success\n\n:returns: current CPU temperature in degrees Celsius", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCPUTemp"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Get whether the PCM closed loop control is enabled.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if closed loop control is enabled, otherwise false.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMClosedLoopControl"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Get whether compressor is turned on.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if the compressor is turned on", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMCompressor"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns the current drawn by the compressor.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: The current drawn by the compressor in amps.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMCompressorCurrent"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Return whether the compressor current is currently too high.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if the compressor current is too high, otherwise false.\n @see HAL_GetCTREPCMCompressorShortedStickyFault", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMCompressorCurrentTooHighFault"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "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\nHAL_ClearAllCTREPCMStickyFaults()\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if the compressor current has been too high since sticky\n faults were last cleared.\n @see HAL_GetCTREPCMCompressorCurrentTooHighFault()", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMCompressorCurrentTooHighStickyFault"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns whether the compressor is currently disconnected.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if compressor is currently disconnected, otherwise false.\n @see HAL_GetCTREPCMCompressorNotConnectedStickyFault()", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMCompressorNotConnectedFault"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns whether the compressor has been disconnected since sticky faults\nwere last cleared. This fault is persistent and can be cleared by\nHAL_ClearAllCTREPCMStickyFaults()\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if the compressor has been disconnected since sticky faults\n were last cleared, otherwise false.\n @see HAL_GetCTREPCMCompressorShortedFault()", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMCompressorNotConnectedStickyFault"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns whether the compressor is currently shorted.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if the compressor is currently shorted, otherwise false.\n @see HAL_GetCTREPCMCompressorShortedStickyFault", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMCompressorShortedFault"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns whether the compressor has been shorted since sticky faults were\nlast cleared. This fault is persistent and can be cleared by\nHAL_ClearAllCTREPCMStickyFaults()\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if the compressor has been shorted since sticky faults were\n last cleared, otherwise false.\n @see HAL_GetCTREPCMCompressorShortedFault()", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMCompressorShortedStickyFault"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns the state of the pressure switch.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if pressure switch indicates that the system is full,\n otherwise false.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMPressureSwitch"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Get a bitmask of disabled solenoids.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: Bitmask indicating disabled solenoids. The LSB represents solenoid 0.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMSolenoidDisabledList"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns whether the solenoid is currently reporting a voltage fault.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if solenoid is reporting a fault, otherwise false.\n @see HAL_GetCTREPCMSolenoidVoltageStickyFault()", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMSolenoidVoltageFault"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns whether the solenoid has reported a voltage fault since sticky faults\nwere last cleared. This fault is persistent and can be cleared by\nHAL_ClearAllCTREPCMStickyFaults()\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if solenoid is reporting a fault, otherwise false.\n @see HAL_GetCTREPCMSolenoidVoltageFault()", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMSolenoidVoltageStickyFault"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets a bitmask of solenoid values.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: Bitmask containing the state of the solenoids. The LSB represents\n solenoid 0.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCTREPCMSolenoids"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "str", "args": [], "tooltip": "Returns the comments from the roboRIO web interface.\n\n:param out: comments The comments string. Free with WPI_FreeString", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getComments"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "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.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCommsDisableCount"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "controlWord", "type": "hal.ControlWord"}], "tooltip": "Gets the current control word of the driver station.\n\nThe control word contains the robot state.\n\n:param controlWord: the control word (out)\n\n:returns: the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getControlWord"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myControlWord"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Reads the current counter value.\n\nReads 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.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current counter value", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCounter"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Gets the last direction the counter value changed.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the last direction the counter value changed", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCounterDirection"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Gets 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:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the period of the last two pulses in units of seconds", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCounterPeriod"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Gets 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 in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.\n\n:returns: SamplesToAverage The number of samples being averaged (from 1 to 127)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCounterSamplesToAverage"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Determines 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:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if the most recent counter period exceeds the MaxPeriod value\n set by SetMaxPeriod", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCounterStopped"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "isRealTime", "type": "int"}], "tooltip": "Gets the thread priority for the current thread.\n\n:param out: isRealTime Set to true if thread is real-time, otherwise false.\n:param out: status Error status variable. 0 on success.\n\n:returns: The current thread priority. For real-time, this is 1-99 with 99\n being highest. For non-real-time, this is 0. See \"man 7 sched\" for\n details.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getCurrentThreadPriority"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "dioPortHandle", "type": "int"}], "tooltip": "Reads a digital value from a DIO channel.\n\n:param in: dioPortHandle the digital port handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the state of the specified channel", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getDIO"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "dioPortHandle", "type": "int"}], "tooltip": "Reads the direction of a DIO channel.\n\n:param in: dioPortHandle the digital port handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true for input, false for output", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getDIODirection"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "dutyCycleHandle", "type": "int"}], "tooltip": "Get the FPGA index for the DutyCycle.\n\n:param in: dutyCycleHandle the duty cycle handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the FPGA index", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getDutyCycleFPGAIndex"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "dutyCycleHandle", "type": "int"}], "tooltip": "Get the frequency of the duty cycle signal.\n\n:param in: dutyCycleHandle the duty cycle handle\n:param out: status Error status variable. 0 on success.\n\n:returns: frequency in Hertz", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getDutyCycleFrequency"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "dutyCycleHandle", "type": "int"}], "tooltip": "Get the raw high time of the duty cycle signal.\n\n:param in: dutyCycleHandle the duty cycle handle\n:param out: status Error status variable. 0 on success.\n\n:returns: high time of last pulse in nanoseconds", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getDutyCycleHighTime"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "dutyCycleHandle", "type": "int"}], "tooltip": "Get the output ratio of the duty cycle signal.\n\n0 means always low, 1 means always high.\n\n:param in: dutyCycleHandle the duty cycle handle\n:param out: status Error status variable. 0 on success.\n\n:returns: output ratio between 0 and 1", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getDutyCycleOutput"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "dutyCycleHandle", "type": "int"}], "tooltip": "Get the scale factor of the output.\n\nAn output equal to this value is always high, and then linearly scales\ndown to 0. Divide a raw result by this in order to get the\npercentage between 0 and 1. Used by DMA.\n\n:param in: dutyCycleHandle the duty cycle handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the output scale factor", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getDutyCycleOutputScaleFactor"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the current counts of the encoder after encoding type scaling.\n\nThis is scaled by the value passed during initialization to encodingType.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current scaled count", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoder"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the decoding scale factor of the encoder.\n\nThis is used to perform the scaling from raw to type scaled values.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the scale value for the encoder", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderDecodingScaleFactor"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the last direction the encoder value changed.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the last direction the encoder value changed", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderDirection"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the current distance traveled by the encoder.\n\nThis is the encoder count scaled by the distance per pulse set for the\nencoder.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the encoder distance (units are determined by the units\n passed to HAL_SetEncoderDistancePerPulse)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderDistance"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the user set distance per pulse of the encoder.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the set distance per pulse", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderDistancePerPulse"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the encoder scale value.\n\nThis is set by the value passed during initialization to encodingType.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the encoder scale value", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderEncodingScale"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[hal._wpiHal.EncoderEncodingType, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the encoding type of the encoder.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the encoding type", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderEncodingType"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the FPGA index of the encoder.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the FPGA index of the encoder", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderFPGAIndex"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets 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:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the period of the last two pulses in units of seconds", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderPeriod"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the current rate of the encoder.\n\nThis is the encoder period scaled by the distance per pulse set for the\nencoder.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the encoder rate (units are determined by the units passed to\n HAL_SetEncoderDistancePerPulse, time value is seconds)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderRate"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the raw counts of the encoder.\n\nThis is not scaled by any values.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the raw encoder count", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderRaw"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Gets the current samples to average value.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current samples to average value", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderSamplesToAverage"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Determines if the clock is stopped.\n\nDetermines 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 encoder) are assumed to be stopped and it returns true.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if the most recent encoder period exceeds the MaxPeriod value\n set by SetMaxPeriod", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getEncoderStopped"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "str", "args": [{"name": "code", "type": "int"}], "tooltip": "Gets the error message for a specific status code.\n\n:param code: the status code\n\n:returns: the error message for the code. This does not need to be freed.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getErrorMessage"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets 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:param out: status the error code, or 0 for success\n\n:returns: true if the button is currently pressed down", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getFPGAButton"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Returns the FPGA Revision number.\n\nThe format of the revision is 3 numbers.\nThe 12 most significant bits are the Major Revision.\nthe next 8 bits are the Minor Revision.\nThe 12 least significant bits are the Build Number.\n\n:param out: status the error code, or 0 for success\n\n:returns: FPGA Revision number.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getFPGARevision"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Reads the microsecond-resolution timer on the FPGA.\n\n:param out: status the error code, or 0 for success\n\n:returns: The current time in microseconds according to the FPGA (since FPGA\n reset).", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getFPGATime"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Returns the FPGA Version number.\n\nFor now, expect this to be competition year.\n\n:param out: status the error code, or 0 for success\n\n:returns: FPGA Version number.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getFPGAVersion"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "filterIndex", "type": "int"}], "tooltip": "Gets the filter period for the specified filter index.\n\nGets the filter period in FPGA cycles. Even though there are 2 different\nfilter index domains (MXP vs HDR), ignore that distinction for now since it\ncomplicates the interface. Set status to NiFpga_Status_SoftwareFault if the\nfilter values mismatch.\n\n:param in: filterIndex the filter index, 0 - 2\n:param out: status Error status variable. 0 on success.\n\n:returns: The number of FPGA cycles of the filter period.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getFilterPeriod"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "dioPortHandle", "type": "int"}], "tooltip": "Reads the filter index from the FPGA.\n\nGets the filter index used to filter out short pulses.\n\n:param in: dioPortHandle the digital port handle\n:param out: status Error status variable. 0 on success.\n\n:returns: filterIndex the filter index (Must be in the range 0 - 3, where 0\n means \"none\" and 1 - 3 means filter # filterIndex - 1)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getFilterSelect"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Get the handle index from a handle.\n\n:param handle: the handle\n\n:returns: the index", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getHandleIndex"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myHandleEnum"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.HandleEnum", "args": [{"name": "handle", "type": "int"}], "tooltip": "Get the handle type from a handle.\n\n:param handle: the handle\n\n:returns: the type", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getHandleType"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "enumType", "type": "hal.HandleEnum"}, {"name": "version", "type": "int"}], "tooltip": "Get if the handle is a correct type and version.\n\nNote the version is not checked on the roboRIO.\n\n:param handle: the handle\n:param enumType: the type to check\n:param version: the handle version to check\n\n:returns: true if the handle is proper version and type, otherwise\n false.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getHandleTypedIndex"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myHandleEnum"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "joystickNum", "type": "int"}, {"name": "axes", "type": "hal.JoystickAxes"}], "tooltip": "Gets the axes of a specific joystick.\n\n:param joystickNum: the joystick number\n:param axes: the axes values (output)\n\n:returns: the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getJoystickAxes"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickAxes"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "joystickNum", "type": "int"}, {"name": "axis", "type": "int"}], "tooltip": "Gets the type of a specific joystick axis.\n\nThis is device specific, and different depending on what system input type\nthe joystick uses.\n\n:param joystickNum: the joystick number\n:param axis: the axis number\n\n:returns: the enumerated axis type", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getJoystickAxisType"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "joystickNum", "type": "int"}, {"name": "buttons", "type": "hal.JoystickButtons"}], "tooltip": "Gets the buttons of a specific joystick.\n\n:param joystickNum: the joystick number\n:param buttons: the button values (output)\n\n:returns: the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getJoystickButtons"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickButtons"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "joystickNum", "type": "int"}, {"name": "desc", "type": "hal.JoystickDescriptor"}], "tooltip": "Retrieves the Joystick Descriptor for particular slot.\n\n:param joystickNum: the joystick number\n:param out: desc descriptor (data transfer object) to fill in. desc is\n filled in regardless of success. In other words, if\n descriptor is not available, desc is filled in with\n default values matching the init-values in Java and C++\n Driver Station for when caller requests a too-large\n joystick index.\n\n:returns: error code reported from Network Comm back-end. Zero is good,\n nonzero is bad.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getJoystickDescriptor"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickDescriptor"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "joystickNum", "type": "int"}], "tooltip": "Gets whether a specific joystick is considered to be an XBox controller.\n\n:param joystickNum: the joystick number\n\n:returns: true if xbox, false otherwise", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getJoystickIsXbox"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "str", "args": [{"name": "joystickNum", "type": "int"}], "tooltip": "Gets the name of a joystick.\n\nThe returned string must be freed with WPI_FreeString\n\n:param name: the joystick name string\n:param joystickNum: the joystick number", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getJoystickName"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "joystickNum", "type": "int"}, {"name": "povs", "type": "hal.JoystickPOVs"}], "tooltip": "Gets the POVs of a specific joystick.\n\n:param joystickNum: the joystick number\n:param povs: the POV values (output)\n\n:returns: the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getJoystickPOVs"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myJoystickPOVs"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "joystickNum", "type": "int"}], "tooltip": "Gets the type of joystick connected.\n\nThis is device specific, and different depending on what system input type\nthe joystick uses.\n\n:param joystickNum: the joystick number\n\n:returns: the enumerated joystick type", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getJoystickType"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[str, int]", "args": [], "tooltip": "Gets the last error set on this thread, or the message for the status code.\n\nIf passed HAL_USE_LAST_ERROR, the last error set on the thread will be\nreturned.\n\n:param out: status the status code, set to the error status code if input is\n HAL_USE_LAST_ERROR\n\n:returns: the error message for the code. This does not need to be freed,\n but can be overwritten by another hal call on the same thread.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getLastError"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "info", "type": "hal.MatchInfo"}], "tooltip": "Gets info about a specific match.\n\n:param in: info the match info (output)\n\n:returns: the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getMatchInfo"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myMatchInfo"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "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 integer\nincrements, 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:param out: status the error code, or 0 for success\n\n:returns: Time remaining in current match period (auto or teleop) in seconds", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getMatchTime"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of analog accumulators in the current system.\n\n:returns: the number of analog accumulators", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumAccumulators"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of addressable LED generators in the current system.\n\n:returns: the number of Addressable LED generators", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumAddressableLEDs"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of analog inputs in the current system.\n\n:returns: the number of analog inputs", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumAnalogInputs"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of analog outputs in the current system.\n\n:returns: the number of analog outputs", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumAnalogOutputs"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of analog triggers in the current system.\n\n:returns: the number of analog triggers", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumAnalogTriggers"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of PCM modules in the current system.\n\n:returns: the number of PCM modules", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumCTREPCMModules"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of PDP channels in the current system.\n\n:returns: the number of PDP channels", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumCTREPDPChannels"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of PDP modules in the current system.\n\n:returns: the number of PDP modules", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumCTREPDPModules"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of solenoid channels in the current system.\n\n:returns: the number of solenoid channels", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumCTRESolenoidChannels"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of counters in the current system.\n\n:returns: the number of counters", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumCounters"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of digital channels in the current system.\n\n:returns: the number of digital channels", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumDigitalChannels"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of digital headers in the current system.\n\n:returns: the number of digital headers", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumDigitalHeaders"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of digital IO PWM outputs in the current system.\n\n:returns: the number of digital IO PWM outputs", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumDigitalPWMOutputs"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of duty cycle inputs in the current system.\n\n:returns: the number of Duty Cycle inputs", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumDutyCycles"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of quadrature encoders in the current system.\n\n:returns: the number of quadrature encoders", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumEncoders"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of interrupts in the current system.\n\n:returns: the number of interrupts", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumInterrupts"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of PWM channels in the current system.\n\n:returns: the number of PWM channels", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumPWMChannels"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of PWM headers in the current system.\n\n:returns: the number of PWM headers", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumPWMHeaders"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of PDH channels in the current system.\n\n:returns: the number of PDH channels", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumREVPDHChannels"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of PDH modules in the current system.\n\n:returns: the number of PDH modules", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumREVPDHModules"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of PH channels in the current system.\n\n:returns: the number of PH channels", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumREVPHChannels"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of PH modules in the current system.\n\n:returns: the number of PH modules", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumREVPHModules"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of relay channels in the current system.\n\n:returns: the number of relay channels", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumRelayChannels"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of relay headers in the current system.\n\n:returns: the number of relay headers", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getNumRelayHeaders"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets if outputs are enabled by the control system.\n\n:returns: true if outputs are enabled", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getOutputsEnabled"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int, int, int, int, int]", "args": [{"name": "pwmPortHandle", "type": "int"}], "tooltip": "Gets the pwm configuration settings for the PWM channel.\n\nValues are in microseconds.\n\n:param in: pwmPortHandle the PWM handle\n:param in: maxPwm the maximum PWM value\n:param in: deadbandMaxPwm the high range of the center deadband\n:param in: centerPwm the center PWM value\n:param in: deadbandMinPwm the low range of the center deadband\n:param in: minPwm the minimum PWM value\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPWMConfigMicroseconds"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets the pwm starting cycle time.\n\nThis time is relative to the FPGA time.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: the pwm cycle start time", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPWMCycleStartTime"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "pwmPortHandle", "type": "int"}], "tooltip": "Gets the current eliminate deadband value.\n\n:param in: pwmPortHandle the PWM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if set, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPWMEliminateDeadband"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets the loop timing of the PWM system.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: the loop time in clock ticks", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPWMLoopTiming"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "pwmPortHandle", "type": "int"}], "tooltip": "Gets a position value from a PWM channel.\n\nThe values range from 0 to 1.\n\n:param in: pwmPortHandle the PWM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current positional PWM value", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPWMPosition"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "pwmPortHandle", "type": "int"}], "tooltip": "Gets the current microsecond pulse time from a PWM channel.\n\n:param in: pwmPortHandle the PWM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current PWM microsecond pulse time", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPWMPulseTimeMicroseconds"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "pwmPortHandle", "type": "int"}], "tooltip": "Gets a scaled value from a PWM channel.\n\nThe values range from -1 to 1.\n\n:param in: pwmPortHandle the PWM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current speed PWM value", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPWMSpeed"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channel", "type": "int"}], "tooltip": "Gets a port handle for a specific channel.\n\nThe created handle does not need to be freed.\n\n:param channel: the channel number\n\n:returns: the created port", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPort"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the port channel of a port handle.\n\n:param handle: the port handle\n\n:returns: the port channel", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPortHandleChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the port module of a port handle.\n\n:param handle: the port handle\n\n:returns: the port module", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPortHandleModule"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the SPI channel of a port handle.\n\n:param handle: the port handle\n\n:returns: the port SPI channel", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPortHandleSPIEnable"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "module", "type": "int"}, {"name": "channel", "type": "int"}], "tooltip": "Gets a port handle for a specific channel and module.\n\nThis is expected to be used for PCMs, as the roboRIO does not work with\nmodules anymore.\n\nThe created handle does not need to be freed.\n\n:param module: the module number\n:param channel: the channel number\n\n:returns: the created port", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPortWithModule"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}, {"name": "currentsLength", "type": "int"}], "tooltip": "Gets the current of all channels on the PowerDistribution.\n\nThe array must be large enough to hold all channels.\n\n:param in: handle the module handle\n:param out: currents the currents\n:param in: currentsLength the length of the currents array\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionAllChannelCurrents"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}, {"name": "channel", "type": "int"}], "tooltip": "Gets the current of a specific PowerDistribution channel.\n\n:param in: handle the module handle\n:param in: channel the channel\n:param out: status Error status variable. 0 on success.\n\n:returns: the channel current (amps)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionChannelCurrent"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "faults", "type": "hal.PowerDistributionFaults"}], "tooltip": "Get the current faults of the PowerDistribution.\n\nOn a CTRE PDP, this will return an object with no faults active.\n\n:param in: handle the module handle\n:param out: faults the HAL_PowerDistributionFaults to populate\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionFaults"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPowerDistributionFaults"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the module number for a specific handle.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the module number", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionModuleNumber"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the number of channels for this handle.\n\n:param in: handle the handle\n:param out: status Error status variable. 0 on success.\n\n:returns: number of channels", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionNumChannels"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "stickyFaults", "type": "hal.PowerDistributionStickyFaults"}], "tooltip": "Gets the sticky faults of the PowerDistribution.\n\nOn a CTRE PDP, this will return an object with no faults active.\n\n:param in: handle the module handle\n:param out: stickyFaults the HAL_PowerDistributionStickyFaults to populate\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionStickyFaults"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPowerDistributionStickyFaults"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns true if switchable channel is powered on.\n\nThis is a REV PDH-specific function. This function will no-op on CTRE PDP.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the state of the switchable channel", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionSwitchableChannel"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the temperature of the Power Distribution Panel.\n\nNot supported on the Rev PDH and returns 0.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the module temperature (celsius)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionTemperature"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the total current of the PowerDistribution.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the total current (amps)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionTotalCurrent"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the total energy of the Power Distribution Panel.\n\nNot supported on the Rev PDH and returns 0.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the total energy (joules)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionTotalEnergy"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the total power of the Power Distribution Panel.\n\nNot supported on the Rev PDH and returns 0.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the total power (watts)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionTotalPower"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[hal._wpiHal.PowerDistributionType, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the type of PowerDistribution module.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the type of module", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionType"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "version", "type": "hal.PowerDistributionVersion"}], "tooltip": "Get the version of the PowerDistribution.\n\n:param in: handle the module handle\n:param out: version the HAL_PowerDistributionVersion to populate\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionVersion"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPowerDistributionVersion"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the PowerDistribution input voltage.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the input voltage (volts)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getPowerDistributionVoltage"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns the current voltage of the regulated 5v supply.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: The current voltage of the 5v supply in volts.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPH5VVoltage"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}, {"name": "channel", "type": "int"}], "tooltip": "Returns the raw voltage of the specified analog\ninput channel.\n\n:param in: handle the PH handle\n:param in: channel The analog input channel to read voltage from.\n:param out: status Error status variable. 0 on success.\n\n:returns: The voltage of the specified analog input channel in volts.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHAnalogVoltage"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Get whether compressor is turned on.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if the compressor is turned on", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHCompressor"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[hal._wpiHal.REVPHCompressorConfigType, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Get compressor configuration from the PH.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: compressor configuration", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHCompressorConfig"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns the current drawn by the compressor.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: The current drawn by the compressor in amps.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHCompressorCurrent"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "faults", "type": "hal.REVPHFaults"}], "tooltip": "Returns the faults currently active on the PH.\n\n:param in: handle the PH handle\n:param out: faults The faults.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHFaults"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myREVPHFaults"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns the state of the digital pressure switch.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if pressure switch indicates that the system is full,\n otherwise false.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHPressureSwitch"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns the total current drawn by all solenoids.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: Total current drawn by all solenoids in amps.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHSolenoidCurrent"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Get a bitmask of disabled solenoids.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: Bitmask indicating disabled solenoids. The LSB represents solenoid 0.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHSolenoidDisabledList"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns the current voltage of the solenoid power supply.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: The current voltage of the solenoid power supply in volts.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHSolenoidVoltage"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets a bitmask of solenoid values.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: Bitmask containing the state of the solenoids. The LSB represents\n solenoid 0.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHSolenoids"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "stickyFaults", "type": "hal.REVPHStickyFaults"}], "tooltip": "Returns the sticky faults currently active on this device.\n\n:param in: handle the PH handle\n:param out: stickyFaults The sticky faults.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHStickyFaults"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myREVPHStickyFaults"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "version", "type": "hal.REVPHVersion"}], "tooltip": "Returns the hardware and firmware versions of the PH.\n\n:param in: handle the PH handle\n:param out: version The hardware and firmware versions.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHVersion"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myREVPHVersion"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Returns the current input voltage for the PH.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: The input voltage in volts.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getREVPHVoltage"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets the current state of the Robot Signal Light (RSL).\n\n:param out: status the error code, or 0 for success\n\n:returns: The current state of the RSL- true if on, false if off", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getRSLState"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "relayPortHandle", "type": "int"}], "tooltip": "Gets the current state of the relay channel.\n\n:param in: relayPortHandle the relay handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true for on, false for off", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getRelay"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myRuntimeType"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.RuntimeType", "args": [], "tooltip": "Returns the runtime type of the HAL.\n\n:returns: HAL Runtime Type", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getRuntimeType"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "port", "type": "hal.SPIPort"}], "tooltip": "Gets the count of how many SPI accumulations have been missed.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP.\n:param out: status the error code, or 0 for success\n\n:returns: The number of missed accumulations.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getSPIAutoDroppedCount"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}], "tooltip": "Gets the stored handle for a SPI port.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for MXP\n\n:returns: The stored handle for the SPI port. 0 represents no stored\n handle.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getSPIHandle"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "mySPIMode"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "hal.SPIMode", "args": [{"name": "port", "type": "hal.SPIPort"}], "tooltip": "Gets the SPI Mode.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP\n\n:returns: The SPI mode currently set", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getSPIMode"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the number of bytes currently in the read buffer.\n\n:param in: handle the serial port handle\n:param out: status the error code, or 0 for success\n\n:returns: the number of bytes in the read buffer", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getSerialBytesReceived"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}], "tooltip": "Gets the raw serial port file descriptor from a handle.\n\n:param in: handle the serial port handle\n:param out: status the error code, or 0 for success\n\n:returns: the raw port descriptor", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getSerialFD"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "str", "args": [], "tooltip": "Returns the roboRIO serial number.\n\n:param out: serialNumber The roboRIO serial number. Free with WPI_FreeString", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getSerialNumber"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets if the system outputs are currently active.\n\n:param out: status the error code, or 0 for success\n\n:returns: true if the system outputs are active, false if disabled", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getSystemActive"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Gets the number of FPGA system clock ticks per microsecond.\n\n:returns: the number of clock ticks per microsecond", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getSystemClockTicksPerMicrosecond"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets if the system time is valid.\n\n:param out: status the error code, or 0 for success\n\n:returns: True if the system time is valid, false otherwise", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getSystemTimeValid"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Returns the team number configured for the robot controller.\n\n:returns: team number, or 0 if not found.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getTeamNumber"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets the active state of the 3V3 rail.\n\n:param out: status the error code, or 0 for success\n\n:returns: true if the rail is active, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserActive3V3"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets the active state of the 5V rail.\n\n:param out: status the error code, or 0 for success\n\n:returns: true if the rail is active, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserActive5V"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets the active state of the 6V rail.\n\n:param out: status the error code, or 0 for success\n\n:returns: true if the rail is active, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserActive6V"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Gets the 3V3 rail current.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 3V3 rail current (amps)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserCurrent3V3"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Gets the 5V rail current.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 5V rail current (amps)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserCurrent5V"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Gets the 6V rail current.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 6V rail current (amps)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserCurrent6V"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets the fault count for the 3V3 rail. Capped at 255.\n\n:param out: status the error code, or 0 for success\n\n:returns: the number of 3V3 fault counts", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserCurrentFaults3V3"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets the fault count for the 5V rail. Capped at 255.\n\n:param out: status the error code, or 0 for success\n\n:returns: the number of 5V fault counts", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserCurrentFaults5V"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Gets the fault count for the 6V rail. Capped at 255.\n\n:param out: status the error code, or 0 for success\n\n:returns: the number of 6V fault counts", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserCurrentFaults6V"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Gets the 3V3 rail voltage.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 3V3 rail voltage (volts)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserVoltage3V3"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Gets the 5V rail voltage.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 5V rail voltage (volts)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserVoltage5V"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Gets the 6V rail voltage.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 6V rail voltage (volts)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getUserVoltage6V"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Gets the roboRIO input current.\n\n:param out: status the error code, or 0 for success\n\n:returns: the input current (amps)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getVinCurrent"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[float, int]", "args": [], "tooltip": "Gets the roboRIO input voltage.\n\n:param out: status the error code, or 0 for success\n\n:returns: the input voltage (volts)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "getVinVoltage"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Returns true if HAL_SetMain() has been called.\n\n:returns: True if HAL_SetMain() has been called, false otherwise.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "hasMain"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Initialize the accumulator.\n\n:param in: analogPortHandle Handle to the analog port.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initAccumulator"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "bufferSize", "type": "int"}], "tooltip": "Initializes the SPI automatic accumulator.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2,\n 4 for MXP.\n:param in: bufferSize The accumulator buffer size.\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initSPIAuto"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "timeout", "type": "int"}, {"name": "mode", "type": "int"}], "tooltip": "Call this to start up HAL. This is required for robot programs.\n\nThis must be called before any other HAL functions. Failure to do so will\nresult in undefined behavior, and likely segmentation faults. This means that\nany statically initialized variables in a program MUST call this function in\ntheir constructors if they want to use other HAL calls.\n\nThe common parameters are 500 for timeout and 0 for mode.\n\nThis function is safe to call from any thread, and as many times as you wish.\nIt internally guards from any reentrancy.\n\nThe applicable modes are:\n0: Try to kill an existing HAL from another program, if not successful,\nerror.\n1: Force kill a HAL from another program.\n2: Just warn if another hal exists and cannot be killed. Will likely result\nin undefined behavior.\n\n:param timeout: the initialization timeout (ms)\n:param mode: the initialization mode (see remarks)\n\n:returns: true if initialization was successful, otherwise false.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initialize"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "outputPort", "type": "int"}], "tooltip": "Initialize Addressable LED using a PWM Digital handle.\n\n:param in: outputPort handle of the digital port for PWM\n:param out: status the error code, or 0 for success\n\n:returns: Addressable LED handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeAddressableLED"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}, {"name": "allocationLocation", "type": "str"}], "tooltip": "Initializes an analog gyro.\n\n:param in: handle handle to the analog input port\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status the error code, or 0 for success\n\n:returns: the initialized gyro handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeAnalogGyro"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "portHandle", "type": "int"}, {"name": "allocationLocation", "type": "str"}], "tooltip": "Initializes the analog input port using the given port object.\n\n:param in: portHandle Handle to the port to initialize.\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status the error code, or 0 for success\n\n:returns: the created analog input handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeAnalogInputPort"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "portHandle", "type": "int"}, {"name": "allocationLocation", "type": "str"}], "tooltip": "Initializes the analog output port using the given port object.\n\n:param in: portHandle handle to the port\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created analog output handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeAnalogOutputPort"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "portHandle", "type": "int"}], "tooltip": "Initializes an analog trigger.\n\n:param in: portHandle the analog input to use for triggering\n:param out: status Error status variable. 0 on success.\n\n:returns: the created analog trigger handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeAnalogTrigger"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "dutyCycleHandle", "type": "int"}], "tooltip": "Initializes an analog trigger with a Duty Cycle input\n\n:param in: dutyCycleHandle the analog input to use for duty cycle\n:param out: status Error status variable. 0 on success.\n\n:returns: tbe created analog trigger handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeAnalogTriggerDutyCycle"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "manufacturer", "type": "hal.CANManufacturer"}, {"name": "deviceId", "type": "int"}, {"name": "deviceType", "type": "hal.CANDeviceType"}], "tooltip": "Initializes a CAN device.\n\nThese follow the FIRST standard CAN layout.\nhttps://docs.wpilib.org/en/stable/docs/software/can-devices/can-addressing.html\n\n:param in: manufacturer the can manufacturer\n:param in: deviceId the device ID (0-63)\n:param in: deviceType the device type\n:param out: status Error status variable. 0 on success.\n\n:returns: the created CAN handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeCAN"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myCANManufacturer"}}}}, "ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myCANDeviceType"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "module", "type": "int"}, {"name": "allocationLocation", "type": "str"}], "tooltip": "Initializes a PCM.\n\n:param in: module the CAN ID to initialize\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created PH handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeCTREPCM"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int, int]", "args": [{"name": "mode", "type": "hal.CounterMode"}], "tooltip": "Initializes a counter.\n\n:param in: mode the counter mode\n:param in: index the compressor index (output)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeCounter"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myCounterMode"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "portHandle", "type": "int"}, {"name": "input", "type": "int"}, {"name": "allocationLocation", "type": "str"}], "tooltip": "Creates a new instance of a digital port.\n\n:param in: portHandle the port handle to create from\n:param in: input true for input, false for output\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created digital handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeDIOPort"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "digitalSourceHandle", "type": "int"}, {"name": "triggerType", "type": "hal.AnalogTriggerType"}], "tooltip": "Initialize a DutyCycle input.\n\n:param in: digitalSourceHandle the digital source to use (either a\n HAL_DigitalHandle or a\n HAL_AnalogTriggerHandle)\n:param in: triggerType the analog trigger type of the source if it is\n an analog trigger\n:param out: status Error status variable. 0 on success.\n\n:returns: the created duty cycle handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeDutyCycle"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAnalogTriggerType"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "digitalSourceHandleA", "type": "int"}, {"name": "analogTriggerTypeA", "type": "hal.AnalogTriggerType"}, {"name": "digitalSourceHandleB", "type": "int"}, {"name": "analogTriggerTypeB", "type": "hal.AnalogTriggerType"}, {"name": "reverseDirection", "type": "int"}, {"name": "encodingType", "type": "hal.EncoderEncodingType"}], "tooltip": "Initializes an encoder.\n\n:param in: digitalSourceHandleA the A source (either a HAL_DigitalHandle or a\n HAL_AnalogTriggerHandle)\n:param in: analogTriggerTypeA the analog trigger type of the A source if it\n is an analog trigger\n:param in: digitalSourceHandleB the B source (either a HAL_DigitalHandle or a\n HAL_AnalogTriggerHandle)\n:param in: analogTriggerTypeB the analog trigger type of the B source if it\n is an analog trigger\n:param in: reverseDirection true to reverse the counting direction from\n standard, otherwise false\n:param in: encodingType the encoding type\n:param out: status Error status variable. 0 on success.\n\n:returns: the created encoder handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeEncoder"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAnalogTriggerType"}}}}, "ARG3": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAnalogTriggerType"}}}}, "ARG5": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myEncoderEncodingType"}}}}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.I2CPort"}], "tooltip": "Initializes the I2C port.\n\nOpens the port if necessary and saves the handle.\nIf opening the MXP port, also sets up the channel functions appropriately.\n\n:param in: port The port to open, 0 for the on-board, 1 for the MXP.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeI2C"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myI2CPort"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Initializes an interrupt.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: the created interrupt handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeInterrupts"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Initializes a notifier.\n\nA notifier is an FPGA controller timer that triggers at requested intervals\nbased on the FPGA time. This can be used to make precise control loops.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: the created notifier", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeNotifier"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "portHandle", "type": "int"}, {"name": "allocationLocation", "type": "str"}], "tooltip": "Initializes a PWM port.\n\n:param in: portHandle the port to initialize\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created pwm handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializePWMPort"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "moduleNumber", "type": "int"}, {"name": "type", "type": "hal.PowerDistributionType"}, {"name": "allocationLocation", "type": "str"}], "tooltip": "Initializes a Power Distribution Panel.\n\n:param in: moduleNumber the module number to initialize\n:param in: type the type of module to initialize\n:param in: allocationLocation the location where the allocation is occurring\n:param out: status Error status variable. 0 on success.\n\n:returns: the created PowerDistribution handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializePowerDistribution"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPowerDistributionType"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "module", "type": "int"}, {"name": "allocationLocation", "type": "str"}], "tooltip": "Initializes a PH.\n\n:param in: module the CAN ID to initialize\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created PH handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeREVPH"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "portHandle", "type": "int"}, {"name": "fwd", "type": "int"}, {"name": "allocationLocation", "type": "str"}], "tooltip": "Initializes a relay.\n\nNote this call will only initialize either the forward or reverse port of the\nrelay. If you need both, you will need to initialize 2 relays.\n\n:param in: portHandle the port handle to initialize\n:param in: fwd true for the forward port, false for the\n reverse port\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created relay handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeRelayPort"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}], "tooltip": "Initializes the SPI port. Opens the port if necessary and saves the handle.\n\nIf opening the MXP port, also sets up the channel functions appropriately.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS3, 4\n for MXP\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeSPI"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "port", "type": "hal.SerialPort"}], "tooltip": "Initializes a serial port.\n\nThe channels are either the onboard RS232, the MXP UART, or 2 USB ports. The\ntop port is USB1, the bottom port is USB2.\n\n:param in: port the serial port to initialize\n:param out: status the error code, or 0 for success\n\n:returns: Serial Port Handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeSerialPort"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySerialPort"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "port", "type": "hal.SerialPort"}, {"name": "portName", "type": "str"}], "tooltip": "Initializes a serial port with a direct name.\n\nThis name is the /dev name for a specific port.\nNote these are not always consistent between roboRIO reboots.\n\n:param in: port the serial port to initialize\n:param in: portName the dev port name\n:param out: status the error code, or 0 for success\n\n:returns: Serial Port Handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "initializeSerialPortDirect"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySerialPort"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Is the channel attached to an accumulator.\n\n:param in: analogPortHandle Handle to the analog port.\n:param out: status Error status variable. 0 on success.\n\n:returns: The analog channel is attached to an accumulator.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "isAccumulatorChannel"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [], "tooltip": "Checks if any DIO line is currently generating a pulse.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: true if a pulse on some line is in progress", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "isAnyPulsing"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "bool", "args": [{"name": "handle", "type": "int"}, {"name": "version", "type": "int"}], "tooltip": "Get if the version of the handle is correct.\n\nDo not use on the roboRIO, used specifically for the sim to handle resets.\n\n:param handle: the handle\n:param version: the handle version to check\n\n:returns: true if the handle is the right version, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "isHandleCorrectVersion"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "bool", "args": [{"name": "handle", "type": "int"}, {"name": "handleType", "type": "hal.HandleEnum"}], "tooltip": "Get if the handle is a specific type.\n\n:param handle: the handle\n:param handleType: the type to check\n\n:returns: true if the type is correct, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "isHandleType"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myHandleEnum"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "dioPortHandle", "type": "int"}], "tooltip": "Checks a DIO line to see if it is currently generating a pulse.\n\n:param in: dioPortHandle the digital port handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if a pulse is in progress, otherwise false", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "isPulsing"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmPortHandle", "type": "int"}], "tooltip": "Forces a PWM signal to go to 0 temporarily.\n\n:param in: pwmPortHandle the PWM handle.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "latchPWMZero"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Loads any extra halsim libraries provided in the HALSIM_EXTENSIONS\nenvironment variable.\n\n:returns: the success state of the initialization", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "loadExtensions"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "library", "type": "str"}], "tooltip": "Loads a single extension from a direct path.\n\nExpected to be called internally, not by users.\n\n:param library: the library path\n\n:returns: the success state of the initialization", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "loadOneExtension"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Sets the autonomous enabled flag in the DS.\n\nThis is used for the DS to ensure the robot is properly responding to its\nstate request. Ensure this gets called about every 50ms, or the robot will be\ndisabled by the DS.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "observeUserProgramAutonomous"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Sets the disabled flag in the DS.\n\nThis is used for the DS to ensure the robot is properly responding to its\nstate request. Ensure this gets called about every 50ms, or the robot will be\ndisabled by the DS.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "observeUserProgramDisabled"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Sets the program starting flag in the DS.\n\nThis is what changes the DS to showing robot code ready.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "observeUserProgramStarting"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Sets the teleoperated enabled flag in the DS.\n\nThis is used for the DS to ensure the robot is properly responding to its\nstate request. Ensure this gets called about every 50ms, or the robot will be\ndisabled by the DS.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "observeUserProgramTeleop"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Sets the test mode flag in the DS.\n\nThis is used for the DS to ensure the robot is properly responding to its\nstate request. Ensure this gets called about every 50ms, or the robot will be\ndisabled by the DS.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "observeUserProgramTest"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}], "tooltip": "Adds an event handle to be signalled when new data arrives.\n\n:param handle: the event handle to be signalled", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "provideNewDataEventHandle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "dioPortHandle", "type": "int"}, {"name": "pulseLengthSeconds", "type": "float"}], "tooltip": "Generates a single digital pulse.\n\nWrite a pulse to the specified digital output channel. There can only be a\nsingle pulse going at any time.\n\n:param in: dioPortHandle the digital port handle\n:param in: pulseLengthSeconds the active length of the pulse (in seconds)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "pulse"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "channelMask", "type": "int"}, {"name": "pulseLengthSeconds", "type": "float"}], "tooltip": "Generates a single digital pulse on multiple channels.\n\nWrite a pulse to the channels enabled by the mask. There can only be a\nsingle pulse going at any time.\n\n:param in: channelMask the channel mask\n:param in: pulseLengthSeconds the active length of the pulse (in seconds)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "pulseMultiple"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int, int]", "args": [{"name": "handle", "type": "int"}, {"name": "apiId", "type": "int"}, {"name": "data", "type": "Buffer"}], "tooltip": "Reads a CAN packet. The will continuously return the last packet received,\nwithout accounting for packet age.\n\n:param in: handle the CAN handle\n:param in: apiId the ID to read (0-1023)\n:param out: data the packet data (8 bytes)\n:param out: length the received length (0-8 bytes)\n:param out: receivedTimestamp the packet received timestamp in ms (based off\n of CLOCK_MONOTONIC)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "readCANPacketLatest"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int, int]", "args": [{"name": "handle", "type": "int"}, {"name": "apiId", "type": "int"}, {"name": "data", "type": "Buffer"}], "tooltip": "Reads a new CAN packet.\n\nThis will only return properly once per packet received. Multiple calls\nwithout receiving another packet will return an error code.\n\n:param in: handle the CAN handle\n:param in: apiId the ID to read (0-1023)\n:param out: data the packet data (8 bytes)\n:param out: length the received length (0-8 bytes)\n:param out: receivedTimestamp the packet received timestamp in ms (based off\n of CLOCK_MONOTONIC)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "readCANPacketNew"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int, int]", "args": [{"name": "handle", "type": "int"}, {"name": "apiId", "type": "int"}, {"name": "data", "type": "Buffer"}, {"name": "timeoutMs", "type": "int"}], "tooltip": "Reads a CAN packet. The will return the last packet received until the\npacket is older then the requested timeout. Then it will return an error\ncode.\n\n:param in: handle the CAN handle\n:param in: apiId the ID to read (0-1023)\n:param out: data the packet data (8 bytes)\n:param out: length the received length (0-8 bytes)\n:param out: receivedTimestamp the packet received timestamp in ms (based off\n of CLOCK_MONOTONIC)\n:param out: timeoutMs the timeout time for the packet\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "readCANPacketTimeout"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.I2CPort"}, {"name": "deviceAddress", "type": "int"}, {"name": "buffer", "type": "Buffer"}], "tooltip": "Executes a read transaction with the device.\n\nReads bytes from a device.\nMost I2C devices will auto-increment the register pointer internally allowing\nyou to read consecutive registers on a device in a single transaction.\n\n:param port: The I2C port, 0 for the on-board, 1 for the MXP.\n:param deviceAddress: The register to read first in the transaction.\n:param count: The number of bytes to read in the transaction.\n:param buffer: A pointer to the array of bytes to store the data read from the\n device.\n\n:returns: 0 on success or -1 on transfer abort.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "readI2C"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myI2CPort"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "interruptHandle", "type": "int"}], "tooltip": "Returns the timestamp for the falling interrupt that occurred most recently.\n\nThis is in the same time domain as HAL_GetFPGATime(). It only contains the\nbottom 32 bits of the timestamp. If your robot has been running for over 1\nhour, you will need to fill in the upper 32 bits yourself.\n\n:param in: interruptHandle the interrupt handle\n:param out: status Error status variable. 0 on success.\n\n:returns: timestamp in microseconds since FPGA Initialization", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "readInterruptFallingTimestamp"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "interruptHandle", "type": "int"}], "tooltip": "Returns the timestamp for the rising interrupt that occurred most recently.\n\nThis is in the same time domain as HAL_GetFPGATime(). It only contains the\nbottom 32 bits of the timestamp. If your robot has been running for over 1\nhour, you will need to fill in the upper 32 bits yourself.\n\n:param in: interruptHandle the interrupt handle\n:param out: status Error status variable. 0 on success.\n\n:returns: timestamp in microseconds since FPGA Initialization", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "readInterruptRisingTimestamp"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "buffer", "type": "Buffer"}], "tooltip": "Executes a read from the device.\n\nThis method does not write any data out to the device.\n\nMost spi devices will require a register address to be written before they\nbegin returning data.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP\n:param buffer: A pointer to the array of bytes to store the data read from the\n device.\n:param count: The number of bytes to read in the transaction. [1..7]\n\n:returns: Number of bytes read. -1 for error.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "readSPI"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "buffer", "type": "Buffer"}, {"name": "timeout", "type": "float"}], "tooltip": "Reads data received by the SPI accumulator. Each received data sequence\nconsists of a timestamp followed by the received data bytes, one byte per\nword (in the least significant byte). The length of each received data\nsequence is the same as the combined dataSize + zeroSize set in\nHAL_SetSPIAutoTransmitData.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2,\n 4 for MXP.\n:param out: buffer The buffer to store the data into.\n:param in: numToRead The number of words to read.\n:param in: timeout The read timeout (in seconds).\n:param out: status the error code, or 0 for success\n\n:returns: The number of words actually read.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "readSPIAutoReceivedData"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}, {"name": "buffer", "type": "Buffer"}], "tooltip": "Reads data from the serial port.\n\nWill wait for either timeout (if set), the termination char (if set), or the\ncount to be full. Whichever one comes first.\n\n:param in: handle the serial port handle\n:param out: buffer the buffer in which to store bytes read\n:param in: count the number of bytes maximum to read\n:param out: status the error code, or 0 for success\n\n:returns: the number of bytes actually read", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "readSerial"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Refresh the DS control word.\n\n:returns: true if updated", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "refreshDSData"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "interruptHandle", "type": "int"}], "tooltip": "Releases a waiting interrupt.\n\nThis will release both rising and falling waiters.\n\n:param in: interruptHandle the interrupt handle to release\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "releaseWaitingInterrupt"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}], "tooltip": "Removes the event handle from being signalled when new data arrives.\n\n:param handle: the event handle to remove", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "removeNewDataEventHandle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "resource", "type": "int"}, {"name": "instanceNumber", "type": "int"}, {"name": "context", "type": "int"}, {"name": "feature", "type": "str"}], "tooltip": "Reports a hardware usage to the HAL.\n\n:param resource: the used resource\n:param instanceNumber: the instance of the resource\n:param context: a user specified context index\n:param feature: a user specified feature string\n\n:returns: the index of the added value in NetComm", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "report"}, "inputs": {"ARG2": {"shadow": {"type": "math_number", "fields": {"NUM": 0.0}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "interruptHandle", "type": "int"}, {"name": "digitalSourceHandle", "type": "int"}, {"name": "analogTriggerType", "type": "hal.AnalogTriggerType"}], "tooltip": "Requests interrupts on a specific digital source.\n\n:param in: interruptHandle the interrupt handle\n:param in: digitalSourceHandle the digital source handle (either a\n HAL_AnalogTriggerHandle or a\n HAL_DigitalHandle)\n:param in: analogTriggerType the trigger type if the source is an\n AnalogTrigger\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "requestInterrupts"}, "inputs": {"ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAnalogTriggerType"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogPortHandle", "type": "int"}], "tooltip": "Resets the accumulator to the initial value.\n\n:param in: analogPortHandle Handle to the analog port.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "resetAccumulator"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Resets the analog gyro value to 0.\n\n:param in: handle the gyro handle\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "resetAnalogGyro"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Resets the Counter to zero.\n\nSets the counter value to zero. This does not effect the running state of the\ncounter, just sets the current value to zero.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "resetCounter"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "encoderHandle", "type": "int"}], "tooltip": "Reads the current encoder 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.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "resetEncoder"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Resets the PowerDistribution accumulated energy.\n\nNot supported on the Rev PDH and does nothing.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "resetPowerDistributionTotalEnergy"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [], "tooltip": "Resets the overcurrent fault counters for all user rails to 0.\n\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "resetUserCurrentFaults"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Runs the main function provided to HAL_SetMain().\n\nIf HAL_SetMain() has not been called, simply sleeps until HAL_ExitMain()\nis called.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "runMain"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "line", "type": "str"}], "tooltip": "Sends a line to the driver station console.\n\n:param line: the line to send (null terminated)\n\n:returns: the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "sendConsoleLine"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "isError", "type": "int"}, {"name": "errorCode", "type": "int"}, {"name": "isLVCode", "type": "int"}, {"name": "details", "type": "str"}, {"name": "location", "type": "str"}, {"name": "callStack", "type": "str"}, {"name": "printMsg", "type": "int"}], "tooltip": "Sends an error to the driver station.\n\n:param isError: true for error, false for warning\n:param errorCode: the error code\n:param isLVCode: true for a LV error code, false for a standard error code\n:param details: the details of the error\n:param location: the file location of the error\n:param callStack: the callstack of the error\n:param printMsg: true to print the error message to stdout as well as to the\n DS\n\n:returns: the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "sendError"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "active", "type": "int"}], "tooltip": "Sets the accelerometer to active or standby mode.\n\nIt must be in standby mode to change any configuration.\n\n:param active: true to set to active, false for standby", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAccelerometerActive"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "range", "type": "hal.AccelerometerRange"}], "tooltip": "Sets the range of values that can be measured (either 2, 4, or 8 g-forces).\n\nThe accelerometer should be in standby mode when this is called.\n\n:param range: the accelerometer range", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAccelerometerRange"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAccelerometerRange"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogPortHandle", "type": "int"}, {"name": "center", "type": "int"}], "tooltip": "Set the center value of the accumulator.\n\nThe center value is subtracted from each A/D 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.\n\nThis center value is based on the output of the oversampled and averaged\nsource from channel 1. Because of this, any non-zero oversample bits will\naffect the size of the value for this field.\n\n:param in: analogPortHandle Handle to the analog port.\n:param in: center The center value of the accumulator.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAccumulatorCenter"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogPortHandle", "type": "int"}, {"name": "deadband", "type": "int"}], "tooltip": "Set the accumulator's deadband.\n\n:param in: analogPortHandle Handle to the analog port.\n:param in: deadband The deadband of the accumulator.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAccumulatorDeadband"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "highTime0NanoSeconds", "type": "int"}, {"name": "lowTime0NanoSeconds", "type": "int"}, {"name": "highTime1NanoSeconds", "type": "int"}, {"name": "lowTime1NanoSeconds", "type": "int"}], "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 in: handle the Addressable LED handle\n:param in: highTime0NanoSeconds high time for 0 bit (default 400ns)\n:param in: lowTime0NanoSeconds low time for 0 bit (default 900ns)\n:param in: highTime1NanoSeconds high time for 1 bit (default 900ns)\n:param in: lowTime1NanoSeconds low time for 1 bit (default 600ns)\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAddressableLEDBitTiming"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "length", "type": "int"}], "tooltip": "Sets the length of the LED strip.\n\nThe max length is 5460 LEDs.\n\n:param in: handle the Addressable LED handle\n:param in: length the strip length\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAddressableLEDLength"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "outputPort", "type": "int"}], "tooltip": "Set the Addressable LED PWM Digital port.\n\n:param in: handle the Addressable LED handle\n:param in: outputPort The digital handle of the PWM port\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAddressableLEDOutputPort"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "syncTimeMicroSeconds", "type": "int"}], "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 in: handle the Addressable LED handle\n:param in: syncTimeMicroSeconds the sync time (default 280us)\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAddressableLEDSyncTime"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogPortHandle", "type": "int"}, {"name": "bits", "type": "int"}], "tooltip": "Sets the number of averaging bits.\n\nThis sets the number of averaging bits. The actual number of averaged samples\nis 2**bits. Use averaging to improve the stability of your measurement at the\nexpense of sampling rate. The averaging is done automatically in the FPGA.\n\n:param in: analogPortHandle Handle to the analog port to configure.\n:param in: bits Number of bits to average.\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogAverageBits"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "volts", "type": "float"}], "tooltip": "Sets the deadband of the analog gyro.\n\n:param in: handle the gyro handle\n:param in: volts the voltage deadband\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogGyroDeadband"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "voltsPerDegreePerSecond", "type": "float"}, {"name": "offset", "type": "float"}, {"name": "center", "type": "int"}], "tooltip": "Sets the analog gyro parameters to the specified values.\n\nThis is meant to be used if you want to reuse the values from a previous\ncalibration.\n\n:param in: handle the gyro handle\n:param in: voltsPerDegreePerSecond the gyro volts scaling\n:param in: offset the gyro offset\n:param in: center the gyro center\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogGyroParameters"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "voltsPerDegreePerSecond", "type": "float"}], "tooltip": "Sets the analog gyro volts per degrees per second scaling.\n\n:param in: handle the gyro handle\n:param in: voltsPerDegreePerSecond the gyro volts scaling\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogGyroVoltsPerDegreePerSecond"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}, {"name": "device", "type": "int"}], "tooltip": "Indicates the analog input is used by a simulated device.\n\n:param handle: the analog input handle\n:param device: simulated device handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogInputSimDevice"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogOutputHandle", "type": "int"}, {"name": "voltage", "type": "float"}], "tooltip": "Sets an analog output value.\n\n:param in: analogOutputHandle the analog output handle\n:param in: voltage the voltage (0-5v) to output\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogOutput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogPortHandle", "type": "int"}, {"name": "bits", "type": "int"}], "tooltip": "Sets 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 in: analogPortHandle Handle to the analog port to use.\n:param in: bits Number of bits to oversample.\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogOversampleBits"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "samplesPerSecond", "type": "float"}], "tooltip": "Sets the sample rate.\n\nThis is a global setting for the Athena and effects all channels.\n\n:param in: samplesPerSecond The number of samples per channel per second.\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogSampleRate"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogTriggerHandle", "type": "int"}, {"name": "useAveragedValue", "type": "int"}], "tooltip": "Configures 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\nThis is not allowed to be used if filtered mode is set.\nThis is not allowed to be used with Duty Cycle based inputs.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: useAveragedValue true to use averaged values, false for raw\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogTriggerAveraged"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogTriggerHandle", "type": "int"}, {"name": "useFilteredValue", "type": "int"}], "tooltip": "Configures the analog trigger to use a filtered value.\n\nThe analog trigger will operate with a 3 point average rejection filter. This\nis designed to help with 360 degree pot applications for the period where the\npot crosses through zero.\n\nThis is not allowed to be used if averaged mode is set.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: useFilteredValue true to use filtered values, false for average\n or raw\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogTriggerFiltered"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogTriggerHandle", "type": "int"}, {"name": "lower", "type": "float"}, {"name": "upper", "type": "float"}], "tooltip": "Sets the upper and lower limits of the analog trigger.\n\nThe limits are given as floating point duty cycle values.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: lower the lower duty cycle value\n:param in: upper the upper duty cycle value\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogTriggerLimitsDutyCycle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogTriggerHandle", "type": "int"}, {"name": "lower", "type": "int"}, {"name": "upper", "type": "int"}], "tooltip": "Sets the raw ADC upper and lower limits of the analog trigger.\n\nHAL_SetAnalogTriggerLimitsVoltage or HAL_SetAnalogTriggerLimitsDutyCycle\nis likely better in most cases.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: lower the lower ADC value\n:param in: upper the upper ADC value\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogTriggerLimitsRaw"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "analogTriggerHandle", "type": "int"}, {"name": "lower", "type": "float"}, {"name": "upper", "type": "float"}], "tooltip": "Sets the upper and lower limits of the analog trigger.\n\nThe limits are given as floating point voltage values.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: lower the lower voltage value\n:param in: upper the upper voltage value\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setAnalogTriggerLimitsVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "voltage", "type": "float"}], "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 in: voltage The brownout voltage\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setBrownoutVoltage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "enabled", "type": "int"}], "tooltip": "Enables the compressor closed loop control 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 that\nthe system is full.\n\n:param in: handle the PCM handle\n:param in: enabled true to enable closed loop control\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCTREPCMClosedLoopControl"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "index", "type": "int"}, {"name": "durMs", "type": "int"}], "tooltip": "Set the duration for a single solenoid shot.\n\n:param in: handle the PCM handle\n:param in: index solenoid index\n:param in: durMs shot duration in ms\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCTREPCMOneShotDuration"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "mask", "type": "int"}, {"name": "values", "type": "int"}], "tooltip": "Sets solenoids on a pneumatics module.\n\n:param in: handle the PCM handle\n:param in: mask Bitmask indicating which solenoids to set. The LSB represents\n solenoid 0.\n:param in: values Bitmask indicating the desired states of the solenoids. The\n LSB represents solenoid 0.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCTREPCMSolenoids"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "size", "type": "int"}], "tooltip": "Sets the average sample size of a counter.\n\n:param in: counterHandle the counter handle\n:param in: size the size of samples to average\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterAverageSize"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "digitalSourceHandle", "type": "int"}, {"name": "analogTriggerType", "type": "hal.AnalogTriggerType"}], "tooltip": "Sets the source object that causes the counter to count down.\n\n:param in: counterHandle the counter handle\n:param in: digitalSourceHandle the digital source handle (either a\n HAL_AnalogTriggerHandle or a\n HAL_DigitalHandle)\n:param in: analogTriggerType the analog trigger type if the source is an\n analog trigger\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterDownSource"}, "inputs": {"ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAnalogTriggerType"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "risingEdge", "type": "int"}, {"name": "fallingEdge", "type": "int"}], "tooltip": "Sets the down source to either detect rising edges or falling edges.\nNote that both are allowed to be set true at the same time without issues.\n\n:param in: counterHandle the counter handle\n:param in: risingEdge true to trigger on rising\n:param in: fallingEdge true to trigger on falling\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterDownSourceEdge"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Sets directional counting mode on this counter.\n\nThe direction is determined by the B input, with counting happening with the\nA input.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterExternalDirectionMode"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "maxPeriod", "type": "float"}], "tooltip": "Sets the maximum period where the device is still considered \"moving\".\n\nSets the maximum period where the device is considered moving. This value is\nused to determine the \"stopped\" state of the counter using the\nHAL_GetCounterStopped method.\n\n:param in: counterHandle the counter handle\n:param in: maxPeriod the maximum period where the counted device is\n considered moving in seconds\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterMaxPeriod"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "threshold", "type": "float"}], "tooltip": "Configures 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 in: counterHandle the counter handle\n:param in: threshold The pulse length beyond which the counter counts the\n opposite direction (seconds)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterPulseLengthMode"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "reverseDirection", "type": "int"}], "tooltip": "Sets the Counter to return reversed sensing on the direction.\n\nThis allows counters to change the direction they are counting in the case of\n1X and 2X quadrature encoding only. Any other counter mode isn't supported.\n\n:param in: counterHandle the counter handle\n:param in: reverseDirection true if the value counted should be negated.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterReverseDirection"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "samplesToAverage", "type": "int"}], "tooltip": "Sets 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 in: counterHandle the counter handle\n:param in: samplesToAverage The number of samples to average from 1 to 127\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterSamplesToAverage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "highSemiPeriod", "type": "int"}], "tooltip": "Sets Semi-period mode on this counter.\n\nThe counter counts up based on the time the input is triggered. High or Low\ndepends on the highSemiPeriod parameter.\n\n:param in: counterHandle the counter handle\n:param in: highSemiPeriod true for counting when the input is high, false for\n low\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterSemiPeriodMode"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}], "tooltip": "Sets standard up / down counting mode on this counter.\n\nUp and down counts are sourced independently from two inputs.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterUpDownMode"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "digitalSourceHandle", "type": "int"}, {"name": "analogTriggerType", "type": "hal.AnalogTriggerType"}], "tooltip": "Sets the source object that causes the counter to count up.\n\n:param in: counterHandle the counter handle\n:param in: digitalSourceHandle the digital source handle (either a\n HAL_AnalogTriggerHandle or a\n HAL_DigitalHandle)\n:param in: analogTriggerType the analog trigger type if the source is an\n analog trigger\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterUpSource"}, "inputs": {"ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAnalogTriggerType"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "risingEdge", "type": "int"}, {"name": "fallingEdge", "type": "int"}], "tooltip": "Sets the up source to either detect rising edges or falling edges.\n\nNote that both are allowed to be set true at the same time without issues.\n\n:param in: counterHandle the counter handle\n:param in: risingEdge true to trigger on rising\n:param in: fallingEdge true to trigger on falling\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterUpSourceEdge"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "counterHandle", "type": "int"}, {"name": "enabled", "type": "int"}], "tooltip": "Selects 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.\n\nIf you enable the update when empty, you will be\nnotified of the stopped source and the event time will report 0 samples.\n\nIf you disable update when empty, the most recent average will remain on the\noutput until a new sample is acquired.\n\nYou will never see 0 samples output (except when there have been no events\nsince an FPGA reset) and you will likely not see the stopped bit become true\n(since it is updated at the end of an average and there are no samples to\naverage).\n\n:param in: counterHandle the counter handle\n:param in: enabled true to enable counter updating with no samples\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCounterUpdateWhenEmpty"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "realTime", "type": "int"}, {"name": "priority", "type": "int"}], "tooltip": "Sets the thread priority for the current thread.\n\n:param in: realTime Set to true to set a real-time priority, false for\n standard priority.\n:param in: priority Priority to set the thread to. For real-time, this is\n 1-99 with 99 being highest. For non-real-time, this is\n forced to 0. See \"man 7 sched\" for more details.\n:param out: status Error status variable. 0 on success.\n\n:returns: True on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setCurrentThreadPriority"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "dioPortHandle", "type": "int"}, {"name": "value", "type": "int"}], "tooltip": "Writes a digital value to a DIO channel.\n\n:param in: dioPortHandle the digital port handle\n:param in: value the state to set the digital channel (if it is\n configured as an output)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setDIO"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "dioPortHandle", "type": "int"}, {"name": "input", "type": "int"}], "tooltip": "Sets the direction of a DIO channel.\n\n:param in: dioPortHandle the digital port handle\n:param in: input true to set input, false for output\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setDIODirection"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}, {"name": "device", "type": "int"}], "tooltip": "Indicates the DIO channel is used by a simulated device.\n\n:param handle: the DIO channel handle\n:param device: simulated device handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setDIOSimDevice"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmGenerator", "type": "int"}, {"name": "dutyCycle", "type": "float"}], "tooltip": "Configures the duty-cycle of the PWM generator.\n\n:param in: pwmGenerator the digital PWM handle\n:param in: dutyCycle the percent duty cycle to output [0..1]\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setDigitalPWMDutyCycle"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmGenerator", "type": "int"}, {"name": "channel", "type": "int"}], "tooltip": "Configures which DO channel the PWM signal is output on.\n\n:param in: pwmGenerator the digital PWM handle\n:param in: channel the channel to output on\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setDigitalPWMOutputChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmGenerator", "type": "int"}, {"name": "dutyCycle", "type": "float"}], "tooltip": "Configures the digital PWM to be a PPS signal with specified duty cycle.\n\n:param in: pwmGenerator the digital PWM handle\n:param in: dutyCycle the percent duty cycle to output [0..1]\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setDigitalPWMPPS"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "rate", "type": "float"}], "tooltip": "Changes the frequency of the DO PWM generator.\n\nThe valid range is from 0.6 Hz to 19 kHz.\n\nThe frequency resolution is logarithmic.\n\n:param in: rate the frequency to output all digital output PWM signals\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setDigitalPWMRate"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}, {"name": "device", "type": "int"}], "tooltip": "Indicates the duty cycle is used by a simulated device.\n\n:param handle: the duty cycle handle\n:param device: simulated device handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setDutyCycleSimDevice"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "encoderHandle", "type": "int"}, {"name": "distancePerPulse", "type": "float"}], "tooltip": "Sets the distance traveled per encoder pulse. This is used as a scaling\nfactor for the rate and distance calls.\n\n:param in: encoderHandle the encoder handle\n:param in: distancePerPulse the distance traveled per encoder pulse (units\n user defined)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setEncoderDistancePerPulse"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "encoderHandle", "type": "int"}, {"name": "digitalSourceHandle", "type": "int"}, {"name": "analogTriggerType", "type": "hal.AnalogTriggerType"}, {"name": "type", "type": "hal.EncoderIndexingType"}], "tooltip": "Sets the source for an index pulse on the encoder.\n\nThe index pulse can be used to cause an encoder to reset based on an external\ninput.\n\n:param in: encoderHandle the encoder handle\n:param in: digitalSourceHandle the index source handle (either a\n HAL_AnalogTriggerHandle or a\n HAL_DigitalHandle)\n:param in: analogTriggerType the analog trigger type if the source is an\n analog trigger\n:param in: type the index triggering type\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setEncoderIndexSource"}, "inputs": {"ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAnalogTriggerType"}}}}, "ARG3": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myEncoderIndexingType"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "encoderHandle", "type": "int"}, {"name": "maxPeriod", "type": "float"}], "tooltip": "Sets the maximum period where the device is still considered \"moving\".\n\nSets the maximum period where the device is considered moving. This value is\nused to determine the \"stopped\" state of the encoder using the\nHAL_GetEncoderStopped method.\n\n:param in: encoderHandle the encoder handle\n:param in: maxPeriod the maximum period where the counted device is\n considered moving in seconds\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setEncoderMaxPeriod"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "encoderHandle", "type": "int"}, {"name": "minRate", "type": "float"}], "tooltip": "Sets the minimum rate to be considered moving by the encoder.\n\nUnits need to match what is set by HAL_SetEncoderDistancePerPulse, with time\nas seconds.\n\n:param in: encoderHandle the encoder handle\n:param in: minRate the minimum rate to be considered moving (units are\n determined by the units passed to\n HAL_SetEncoderDistancePerPulse, time value is\n seconds)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setEncoderMinRate"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "encoderHandle", "type": "int"}, {"name": "reverseDirection", "type": "int"}], "tooltip": "Sets if to reverse the direction of the encoder.\n\nNote that this is not a toggle. It is an absolute set.\n\n:param in: encoderHandle the encoder handle\n:param in: reverseDirection true to reverse the direction, false to not.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setEncoderReverseDirection"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "encoderHandle", "type": "int"}, {"name": "samplesToAverage", "type": "int"}], "tooltip": "Sets the number of encoder samples to average when calculating encoder rate.\n\n:param in: encoderHandle the encoder handle\n:param in: samplesToAverage the number of samples to average\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setEncoderSamplesToAverage"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "handle", "type": "int"}, {"name": "device", "type": "int"}], "tooltip": "Indicates the encoder is used by a simulated device.\n\n:param handle: the encoder handle\n:param device: simulated device handle", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setEncoderSimDevice"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "filterIndex", "type": "int"}, {"name": "value", "type": "int"}], "tooltip": "Sets the filter period for the specified filter index.\n\nSets the filter period in FPGA cycles. Even though there are 2 different\nfilter index domains (MXP vs HDR), ignore that distinction for now since it\ncomplicates the interface. That can be changed later.\n\n:param in: filterIndex the filter index, 0 - 2\n:param in: value the number of cycles that the signal must not\n transition to be counted as a transition.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setFilterPeriod"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "dioPortHandle", "type": "int"}, {"name": "filterIndex", "type": "int"}], "tooltip": "Writes the filter index from the FPGA.\n\nSet the filter index used to filter out short pulses.\n\n:param in: dioPortHandle the digital port handle\n:param in: filterIndex the filter index (Must be in the range 0 - 3, where\n 0 means \"none\" and 1 - 3 means filter # filterIndex\n - 1)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setFilterSelect"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "interruptHandle", "type": "int"}, {"name": "risingEdge", "type": "int"}, {"name": "fallingEdge", "type": "int"}], "tooltip": "Sets the edges to trigger the interrupt on.\n\nNote that both edges triggered is a valid configuration.\n\n:param in: interruptHandle the interrupt handle\n:param in: risingEdge true for triggering on rising edge\n:param in: fallingEdge true for triggering on falling edge\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setInterruptUpSourceEdge"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "joystickNum", "type": "int"}, {"name": "outputs", "type": "int"}, {"name": "leftRumble", "type": "int"}, {"name": "rightRumble", "type": "int"}], "tooltip": "Set joystick outputs.\n\n:param joystickNum: the joystick number\n:param outputs: bitmask of outputs, 1 for on 0 for off\n:param leftRumble: the left rumble value (0-FFFF)\n:param rightRumble: the right rumble value (0-FFFF)\n\n:returns: the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setJoystickOutputs"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "notifierHandle", "type": "int"}, {"name": "name", "type": "str"}], "tooltip": "Sets the name of a notifier.\n\n:param in: notifierHandle the notifier handle\n:param in: name name\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setNotifierName"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "realTime", "type": "int"}, {"name": "priority", "type": "int"}], "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 in: realTime Set to true to set a real-time priority, false for\n standard priority.\n:param in: priority Priority to set the thread to. For real-time, this is\n 1-99 with 99 being highest. For non-real-time, this is\n forced to 0. See \"man 7 sched\" for more details.\n:param out: status Error status variable. 0 on success.\n\n:returns: True on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setNotifierThreadPriority"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmPortHandle", "type": "int"}], "tooltip": "Sets the PWM output to be a continuous high signal while enabled.\n\n:param in: pwmPortHandle the PWM handle.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setPWMAlwaysHighMode"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmPortHandle", "type": "int"}, {"name": "maxPwm", "type": "int"}, {"name": "deadbandMaxPwm", "type": "int"}, {"name": "centerPwm", "type": "int"}, {"name": "deadbandMinPwm", "type": "int"}, {"name": "minPwm", "type": "int"}], "tooltip": "Sets the configuration settings for the PWM channel.\n\nAll values are in microseconds.\n\n:param in: pwmPortHandle the PWM handle\n:param in: maxPwm the maximum PWM value\n:param in: deadbandMaxPwm the high range of the center deadband\n:param in: centerPwm the center PWM value\n:param in: deadbandMinPwm the low range of the center deadband\n:param in: minPwm the minimum PWM value\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setPWMConfigMicroseconds"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmPortHandle", "type": "int"}], "tooltip": "Sets a PWM channel to be disabled.\n\nThe channel is disabled until the next time it is set. Note this is different\nfrom just setting a 0 speed, as this will actively stop all signaling on the\nchannel.\n\n:param in: pwmPortHandle the PWM handle.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setPWMDisabled"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmPortHandle", "type": "int"}, {"name": "eliminateDeadband", "type": "int"}], "tooltip": "Sets if the FPGA should output the center value if the input value is within\nthe deadband.\n\n:param in: pwmPortHandle the PWM handle\n:param in: eliminateDeadband true to eliminate deadband, otherwise false\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setPWMEliminateDeadband"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmPortHandle", "type": "int"}, {"name": "squelchMask", "type": "int"}], "tooltip": "Sets how how often the PWM signal is squelched, thus scaling the period.\n\n:param in: pwmPortHandle the PWM handle.\n:param in: squelchMask the 2-bit mask of outputs to squelch\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setPWMPeriodScale"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmPortHandle", "type": "int"}, {"name": "position", "type": "float"}], "tooltip": "Sets a PWM channel to the desired position value.\n\nThe values range from 0 to 1 and the period is controlled by the PWM Period\nand MinHigh registers.\n\n:param in: pwmPortHandle the PWM handle\n:param in: position the positional PWM value to set\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setPWMPosition"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmPortHandle", "type": "int"}, {"name": "microsecondPulseTime", "type": "int"}], "tooltip": "Sets a PWM channel to the desired pulse width in microseconds.\n\n:param in: pwmPortHandle the PWM handle\n:param in: microsecondPulseTime the PWM value to set\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setPWMPulseTimeMicroseconds"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "pwmPortHandle", "type": "int"}, {"name": "speed", "type": "float"}], "tooltip": "Sets a PWM channel to the desired scaled value.\n\nThe values range from -1 to 1 and the period is controlled by the PWM Period\nand MinHigh registers.\n\n:param in: pwmPortHandle the PWM handle\n:param in: speed the scaled PWM value to set\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setPWMSpeed"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "enabled", "type": "int"}], "tooltip": "Power on/off switchable channel.\n\nThis is a REV PDH-specific function. This function will no-op on CTRE PDP.\n\n:param in: handle the module handle\n:param in: enabled true to turn on switchable channel\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setPowerDistributionSwitchableChannel"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "minAnalogVoltage", "type": "float"}, {"name": "maxAnalogVoltage", "type": "float"}], "tooltip": "Enables the compressor in analog mode. This mode uses an analog\npressure sensor connected to analog channel 0 to cycle the compressor. The\ncompressor will turn on when the pressure drops below minAnalogVoltage and\nwill turn off when the pressure reaches maxAnalogVoltage. This mode is only\nsupported by the REV PH with the REV Analog Pressure Sensor connected to\nanalog channel 0.\n\n:param in: handle the PH handle\n:param in: minAnalogVoltage The compressor will turn on when the analog\n pressure sensor voltage drops below this value\n:param in: maxAnalogVoltage The compressor will turn off when the analog\n pressure sensor reaches this value.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setREVPHClosedLoopControlAnalog"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Enables the compressor in digital mode using the digital pressure switch. The\ncompressor will turn on when the pressure switch indicates that the system is\nnot full, and will turn off when the pressure switch indicates that the\nsystem is full.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setREVPHClosedLoopControlDigital"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Disable Compressor.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setREVPHClosedLoopControlDisabled"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "minAnalogVoltage", "type": "float"}, {"name": "maxAnalogVoltage", "type": "float"}], "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 in: handle the PH handle\n:param in: minAnalogVoltage The compressor will turn on when the analog\n pressure sensor voltage drops below this value and the pressure switch\n indicates that the system is not full.\n:param in: maxAnalogVoltage The compressor will turn off when the analog\n pressure sensor reaches this value or the pressure switch is disconnected or\n indicates that the system is full.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setREVPHClosedLoopControlHybrid"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "config", "type": "hal.REVPHCompressorConfig"}], "tooltip": "Send compressor configuration to the PH.\n\n:param in: handle the PH handle\n:param in: config compressor configuration\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setREVPHCompressorConfig"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myREVPHCompressorConfig"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "mask", "type": "int"}, {"name": "values", "type": "int"}], "tooltip": "Sets solenoids on a PH.\n\n:param in: handle the PH handle\n:param in: mask Bitmask indicating which solenoids to set. The LSB represents\n solenoid 0.\n:param in: values Bitmask indicating the desired states of the solenoids. The\n LSB represents solenoid 0.\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setREVPHSolenoids"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "relayPortHandle", "type": "int"}, {"name": "on", "type": "int"}], "tooltip": "Sets the state of a relay output.\n\n:param in: relayPortHandle the relay handle\n:param in: on true for on, false for off\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setRelay"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "dataToSend", "type": "Buffer"}, {"name": "zeroSize", "type": "int"}], "tooltip": "Sets the data to be transmitted to the device to initiate a read.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2,\n 4 for MXP.\n:param in: dataToSend Pointer to the data to send (Gets copied for continue\n use, so no need to keep alive).\n:param in: dataSize The length of the data to send.\n:param in: zeroSize The number of zeros to send after the data.\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSPIAutoTransmitData"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}], "tooltip": "Sets the CS Active high for a SPI port.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSPIChipSelectActiveHigh"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}], "tooltip": "Sets the CS Active low for a SPI port.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSPIChipSelectActiveLow"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "handle", "type": "int"}], "tooltip": "Sets the stored handle for a SPI port.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP.\n:param handle: The value of the handle for the port.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSPIHandle"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "mode", "type": "hal.SPIMode"}], "tooltip": "Sets the SPI Mode.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP\n:param mode: The SPI mode to use", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSPIMode"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIMode"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "speed", "type": "int"}], "tooltip": "Sets the clock speed for the SPI bus.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP\n:param speed: The speed in Hz (500KHz-10MHz)", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSPISpeed"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "baud", "type": "int"}], "tooltip": "Sets the baud rate of a serial port.\n\nAny value between 0 and 0xFFFFFFFF may be used. Default is 9600.\n\n:param in: handle the serial port handle\n:param in: baud the baud rate to set\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSerialBaudRate"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "bits", "type": "int"}], "tooltip": "Sets the number of data bits on a serial port.\n\nDefaults to 8.\n\n:param in: handle the serial port handle\n:param in: bits the number of data bits (5-8)\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSerialDataBits"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "flow", "type": "int"}], "tooltip": "Sets the flow control mode of a serial port.\n\nValid values are:\n0: None (default)\n1: XON-XOFF\n2: RTS-CTS\n3: DTR-DSR\n\n:param in: handle the serial port handle\n:param in: flow the mode to set (see remarks for valid values)\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSerialFlowControl"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "parity", "type": "int"}], "tooltip": "Sets the number of parity bits on a serial port.\n\nValid values are:\n0: None (default)\n1: Odd\n2: Even\n3: Mark - Means exists and always 1\n4: Space - Means exists and always 0\n\n:param in: handle the serial port handle\n:param in: parity the parity bit mode (see remarks for valid values)\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSerialParity"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "size", "type": "int"}], "tooltip": "Sets the size of the read buffer.\n\n:param in: handle the serial port handle\n:param in: size the read buffer size\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSerialReadBufferSize"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "stopBits", "type": "int"}], "tooltip": "Sets the number of stop bits on a serial port.\n\nValid values are:\n10: One stop bit (default)\n15: One and a half stop bits\n20: Two stop bits\n\n:param in: handle the serial port handle\n:param in: stopBits the stop bit value (see remarks for valid values)\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSerialStopBits"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "timeout", "type": "float"}], "tooltip": "Sets the minimum serial read timeout of a port.\n\n:param in: handle the serial port handle\n:param in: timeout the timeout in milliseconds\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSerialTimeout"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "size", "type": "int"}], "tooltip": "Sets the size of the write buffer.\n\n:param in: handle the serial port handle\n:param in: size the write buffer size\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSerialWriteBufferSize"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "mode", "type": "int"}], "tooltip": "Sets the write mode on a serial port.\n\nValid values are:\n1: Flush on access\n2: Flush when full (default)\n\n:param in: handle the serial port handle\n:param in: mode the mode to set (see remarks for valid values)\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setSerialWriteMode"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "showMessage", "type": "int"}], "tooltip": "Enables or disables the message saying no HAL extensions were found.\n\nSome apps don't care, and the message create clutter. For general team code,\nwe want it.\n\nThis must be called before HAL_Initialize is called.\n\nThis defaults to true.\n\n:param showMessage: true to show message, false to not.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setShowExtensionsNotFoundMessages"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "enabled", "type": "int"}], "tooltip": "Enables or disables the 3V3 rail.\n\n:param enabled: whether the rail should be enabled\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setUserRailEnabled3V3"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "enabled", "type": "int"}], "tooltip": "Enables or disables the 5V rail.\n\n:param enabled: whether the rail should be enabled\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setUserRailEnabled5V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "enabled", "type": "int"}], "tooltip": "Enables or disables the 6V rail.\n\n:param enabled: whether the rail should be enabled\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setUserRailEnabled6V"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Sets up an analog gyro with the proper offsets and settings for the KOP\nanalog gyro.\n\n:param in: handle the gyro handle\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "setupAnalogGyro"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Call this to shut down HAL.\n\nThis must be called at termination of the robot program to avoid potential\nsegmentation faults with simulation extensions at exit.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "shutdown"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Calls registered SimPeriodic \"after\" callbacks (only in simulation mode).\nThis should be called after user code periodic simulation functions.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "simPeriodicAfter"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Calls registered SimPeriodic \"before\" callbacks (only in simulation mode).\nThis should be called prior to user code periodic simulation functions.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "simPeriodicBefore"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Starts the output.\n\nThe output writes continuously.\n\n:param in: handle the Addressable LED handle\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "startAddressableLEDOutput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "period", "type": "float"}], "tooltip": "Sets the period for automatic SPI accumulation.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP.\n:param in: period The accumulation period (seconds).\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "startSPIAutoRate"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "digitalSourceHandle", "type": "int"}, {"name": "analogTriggerType", "type": "hal.AnalogTriggerType"}, {"name": "triggerRising", "type": "int"}, {"name": "triggerFalling", "type": "int"}], "tooltip": "Starts the auto SPI accumulator on a specific trigger.\n\nNote that triggering on both rising and falling edges is a valid\nconfiguration.\n\n:param in: port The number of the port to use. 0-3 for Onboard\n CS0-CS2, 4 for MXP.\n:param in: digitalSourceHandle The trigger source to use (Either\n HAL_AnalogTriggerHandle or HAL_DigitalHandle).\n:param in: analogTriggerType The analog trigger type, if the source is an\n analog trigger.\n:param in: triggerRising Trigger on the rising edge if true.\n:param in: triggerFalling Trigger on the falling edge if true.\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "startSPIAutoTrigger"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}, "ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAnalogTriggerType"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}], "tooltip": "Stops the output.\n\n:param in: handle the Addressable LED handle\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "stopAddressableLEDOutput"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "apiId", "type": "int"}], "tooltip": "Stops a repeating packet with a specific ID.\n\nThis ID is 10 bits.\n\n:param in: handle the CAN handle\n:param in: apiId the ID to stop repeating (0-1023)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "stopCANPacketRepeating"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "notifierHandle", "type": "int"}], "tooltip": "Stops a notifier from running.\n\nThis will cause any call into HAL_WaitForNotifierAlarm to return with time =\n0.\n\n:param in: notifierHandle the notifier handle\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "stopNotifier"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}], "tooltip": "Stops an automatic SPI accumulation.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP.\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "stopSPIAuto"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.I2CPort"}, {"name": "deviceAddress", "type": "int"}, {"name": "dataToSend", "type": "Buffer"}, {"name": "dataReceived", "type": "Buffer"}], "tooltip": "Generic I2C read/write transaction.\n\nThis is a lower-level interface to the I2C hardware giving you more control\nover each transaction.\n\n:param port: The I2C port, 0 for the on-board, 1 for the MXP.\n:param deviceAddress: The address of the register on the device to be\n read/written.\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: 0 on success or -1 on transfer abort.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "transactionI2C"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myI2CPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "dataToSend", "type": "Buffer"}, {"name": "dataReceived", "type": "Buffer"}], "tooltip": "Performs an SPI send/receive transaction.\n\nThis is a lower-level interface to the spi hardware giving you more control\nover each transaction.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP\n:param dataToSend: Buffer of data to send as part of the transaction.\n:param dataReceived: Buffer to read data into.\n:param size: Number of bytes to transfer. [0..7]\n\n:returns: Number of bytes transferred, -1 for error", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "transactionSPI"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "notifierHandle", "type": "int"}, {"name": "triggerTime", "type": "int"}], "tooltip": "Updates the trigger time for a notifier.\n\nNote that this time is an absolute time relative to HAL_GetFPGATime()\n\n:param in: notifierHandle the notifier handle\n:param in: triggerTime the updated trigger time\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "updateNotifierAlarm"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "interruptHandle", "type": "int"}, {"name": "timeout", "type": "float"}, {"name": "ignorePrevious", "type": "int"}], "tooltip": "Waits for the defined interrupt to occur.\n\n:param in: interruptHandle the interrupt handle\n:param in: timeout timeout in seconds\n:param in: ignorePrevious if true, ignore interrupts that happened before\n waitForInterrupt was called\n:param out: status Error status variable. 0 on success.\n\n:returns: the mask of interrupts that fired", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "waitForInterrupt"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "interruptHandle", "type": "int"}, {"name": "mask", "type": "int"}, {"name": "timeout", "type": "float"}, {"name": "ignorePrevious", "type": "int"}], "tooltip": "Waits for any interrupt covered by the mask to occur.\n\n:param in: interruptHandle the interrupt handle to use for the context\n:param in: mask the mask of interrupts to wait for\n:param in: timeout timeout in seconds\n:param in: ignorePrevious if true, ignore interrupts that happened before\n waitForInterrupt was called\n:param out: status Error status variable. 0 on success.\n\n:returns: the mask of interrupts that fired", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "waitForMultipleInterrupts"}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "notifierHandle", "type": "int"}], "tooltip": "Waits for the next alarm for the specific notifier.\n\nThis is a blocking call until either the time elapses or HAL_StopNotifier\ngets called. If the latter occurs, this function will return zero and any\nloops using this function should exit. Failing to do so can lead to\nuse-after-frees.\n\n:param in: notifierHandle the notifier handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the FPGA time the notifier returned", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "waitForNotifierAlarm"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "data", "type": "hal.AddressableLEDData"}, {"name": "length", "type": "int"}], "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 in: handle the Addressable LED handle\n:param in: data the buffer to write\n:param in: length the strip length\n:param out: status the error code, or 0 for success", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "writeAddressableLEDData"}, "inputs": {"ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myAddressableLEDData"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "data", "type": "Buffer"}, {"name": "apiId", "type": "int"}], "tooltip": "Writes a packet to the CAN device with a specific ID.\n\nThis ID is 10 bits.\n\n:param in: handle the CAN handle\n:param in: data the data to write (0-8 bytes)\n:param in: length the length of data (0-8)\n:param in: apiId the ID to write (0-1023 bits)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "writeCANPacket"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "data", "type": "Buffer"}, {"name": "apiId", "type": "int"}, {"name": "repeatMs", "type": "int"}], "tooltip": "Writes a repeating packet to the CAN device with a specific ID.\n\nThis ID is 10 bits.\n\nThe RoboRIO will automatically repeat the packet at the specified interval\n\n:param in: handle the CAN handle\n:param in: data the data to write (0-8 bytes)\n:param in: length the length of data (0-8)\n:param in: apiId the ID to write (0-1023)\n:param in: repeatMs the period to repeat in ms\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "writeCANPacketRepeating"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "handle", "type": "int"}, {"name": "length", "type": "int"}, {"name": "apiId", "type": "int"}], "tooltip": "Writes an RTR frame of the specified length to the CAN device with the\nspecific ID.\n\nBy spec, the length must be equal to the length sent by the other device,\notherwise behavior is unspecified.\n\n:param in: handle the CAN handle\n:param in: length the length of data to request (0-8)\n:param in: apiId the ID to write (0-1023)\n:param out: status Error status variable. 0 on success.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "writeCANRTRFrame"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.I2CPort"}, {"name": "deviceAddress", "type": "int"}, {"name": "dataToSend", "type": "Buffer"}], "tooltip": "Executes a write transaction with the device.\n\nWrites a single byte to a register on a device and wait until the\ntransaction is complete.\n\n:param port: The I2C port, 0 for the on-board, 1 for the MXP.\n:param deviceAddress: The address of the register on the device to be\n written.\n:param dataToSend: The byte to write to the register on the device.\n:param sendSize: Number of bytes to send.\n\n:returns: 0 on success or -1 on transfer abort.", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "writeI2C"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myI2CPort"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "port", "type": "hal.SPIPort"}, {"name": "dataToSend", "type": "Buffer"}], "tooltip": "Executes a write transaction with the device.\n\nWrites to a device and wait until the transaction is complete.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP\n:param dataToSend: The data to write to the register on the device.\n:param sendSize: The number of bytes to be written\n\n:returns: The number of bytes written. -1 for an error", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "writeSPI"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "mySPIPort"}}}}}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, int]", "args": [{"name": "handle", "type": "int"}, {"name": "buffer", "type": "Buffer"}], "tooltip": "Writes data to the serial port.\n\n:param in: handle the serial port handle\n:param in: buffer the buffer to write\n:param in: count the number of bytes to write from the buffer\n:param out: status the error code, or 0 for success\n\n:returns: the number of bytes actually written", "importModule": "hal"}, "fields": {"MODULE_OR_CLASS": "hal", "FUNC": "writeSerial"}}}}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AccelerometerRange", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AccelerometerRange", "ENUM_VALUE": "k2G"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AccelerometerRange", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AccelerometerRange", "ENUM_VALUE": "k4G"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AccelerometerRange", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AccelerometerRange", "ENUM_VALUE": "k8G"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AllianceStationID", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AllianceStationID", "ENUM_VALUE": "kBlue1"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AllianceStationID", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AllianceStationID", "ENUM_VALUE": "kBlue2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AllianceStationID", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AllianceStationID", "ENUM_VALUE": "kBlue3"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AllianceStationID", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AllianceStationID", "ENUM_VALUE": "kRed1"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AllianceStationID", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AllianceStationID", "ENUM_VALUE": "kRed2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AllianceStationID", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AllianceStationID", "ENUM_VALUE": "kRed3"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AllianceStationID", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AllianceStationID", "ENUM_VALUE": "kUnknown"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AnalogTriggerType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AnalogTriggerType", "ENUM_VALUE": "kFallingPulse"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AnalogTriggerType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AnalogTriggerType", "ENUM_VALUE": "kInWindow"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AnalogTriggerType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AnalogTriggerType", "ENUM_VALUE": "kRisingPulse"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.AnalogTriggerType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.AnalogTriggerType", "ENUM_VALUE": "kState"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kAccelerometer"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kBroadcast"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kFirmwareUpdate"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kGearToothSensor"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kGyroSensor"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kIOBreakout"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kMiscellaneous"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kMotorController"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kPneumatics"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kPowerDistribution"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kRelayController"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kRobotController"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kServoController"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANDeviceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANDeviceType", "ENUM_VALUE": "kUltrasonicSensor"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kAndyMark"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kBroadcast"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kCTRE"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kCopperforge"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kDEKA"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kGrapple"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kKauaiLabs"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kLM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kMS"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kNI"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kPWF"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kREV"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kReduxRobotics"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kStudica"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kTeamUse"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kTheThriftyBot"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CANManufacturer", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CANManufacturer", "ENUM_VALUE": "kVividHosting"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CounterMode", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CounterMode", "ENUM_VALUE": "kExternalDirection"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CounterMode", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CounterMode", "ENUM_VALUE": "kPulseLength"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CounterMode", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CounterMode", "ENUM_VALUE": "kSemiperiod"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.CounterMode", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.CounterMode", "ENUM_VALUE": "kTwoPulse"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.EncoderEncodingType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.EncoderEncodingType", "ENUM_VALUE": "Encoder_k1X"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.EncoderEncodingType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.EncoderEncodingType", "ENUM_VALUE": "Encoder_k2X"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.EncoderEncodingType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.EncoderEncodingType", "ENUM_VALUE": "Encoder_k4X"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.EncoderIndexingType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.EncoderIndexingType", "ENUM_VALUE": "kResetOnFallingEdge"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.EncoderIndexingType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.EncoderIndexingType", "ENUM_VALUE": "kResetOnRisingEdge"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.EncoderIndexingType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.EncoderIndexingType", "ENUM_VALUE": "kResetWhileHigh"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.EncoderIndexingType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.EncoderIndexingType", "ENUM_VALUE": "kResetWhileLow"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HAL_RadioLEDState", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HAL_RadioLEDState", "ENUM_VALUE": "HAL_RadioLED_kGreen"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HAL_RadioLEDState", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HAL_RadioLEDState", "ENUM_VALUE": "HAL_RadioLED_kOff"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HAL_RadioLEDState", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HAL_RadioLEDState", "ENUM_VALUE": "HAL_RadioLED_kOrange"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HAL_RadioLEDState", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HAL_RadioLEDState", "ENUM_VALUE": "HAL_RadioLED_kRed"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "AddressableLED"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "AnalogGyro"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "AnalogInput"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "AnalogOutput"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "AnalogTrigger"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "CAN"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "CTREPCM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "CTREPDP"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "Compressor"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "Counter"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "DIO"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "DMA"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "DigitalPWM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "DutyCycle"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "Encoder"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "FPGAEncoder"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "Interrupt"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "Notifier"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "PWM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "Port"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "REVPDH"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "REVPH"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "Relay"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "SerialPort"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "SimulationJni"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "Solenoid"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "Undefined"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.HandleEnum", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.HandleEnum", "ENUM_VALUE": "Vendor"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.I2CPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.I2CPort", "ENUM_VALUE": "kInvalid"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.I2CPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.I2CPort", "ENUM_VALUE": "kMXP"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.I2CPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.I2CPort", "ENUM_VALUE": "kOnboard"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.MatchType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.MatchType", "ENUM_VALUE": "elimination"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.MatchType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.MatchType", "ENUM_VALUE": "none"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.MatchType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.MatchType", "ENUM_VALUE": "practice"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.MatchType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.MatchType", "ENUM_VALUE": "qualification"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.PowerDistributionType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.PowerDistributionType", "ENUM_VALUE": "kAutomatic"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.PowerDistributionType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.PowerDistributionType", "ENUM_VALUE": "kCTRE"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.PowerDistributionType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.PowerDistributionType", "ENUM_VALUE": "kRev"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.REVPHCompressorConfigType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.REVPHCompressorConfigType", "ENUM_VALUE": "kAnalog"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.REVPHCompressorConfigType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.REVPHCompressorConfigType", "ENUM_VALUE": "kDigital"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.REVPHCompressorConfigType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.REVPHCompressorConfigType", "ENUM_VALUE": "kDisabled"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.REVPHCompressorConfigType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.REVPHCompressorConfigType", "ENUM_VALUE": "kHybrid"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.RuntimeType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.RuntimeType", "ENUM_VALUE": "HAL_Runtime_RoboRIO"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.RuntimeType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.RuntimeType", "ENUM_VALUE": "HAL_Runtime_RoboRIO2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.RuntimeType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.RuntimeType", "ENUM_VALUE": "HAL_Runtime_Simulation"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SPIMode", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SPIMode", "ENUM_VALUE": "kMode0"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SPIMode", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SPIMode", "ENUM_VALUE": "kMode1"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SPIMode", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SPIMode", "ENUM_VALUE": "kMode2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SPIMode", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SPIMode", "ENUM_VALUE": "kMode3"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SPIPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SPIPort", "ENUM_VALUE": "kInvalid"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SPIPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SPIPort", "ENUM_VALUE": "kMXP"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SPIPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SPIPort", "ENUM_VALUE": "kOnboardCS0"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SPIPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SPIPort", "ENUM_VALUE": "kOnboardCS1"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SPIPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SPIPort", "ENUM_VALUE": "kOnboardCS2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SPIPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SPIPort", "ENUM_VALUE": "kOnboardCS3"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SerialPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SerialPort", "ENUM_VALUE": "MXP"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SerialPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SerialPort", "ENUM_VALUE": "Onboard"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SerialPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SerialPort", "ENUM_VALUE": "USB1"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SerialPort", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SerialPort", "ENUM_VALUE": "USB2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SimValueDirection", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SimValueDirection", "ENUM_VALUE": "HAL_SimValueBidir"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SimValueDirection", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SimValueDirection", "ENUM_VALUE": "HAL_SimValueInput"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.SimValueDirection", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.SimValueDirection", "ENUM_VALUE": "HAL_SimValueOutput"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.Type", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.Type", "ENUM_VALUE": "BOOLEAN"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.Type", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.Type", "ENUM_VALUE": "DOUBLE"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.Type", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.Type", "ENUM_VALUE": "ENUM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.Type", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.Type", "ENUM_VALUE": "INT"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.Type", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.Type", "ENUM_VALUE": "LONG"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.Type", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.Type", "ENUM_VALUE": "UNASSIGNED"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kADXL345_I2C"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kADXL345_SPI"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kCANPlugin_2CAN"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kCANPlugin_BlackJagBridge"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kCommand2_Scheduler"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kCommand_Scheduler"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDashboard_AdvantageScope"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDashboard_Elastic"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDashboard_FRCWebComponents"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDashboard_Glass"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDashboard_LabVIEW"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDashboard_QFRCDashboard"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDashboard_Shuffleboard"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDashboard_SmartDashboard"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDashboard_Unknown"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDataLogLocation_Onboard"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDataLogLocation_USB"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationCIO_Analog"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationCIO_DigitalIn"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationCIO_DigitalOut"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_Acceleration"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_AnalogIn"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_AnalogOut"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_Button"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_DigitalIn"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_DigitalOut"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_Encoder"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_FixedDigitalOut"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_LED"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_PWM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kDriverStationEIO_TouchSlider"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kFramework_AdvantageKit"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kFramework_CommandControl"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kFramework_Iterative"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kFramework_MagicBot"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kFramework_ROS"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kFramework_RobotBuilder"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kFramework_Simple"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kFramework_Timed"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kKinematics_DifferentialDrive"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kKinematics_MecanumDrive"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kKinematics_SwerveDrive"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLanguage_CPlusPlus"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLanguage_DotNet"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLanguage_Java"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLanguage_Kotlin"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLanguage_LabVIEW"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLanguage_Python"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLanguage_Rust"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLoggingFramework_AdvantageKit"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLoggingFramework_DogLog"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLoggingFramework_Epilogue"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLoggingFramework_Monologue"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kLoggingFramework_Other"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kOdometry_DifferentialDrive"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kOdometry_MecanumDrive"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kOdometry_SwerveDrive"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kPDP_CTRE"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kPDP_REV"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kPDP_Unknown"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive2_DifferentialArcade"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive2_DifferentialCurvature"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive2_DifferentialTank"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive2_KilloughCartesian"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive2_KilloughPolar"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive2_MecanumCartesian"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive2_MecanumPolar"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDriveSwerve_AdvantageKit"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDriveSwerve_CTRE"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDriveSwerve_MaxSwerve"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDriveSwerve_Other"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDriveSwerve_YAGSL"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive_ArcadeButtonSpin"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive_ArcadeRatioCurve"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive_ArcadeStandard"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive_MecanumCartesian"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive_MecanumPolar"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kRobotDrive_Tank"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kSmartDashboard_Instance"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tInstances", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tInstances", "ENUM_VALUE": "kSmartDashboard_LiveWindow"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ADIS16448"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ADIS16470"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ADXL345"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ADXL362"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ADXRS450"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Accelerometer"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_AddressableLEDs"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_AnalogChannel"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_AnalogOutput"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_AnalogTrigger"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_AnalogTriggerOutput"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_AxisCamera"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_BangBangController"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Button"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CAN"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CANJaguar"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CANPlugin"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CANTalonSRX"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CANifier"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future1"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future10"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future11"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future12"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future13"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future14"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future3"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future4"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future5"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future6"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future7"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future8"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_CTRE_future9"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ChoreoTrajectory"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ChoreoTrigger"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Command"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Compressor"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Controller"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Counter"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Dashboard"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_DataLogManager"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_DigilentDMC60"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_DigitalGlitchFilter"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_DigitalInput"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_DigitalOutput"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_DriverStationCIO"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_DriverStationEIO"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_DriverStationLCD"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_DutyCycle"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Encoder"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ExponentialProfile"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Framework"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_FusionVenom"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_GearTooth"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Gyro"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_HiTechnicAccel"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_HiTechnicColorSensor"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_HiTechnicCompass"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_I2C"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Jaguar"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Joystick"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Kinect"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_KinectStick"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Kinematics"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Koors40"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Language"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_LaserShark"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_LinearFilter"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_LoggingFramework"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_MindsensorsSD540"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Module"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_NavX"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_NidecBrushless"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Odometry"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PCM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PCVideoServer"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PDP"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PIDController"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PIDController2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PS4Controller"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PWFSEN36005"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PWM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PWMTalonSRX"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PWMVictorSPX"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PathFindingCommand"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PathPlannerAuto"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PathPlannerPath"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PathWeaverTrajectory"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PhotonCamera"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PhotonPoseEstimator"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_PigeonIMU"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Pixy"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Pixy2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Preferences"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ProfiledPIDController"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Redux_future1"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Redux_future2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Redux_future3"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Redux_future4"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Redux_future5"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Relay"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_RevSPARK"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_RevServoHub"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_RevSparkFlexCAN"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_RevSparkFlexPWM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_RevSparkMaxCAN"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_RevSparkMaxPWM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_RobotDrive"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_SPI"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_SRF08"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ScanseSweep"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_SerialPort"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Servo"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Shuffleboard"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_SmartDashboard"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Solenoid"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Talon"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_TalonFX"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Task"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_ThriftyNova"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_TrapezoidProfile"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Ultrasonic"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Units"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_UsbCamera"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_Victor"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_VictorSP"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "hal.tResourceType", "importModule": "hal"}, "fields": {"ENUM_TYPE": "hal.tResourceType", "ENUM_VALUE": "kResourceType_XboxController"}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "hal",
- contents: contents,
- moduleName: "hal",
- packageName: "hal",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpilib.cameraserver.ts b/src/blocks/generated/module_wpilib.cameraserver.ts
deleted file mode 100644
index 186acf65..00000000
--- a/src/blocks/generated/module_wpilib.cameraserver.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpilib.cameraserver
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "cameraserver",
- contents: contents,
- moduleName: "wpilib.cameraserver",
- packageName: "wpilib",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpilib.counter.ts b/src/blocks/generated/module_wpilib.counter.ts
deleted file mode 100644
index b6f8ba87..00000000
--- a/src/blocks/generated/module_wpilib.counter.ts
+++ /dev/null
@@ -1,33 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as pythonEnum from "../mrc_get_python_enum_value";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpilib.counter
-
-export function initialize() {
- pythonEnum.initializeEnum("wpilib.counter.EdgeConfiguration", ["kBoth", "kFallingEdge", "kNone", "kRisingEdge"], "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.");
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 4 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.counter.EdgeConfiguration", "importModule": "wpilib.counter"}, "fields": {"ENUM_TYPE": "wpilib.counter.EdgeConfiguration", "ENUM_VALUE": "kBoth"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.counter.EdgeConfiguration", "importModule": "wpilib.counter"}, "fields": {"ENUM_TYPE": "wpilib.counter.EdgeConfiguration", "ENUM_VALUE": "kFallingEdge"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.counter.EdgeConfiguration", "importModule": "wpilib.counter"}, "fields": {"ENUM_TYPE": "wpilib.counter.EdgeConfiguration", "ENUM_VALUE": "kNone"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.counter.EdgeConfiguration", "importModule": "wpilib.counter"}, "fields": {"ENUM_TYPE": "wpilib.counter.EdgeConfiguration", "ENUM_VALUE": "kRisingEdge"}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "counter",
- contents: contents,
- moduleName: "wpilib.counter",
- packageName: "wpilib.counter",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpilib.drive.ts b/src/blocks/generated/module_wpilib.drive.ts
deleted file mode 100644
index 8a0eeaa8..00000000
--- a/src/blocks/generated/module_wpilib.drive.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpilib.drive
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "drive",
- contents: contents,
- moduleName: "wpilib.drive",
- packageName: "wpilib.drive",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpilib.event.ts b/src/blocks/generated/module_wpilib.event.ts
deleted file mode 100644
index 4f91d78f..00000000
--- a/src/blocks/generated/module_wpilib.event.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpilib.event
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "event",
- contents: contents,
- moduleName: "wpilib.event",
- packageName: "wpilib.event",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpilib.interfaces.ts b/src/blocks/generated/module_wpilib.interfaces.ts
deleted file mode 100644
index 34d418b6..00000000
--- a/src/blocks/generated/module_wpilib.interfaces.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpilib.interfaces
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "interfaces",
- contents: contents,
- moduleName: "wpilib.interfaces",
- packageName: "wpilib.interfaces",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpilib.shuffleboard.ts b/src/blocks/generated/module_wpilib.shuffleboard.ts
deleted file mode 100644
index e4dff08c..00000000
--- a/src/blocks/generated/module_wpilib.shuffleboard.ts
+++ /dev/null
@@ -1,64 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as pythonEnum from "../mrc_get_python_enum_value";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpilib.shuffleboard
-
-export function initialize() {
- pythonEnum.initializeEnum("wpilib.shuffleboard.BuiltInLayouts", ["kGrid", "kList"], "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| Name | Type | Default Value | Notes |
|---|
\n| Label position | String | \"BOTTOM\" | \nThe position of component labels inside the grid. One of\n``[\"TOP\", \"LEFT\", \"BOTTOM\", \"RIGHT\", \"HIDDEN\"`` |
\n
\n\n kGrid : Groups components in an *n* x *m* grid. Grid layouts default to\n3x3. \nCustom properties: \n| Name | Type | Default Value | Notes |
|---|
\n| Number of columns | Number | 3 | Must be in the\nrange [1,15] | \n
\n| Number of rows | Number | 3 | Must be in the\nrange [1,15] |
| Label position | String | \n\"BOTTOM\" | \nThe position of component labels inside the grid.\nOne of ``[\"TOP\", \"LEFT\", \"BOTTOM\", \"RIGHT\", \"HIDDEN\"`` | \n
\n
");
- pythonEnum.initializeEnum("wpilib.shuffleboard.BuiltInWidgets", ["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"], "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| Name | Type | Default Value | Notes |
|---|
\n| Min | Number | -1.0 | The minimum value of the\nslider |
| Max | Number | 1.0 | The maximum\nvalue of the slider |
| Block\nincrement | Number | 0.0625 | How much to move the\nslider by with the arrow keys |
\n
\n\n kNumberBar : Displays a number with a view-only bar.\nSupported types:\n\n- Number\n\nCustom properties:\n\n| Name | Type | Default Value | Notes |
|---|
\n| Min | Number | -1.0 | The minimum value of the\nbar |
| Max | Number | 1.0 | The maximum\nvalue of the bar |
\n| Center | Number | 0 | The center (\"zero\") value\nof the bar |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Min | Number | 0 | The minimum value of the\ndial |
| Max | Number | 100 | The maximum\nvalue of the dial |
| Show\nvalue | Boolean | true | Whether or not to show the\nvalue as text |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Visible time | Number | 30 | \nHow long, in seconds, should past data be visible for |
\n
\n\n kBooleanBox : Displays a boolean value as a large colored box.\nSupported types:\n\n- Boolean\n\nCustom properties:\n\n| Name | Type | Default Value | Notes |
|---|
\n| Color when true | Color | \"green\" | \nCan be specified as a string (``\"#00FF00\"``) or a rgba integer\n(``0x00FF0000``)\n |
\n| Color when false | Color | \"red\" | \nCan be specified as a string or a number |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Min | Number | 0 | The minimum value of the\nbar |
| Max | Number | 5 | The maximum\nvalue of the bar |
\n| Center | Number | 0 | The center (\"zero\") value\nof the bar |
\n| Orientation | String | \"HORIZONTAL\" | \nThe orientation of the bar. One of {@code [\"HORIZONTAL\",\n\"VERTICAL\"]} |
| Number of tick\nmarks | Number | 5 | The number of discrete ticks on the\nbar |
\n
\n\n kPowerDistribution : Displays a PowerDistribution. \nSupported types: -\nPowerDistribution\n\nCustom properties:\n\n| Name | Type | Default Value | Notes |
|---|
\n| Show voltage and current values | Boolean | true | \nWhether or not to display the voltage and current draw |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Orientation | String | \"HORIZONTAL\" | \nOne of ``[\"HORIZONTAL\", \"VERTICAL\"]`` |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Min | Number | -1 | \nThe minimum acceleration value to display |
\n| Max | Number | 1 | \nThe maximum acceleration value to display |
\n| Show text | Boolean | true | \nShow or hide the acceleration values |
\n| Precision | Number | 2 | \nHow many numbers to display after the decimal point |
\n| Show tick marks | Boolean | false | \nShow or hide the tick marks on the number bars |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Range | Range | k16G | The accelerometer\nrange |
| Show value | Boolean | true | \nShow or hide the acceleration values |
\n| Precision | Number | 2 | \nHow many numbers to display after the decimal point |
\n| Show tick marks | Boolean | false | \nShow or hide the tick marks on the number bars |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Major tick\nspacing | Number | 45 | Degrees |
\n| Starting angle | Number | 180 | \nHow far to rotate the entire dial, in degrees |
\n| Show tick mark ring | Boolean | true |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Number of wheels | Number | 4 | Must be a\npositive even integer\n |
\n| Wheel diameter | Number | 80 | Pixels |
\n| Show velocity vectors | Boolean | true |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Show velocity vectors | Boolean | true |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Show crosshair | Boolean | true | \nShow or hide a crosshair on the image |
\n| Crosshair color | Color | \"white\" | \nCan be a string or a rgba integer |
\n| Show controls | Boolean | true | Show or hide the\nstream controls\n |
\n| Rotation | String | \"NONE\" | \nRotates the displayed image. One of {@code [\"NONE\", \"QUARTER_CW\",\n\"QUARTER_CCW\", \"HALF\"]}\n |
\n
\n\n kField : Displays a field2d object.\nSupported types:\n\n- Field2d");
- pythonEnum.initializeEnum("wpilib.shuffleboard.ShuffleboardEventImportance", ["kCritical", "kHigh", "kLow", "kNormal", "kTrivial"], "Members:\n\n kTrivial\n\n kLow\n\n kNormal\n\n kHigh\n\n kCritical");
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 33 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "str", "args": [{"name": "importance", "type": "wpilib.shuffleboard.ShuffleboardEventImportance"}], "tooltip": "Returns name of the given enum.\n\n:returns: Name of the given enum.", "importModule": "wpilib.shuffleboard"}, "fields": {"MODULE_OR_CLASS": "wpilib.shuffleboard", "FUNC": "shuffleboardEventImportanceName"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myShuffleboardEventImportance"}}}}}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInLayouts", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInLayouts", "ENUM_VALUE": "kGrid"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInLayouts", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInLayouts", "ENUM_VALUE": "kList"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "k3AxisAccelerometer"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kAccelerometer"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kBooleanBox"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kCameraStream"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kComboBoxChooser"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kCommand"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kDial"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kDifferentialDrive"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kEncoder"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kField"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kGraph"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kGyro"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kMecanumDrive"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kMotorController"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kNumberBar"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kNumberSlider"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kPIDCommand"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kPIDController"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kPowerDistribution"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kRelay"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kSplitButtonChooser"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kTextView"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kToggleButton"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kToggleSwitch"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.BuiltInWidgets", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.BuiltInWidgets", "ENUM_VALUE": "kVoltageView"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.ShuffleboardEventImportance", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.ShuffleboardEventImportance", "ENUM_VALUE": "kCritical"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.ShuffleboardEventImportance", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.ShuffleboardEventImportance", "ENUM_VALUE": "kHigh"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.ShuffleboardEventImportance", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.ShuffleboardEventImportance", "ENUM_VALUE": "kLow"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.ShuffleboardEventImportance", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.ShuffleboardEventImportance", "ENUM_VALUE": "kNormal"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.shuffleboard.ShuffleboardEventImportance", "importModule": "wpilib.shuffleboard"}, "fields": {"ENUM_TYPE": "wpilib.shuffleboard.ShuffleboardEventImportance", "ENUM_VALUE": "kTrivial"}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "shuffleboard",
- contents: contents,
- moduleName: "wpilib.shuffleboard",
- packageName: "wpilib.shuffleboard",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpilib.simulation.ts b/src/blocks/generated/module_wpilib.simulation.ts
deleted file mode 100644
index c7946de5..00000000
--- a/src/blocks/generated/module_wpilib.simulation.ts
+++ /dev/null
@@ -1,37 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpilib.simulation
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 10 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "bool", "args": [], "tooltip": "", "importModule": "wpilib.simulation"}, "fields": {"MODULE_OR_CLASS": "wpilib.simulation", "FUNC": "getProgramStarted"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "bool", "args": [], "tooltip": "Check if the simulator time is paused.\n\n:returns: true if paused", "importModule": "wpilib.simulation"}, "fields": {"MODULE_OR_CLASS": "wpilib.simulation", "FUNC": "isTimingPaused"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Pause the simulator time.", "importModule": "wpilib.simulation"}, "fields": {"MODULE_OR_CLASS": "wpilib.simulation", "FUNC": "pauseTiming"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Restart the simulator time.", "importModule": "wpilib.simulation"}, "fields": {"MODULE_OR_CLASS": "wpilib.simulation", "FUNC": "restartTiming"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "Resume the simulator time.", "importModule": "wpilib.simulation"}, "fields": {"MODULE_OR_CLASS": "wpilib.simulation", "FUNC": "resumeTiming"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "wpilib.simulation"}, "fields": {"MODULE_OR_CLASS": "wpilib.simulation", "FUNC": "setProgramStarted"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "type", "type": "hal.RuntimeType"}], "tooltip": "Override the HAL runtime type (simulated/real).\n\n:param type: runtime type", "importModule": "wpilib.simulation"}, "fields": {"MODULE_OR_CLASS": "wpilib.simulation", "FUNC": "setRuntimeType"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myRuntimeType"}}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "delta", "type": "wpimath.units.seconds"}], "tooltip": "Advance the simulator time and wait for all notifiers to run.\n\n:param delta: the amount to advance (in seconds)", "importModule": "wpilib.simulation"}, "fields": {"MODULE_OR_CLASS": "wpilib.simulation", "FUNC": "stepTiming"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "delta", "type": "wpimath.units.seconds"}], "tooltip": "Advance the simulator time and return immediately.\n\n:param delta: the amount to advance (in seconds)", "importModule": "wpilib.simulation"}, "fields": {"MODULE_OR_CLASS": "wpilib.simulation", "FUNC": "stepTimingAsync"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [], "tooltip": "", "importModule": "wpilib.simulation"}, "fields": {"MODULE_OR_CLASS": "wpilib.simulation", "FUNC": "waitForProgramStart"}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "simulation",
- contents: contents,
- moduleName: "wpilib.simulation",
- packageName: "wpilib.simulation",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpilib.ts b/src/blocks/generated/module_wpilib.ts
deleted file mode 100644
index 6ae10aae..00000000
--- a/src/blocks/generated/module_wpilib.ts
+++ /dev/null
@@ -1,57 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as pythonEnum from "../mrc_get_python_enum_value";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpilib
-
-export function initialize() {
- pythonEnum.initializeEnum("wpilib.AnalogTriggerType", ["kFallingPulse", "kInWindow", "kRisingPulse", "kState"], "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.");
- pythonEnum.initializeEnum("wpilib.CompressorConfigType", ["Analog", "Digital", "Disabled", "Hybrid"], "Compressor config type.\n\nMembers:\n\n Disabled : Disabled.\n\n Digital : Digital.\n\n Analog : Analog.\n\n Hybrid : Hybrid.");
- pythonEnum.initializeEnum("wpilib.PneumaticsModuleType", ["CTREPCM", "REVPH"], "Pneumatics module type.\n\nMembers:\n\n CTREPCM : CTRE PCM.\n\n REVPH : REV PH.");
- pythonEnum.initializeEnum("wpilib.RadioLEDState", ["kGreen", "kOff", "kOrange", "kRed"], "State for the radio led.\n\nMembers:\n\n kOff : ///< Off.\n\n kGreen : ///< Green.\n\n kRed : ///< Red.\n\n kOrange : ///< Orange.");
- pythonEnum.initializeEnum("wpilib.RuntimeType", ["kRoboRIO", "kRoboRIO2", "kSimulation"], "Runtime type.\n\nMembers:\n\n kRoboRIO : roboRIO 1.0.\n\n kRoboRIO2 : roboRIO 2.0.\n\n kSimulation : Simulation runtime.");
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 24 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[int, bool]", "args": [], "tooltip": "Get the thread priority for the current thread.\n\n:param isRealTime: Set to true if thread is real-time, otherwise false.\n\n:returns: The current thread priority. For real-time, this is 1-99\n with 99 being highest. For non-real-time, this is 0. See\n \"man 7 sched\" for details.", "importModule": "wpilib"}, "fields": {"MODULE_OR_CLASS": "wpilib", "FUNC": "getCurrentThreadPriority"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "str", "args": [], "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", "importModule": "wpilib"}, "fields": {"MODULE_OR_CLASS": "wpilib", "FUNC": "getDeployDirectory"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myTuple"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "tuple[str, int]", "args": [], "tooltip": "Gets error message string for an error code.", "importModule": "wpilib"}, "fields": {"MODULE_OR_CLASS": "wpilib", "FUNC": "getErrorMessage"}}}}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "str", "args": [], "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.", "importModule": "wpilib"}, "fields": {"MODULE_OR_CLASS": "wpilib", "FUNC": "getOperatingDirectory"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "wpimath.units.seconds", "args": [], "tooltip": "Gives real-time clock system time with nanosecond resolution\n\n:returns: The time, just in case you want the robot to start autonomous at 8pm\n on Saturday.", "importModule": "wpilib"}, "fields": {"MODULE_OR_CLASS": "wpilib", "FUNC": "getTime"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "bool", "args": [{"name": "realTime", "type": "bool"}, {"name": "priority", "type": "int"}], "tooltip": "Sets the thread priority for the current thread.\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.", "importModule": "wpilib"}, "fields": {"MODULE_OR_CLASS": "wpilib", "FUNC": "setCurrentThreadPriority"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "None", "args": [{"name": "seconds", "type": "wpimath.units.seconds"}], "tooltip": "Pause the task for a specified time.\n\nPause the execution of the program for a specified period of time given in\nseconds. Motors will continue to run at their last assigned values, and\nsensors will continue to update. Only the task containing the wait will pause\nuntil the wait time is expired.\n\n:param seconds: Length of time to pause, in seconds.", "importModule": "wpilib"}, "fields": {"MODULE_OR_CLASS": "wpilib", "FUNC": "wait"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.AnalogTriggerType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.AnalogTriggerType", "ENUM_VALUE": "kFallingPulse"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.AnalogTriggerType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.AnalogTriggerType", "ENUM_VALUE": "kInWindow"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.AnalogTriggerType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.AnalogTriggerType", "ENUM_VALUE": "kRisingPulse"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.AnalogTriggerType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.AnalogTriggerType", "ENUM_VALUE": "kState"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.CompressorConfigType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.CompressorConfigType", "ENUM_VALUE": "Analog"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.CompressorConfigType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.CompressorConfigType", "ENUM_VALUE": "Digital"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.CompressorConfigType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.CompressorConfigType", "ENUM_VALUE": "Disabled"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.CompressorConfigType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.CompressorConfigType", "ENUM_VALUE": "Hybrid"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.PneumaticsModuleType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.PneumaticsModuleType", "ENUM_VALUE": "CTREPCM"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.PneumaticsModuleType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.PneumaticsModuleType", "ENUM_VALUE": "REVPH"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.RadioLEDState", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.RadioLEDState", "ENUM_VALUE": "kGreen"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.RadioLEDState", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.RadioLEDState", "ENUM_VALUE": "kOff"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.RadioLEDState", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.RadioLEDState", "ENUM_VALUE": "kOrange"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.RadioLEDState", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.RadioLEDState", "ENUM_VALUE": "kRed"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.RuntimeType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.RuntimeType", "ENUM_VALUE": "kRoboRIO"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.RuntimeType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.RuntimeType", "ENUM_VALUE": "kRoboRIO2"}},
- {"kind": "block", "type": "mrc_get_python_enum_value", "extraState": {"enumType": "wpilib.RuntimeType", "importModule": "wpilib"}, "fields": {"ENUM_TYPE": "wpilib.RuntimeType", "ENUM_VALUE": "kSimulation"}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "wpilib",
- contents: contents,
- moduleName: "wpilib",
- packageName: "wpilib",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.controller.ts b/src/blocks/generated/module_wpimath.controller.ts
deleted file mode 100644
index 1e6a3011..00000000
--- a/src/blocks/generated/module_wpimath.controller.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.controller
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "controller",
- contents: contents,
- moduleName: "wpimath.controller",
- packageName: "wpimath.controller",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.estimator.ts b/src/blocks/generated/module_wpimath.estimator.ts
deleted file mode 100644
index 95cdb7e4..00000000
--- a/src/blocks/generated/module_wpimath.estimator.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.estimator
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "estimator",
- contents: contents,
- moduleName: "wpimath.estimator",
- packageName: "wpimath.estimator",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.filter.ts b/src/blocks/generated/module_wpimath.filter.ts
deleted file mode 100644
index 559485f9..00000000
--- a/src/blocks/generated/module_wpimath.filter.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.filter
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "filter",
- contents: contents,
- moduleName: "wpimath.filter",
- packageName: "wpimath.filter",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.geometry.ts b/src/blocks/generated/module_wpimath.geometry.ts
deleted file mode 100644
index 9332c097..00000000
--- a/src/blocks/generated/module_wpimath.geometry.ts
+++ /dev/null
@@ -1,28 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.geometry
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 1 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "numpy.ndarray[numpy.float64[3, 3]]", "args": [{"name": "rotation", "type": "numpy.ndarray[numpy.float64[3, 1]]"}], "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.", "importModule": "wpimath.geometry"}, "fields": {"MODULE_OR_CLASS": "wpimath.geometry", "FUNC": "rotationVectorToMatrix"}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "geometry",
- contents: contents,
- moduleName: "wpimath.geometry",
- packageName: "wpimath.geometry",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.interpolation.ts b/src/blocks/generated/module_wpimath.interpolation.ts
deleted file mode 100644
index 0179e22a..00000000
--- a/src/blocks/generated/module_wpimath.interpolation.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.interpolation
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "interpolation",
- contents: contents,
- moduleName: "wpimath.interpolation",
- packageName: "wpimath.interpolation",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.kinematics.ts b/src/blocks/generated/module_wpimath.kinematics.ts
deleted file mode 100644
index c33991ba..00000000
--- a/src/blocks/generated/module_wpimath.kinematics.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.kinematics
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "kinematics",
- contents: contents,
- moduleName: "wpimath.kinematics",
- packageName: "wpimath.kinematics",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.optimization.ts b/src/blocks/generated/module_wpimath.optimization.ts
deleted file mode 100644
index 7d9bcd81..00000000
--- a/src/blocks/generated/module_wpimath.optimization.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.optimization
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "optimization",
- contents: contents,
- moduleName: "wpimath.optimization",
- packageName: "wpimath.optimization",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.path.ts b/src/blocks/generated/module_wpimath.path.ts
deleted file mode 100644
index 992fc299..00000000
--- a/src/blocks/generated/module_wpimath.path.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.path
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "path",
- contents: contents,
- moduleName: "wpimath.path",
- packageName: "wpimath.path",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.spline.ts b/src/blocks/generated/module_wpimath.spline.ts
deleted file mode 100644
index 732442f9..00000000
--- a/src/blocks/generated/module_wpimath.spline.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.spline
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "spline",
- contents: contents,
- moduleName: "wpimath.spline",
- packageName: "wpimath.spline",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.system.plant.ts b/src/blocks/generated/module_wpimath.system.plant.ts
deleted file mode 100644
index 3186576a..00000000
--- a/src/blocks/generated/module_wpimath.system.plant.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.system.plant
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "plant",
- contents: contents,
- moduleName: "wpimath.system.plant",
- packageName: "wpimath.system.plant",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.system.ts b/src/blocks/generated/module_wpimath.system.ts
deleted file mode 100644
index 6d502089..00000000
--- a/src/blocks/generated/module_wpimath.system.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.system
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "system",
- contents: contents,
- moduleName: "wpimath.system",
- packageName: "wpimath.system",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.trajectory.constraint.ts b/src/blocks/generated/module_wpimath.trajectory.constraint.ts
deleted file mode 100644
index df5ba6aa..00000000
--- a/src/blocks/generated/module_wpimath.trajectory.constraint.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.trajectory.constraint
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "constraint",
- contents: contents,
- moduleName: "wpimath.trajectory.constraint",
- packageName: "wpimath.trajectory.constraint",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.trajectory.ts b/src/blocks/generated/module_wpimath.trajectory.ts
deleted file mode 100644
index 78f44c75..00000000
--- a/src/blocks/generated/module_wpimath.trajectory.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.trajectory
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 0 blocks.
- const contents: toolboxItems.ContentsType[] = [
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "trajectory",
- contents: contents,
- moduleName: "wpimath.trajectory",
- packageName: "wpimath.trajectory",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.ts b/src/blocks/generated/module_wpimath.ts
deleted file mode 100644
index 243fd334..00000000
--- a/src/blocks/generated/module_wpimath.ts
+++ /dev/null
@@ -1,33 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath
-
-export function initialize() {
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 6 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "wpimath.units.radians", "args": [{"name": "angle", "type": "wpimath.units.radians"}], "tooltip": "", "importModule": "wpimath"}, "fields": {"MODULE_OR_CLASS": "wpimath", "FUNC": "angleModulus"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "value", "type": "float"}, {"name": "deadband", "type": "float"}, {"name": "maxMagnitude", "type": "float"}], "tooltip": "Returns 0.0 if the given value is within the specified range around zero. The\nremaining range between the deadband and the maximum magnitude is scaled from\n0.0 to the maximum magnitude.\n\n:param value: Value to clip.\n:param deadband: Range around zero.\n:param maxMagnitude: The maximum magnitude of the input (defaults to 1). Can\n be infinite.\n\n:returns: The value after the deadband is applied.", "importModule": "wpimath"}, "fields": {"MODULE_OR_CLASS": "wpimath", "FUNC": "applyDeadband"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "x", "type": "int"}, {"name": "y", "type": "int"}], "tooltip": "Returns the largest (closest to positive infinity)\n``int`` value that is less than or equal to the algebraic quotient.\n\n:param x: the dividend\n:param y: the divisor\n\n:returns: the largest (closest to positive infinity)\n ``int`` value that is less than or equal to the algebraic quotient.", "importModule": "wpimath"}, "fields": {"MODULE_OR_CLASS": "wpimath", "FUNC": "floorDiv"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "int", "args": [{"name": "x", "type": "int"}, {"name": "y", "type": "int"}], "tooltip": "Returns the floor modulus of the ``int`` arguments.\n\nThe floor modulus is ``r = x - (floorDiv(x, y) * y)``,\nhas the same sign as the divisor ``y`` or is zero, and\nis in the range of ``-std::abs(y) < r < +std::abs(y)``.\n\n:param x: the dividend\n:param y: the divisor\n\n:returns: the floor modulus ``x - (floorDiv(x, y) * y)``", "importModule": "wpimath"}, "fields": {"MODULE_OR_CLASS": "wpimath", "FUNC": "floorMod"}},
- {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "float", "args": [{"name": "input", "type": "float"}, {"name": "minimumInput", "type": "float"}, {"name": "maximumInput", "type": "float"}], "tooltip": "Returns modulus of input.\n\n:param input: Input value to wrap.\n:param minimumInput: The minimum value expected from the input.\n:param maximumInput: The maximum value expected from the input.", "importModule": "wpimath"}, "fields": {"MODULE_OR_CLASS": "wpimath", "FUNC": "inputModulus"}},
- {"kind": "block", "type": "variables_set", "fields": {"VAR": {"name": "myPose3d"}}, "inputs": {"VALUE": {"block": {"kind": "block", "type": "mrc_call_python_function", "extraState": {"functionKind": "module", "returnType": "wpimath.geometry.Pose3d", "args": [{"name": "objectInField", "type": "wpimath.geometry.Pose3d"}, {"name": "cameraToObject", "type": "wpimath.geometry.Transform3d"}, {"name": "robotToCamera", "type": "wpimath.geometry.Transform3d"}], "tooltip": "", "importModule": "wpimath"}, "fields": {"MODULE_OR_CLASS": "wpimath", "FUNC": "objectToRobotPose"}, "inputs": {"ARG0": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myPose3d"}}}}, "ARG1": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTransform3d"}}}}, "ARG2": {"block": {"type": "variables_get", "fields": {"VAR": {"name": "myTransform3d"}}}}}}}}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "wpimath",
- contents: contents,
- moduleName: "wpimath",
- packageName: "wpimath",
- };
-
- return category;
-}
diff --git a/src/blocks/generated/module_wpimath.units.ts b/src/blocks/generated/module_wpimath.units.ts
deleted file mode 100644
index 17045bbd..00000000
--- a/src/blocks/generated/module_wpimath.units.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as getPythonVariable from "../mrc_get_python_variable";
-import * as toolboxItems from "../../toolbox/items";
-
-// Blocks for module wpimath.units
-
-export function initialize() {
- getPythonVariable.initializeModuleVariableGetter("wpimath.units", "float", ["kInchesPerFoot", "kKilogramsPerLb", "kMetersPerInch"], []);
- getPythonVariable.initializeModuleVariableGetter("wpimath.units", "int", ["kMillisecondsPerSecond", "kSecondsPerMinute"], []);
-}
-
-export function getToolboxCategory(subcategories: toolboxItems.Category[] = []): toolboxItems.Category {
-
- // There are 5 blocks.
- const contents: toolboxItems.ContentsType[] = [
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "module", "moduleOrClassName": "wpimath.units", "varType": "float", "importModule": "wpimath.units"}, "fields": {"MODULE_OR_CLASS": "wpimath.units", "VAR": "kInchesPerFoot"}},
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "module", "moduleOrClassName": "wpimath.units", "varType": "float", "importModule": "wpimath.units"}, "fields": {"MODULE_OR_CLASS": "wpimath.units", "VAR": "kKilogramsPerLb"}},
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "module", "moduleOrClassName": "wpimath.units", "varType": "float", "importModule": "wpimath.units"}, "fields": {"MODULE_OR_CLASS": "wpimath.units", "VAR": "kMetersPerInch"}},
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "module", "moduleOrClassName": "wpimath.units", "varType": "int", "importModule": "wpimath.units"}, "fields": {"MODULE_OR_CLASS": "wpimath.units", "VAR": "kMillisecondsPerSecond"}},
- {"kind": "block", "type": "mrc_get_python_variable", "extraState": {"varKind": "module", "moduleOrClassName": "wpimath.units", "varType": "int", "importModule": "wpimath.units"}, "fields": {"MODULE_OR_CLASS": "wpimath.units", "VAR": "kSecondsPerMinute"}},
- ];
-
- contents.push(...subcategories);
-
- const category: toolboxItems.PythonModuleCategory = {
- kind: "category",
- name: "units",
- contents: contents,
- moduleName: "wpimath.units",
- packageName: "wpimath",
- };
-
- return category;
-}
diff --git a/src/blocks/mrc_call_python_function.ts b/src/blocks/mrc_call_python_function.ts
index 227204d8..67bf0a86 100644
--- a/src/blocks/mrc_call_python_function.ts
+++ b/src/blocks/mrc_call_python_function.ts
@@ -23,14 +23,18 @@
import * as Blockly from 'blockly';
import { Order } from 'blockly/python';
-import * as pythonUtils from './utils/generated/python';
-import { createFieldDropdown } from '../fields/FieldDropdown';
-import { createFieldNonEditableText } from '../fields/FieldNonEditableText';
+import { ClassMethodDefExtraState } from './mrc_class_method_def'
import { getAllowedTypesForSetCheck, getOutputCheck } from './utils/python';
+import { FunctionData } from './utils/robotpy_data';
+import * as value from './utils/value';
+import * as variable from './utils/variable';
+import { Editor } from '../editor/editor';
import { ExtendedPythonGenerator } from '../editor/extended_python_generator';
+import { createFieldDropdown } from '../fields/FieldDropdown';
+import { createFieldNonEditableText } from '../fields/FieldNonEditableText';
import { MRC_STYLE_FUNCTIONS } from '../themes/styles'
-import { ClassMethodDefExtraState } from './mrc_class_method_def'
-import { Editor } from '../editor/editor';
+import * as toolboxItems from '../toolbox/items';
+
// A block to call a python function.
@@ -47,6 +51,8 @@ enum FunctionKind {
const RETURN_TYPE_NONE = 'None';
+const FIELD_MODULE_OR_CLASS_NAME = 'MODULE_OR_CLASS';
+const FIELD_FUNCTION_NAME = 'FUNC';
const FIELD_COMPONENT_NAME = 'COMPONENT_NAME';
export type FunctionArg = {
@@ -54,6 +60,165 @@ export type FunctionArg = {
type: string,
};
+// Functions used for creating blocks for the toolbox.
+
+export function addModuleFunctionBlocks(
+ moduleName: string,
+ functions: FunctionData[],
+ contents: toolboxItems.ContentsType[]) {
+ for (const functionData of functions) {
+ const block = createModuleFunctionOrStaticMethodBlock(
+ FunctionKind.MODULE, moduleName, moduleName, functionData);
+ contents.push(block);
+ }
+}
+
+export function addStaticMethodBlocks(
+ importModule: string,
+ functions: FunctionData[],
+ contents: toolboxItems.ContentsType[]) {
+ for (const functionData of functions) {
+ if (functionData.declaringClassName) {
+ const block = createModuleFunctionOrStaticMethodBlock(
+ FunctionKind.STATIC, importModule, functionData.declaringClassName, functionData);
+ contents.push(block);
+ }
+ }
+}
+
+function createModuleFunctionOrStaticMethodBlock(
+ functionKind: FunctionKind,
+ importModule: string,
+ moduleOrClassName: string,
+ functionData: FunctionData): toolboxItems.Block {
+ const extraState: CallPythonFunctionExtraState = {
+ functionKind: functionKind,
+ returnType: functionData.returnType,
+ args: [],
+ tooltip: functionData.tooltip,
+ importModule: importModule,
+ };
+ const fields: {[key: string]: any} = {};
+ fields[FIELD_MODULE_OR_CLASS_NAME] = moduleOrClassName;
+ fields[FIELD_FUNCTION_NAME] = functionData.functionName;
+ const inputs: {[key: string]: any} = {};
+ for (let i = 0; i < functionData.args.length; i++) {
+ const argData = functionData.args[i];
+ extraState.args.push({
+ 'name': argData.name,
+ 'type': argData.type,
+ });
+ // Check if we should plug a variable getter block into the argument input socket.
+ const input = value.valueForFunctionArgInput(argData.type, argData.defaultValue);
+ if (input) {
+ inputs['ARG' + i] = input;
+ }
+ }
+ let block = new toolboxItems.Block(BLOCK_NAME, extraState, fields, Object.keys(inputs).length ? inputs : null);
+ if (functionData.returnType && functionData.returnType != 'None') {
+ const varName = variable.varNameForType(functionData.returnType);
+ if (varName) {
+ block = variable.createVariableSetterBlock(varName, block);
+ }
+ }
+ return block;
+}
+
+export function addConstructorBlocks(
+ importModule: string,
+ functions: FunctionData[],
+ contents: toolboxItems.ContentsType[]) {
+ for (const functionData of functions) {
+ const block = createConstructorBlock(importModule, functionData);
+ contents.push(block);
+ }
+}
+
+function createConstructorBlock(
+ importModule: string,
+ functionData: FunctionData): toolboxItems.Block {
+ const extraState: CallPythonFunctionExtraState = {
+ functionKind: FunctionKind.CONSTRUCTOR,
+ returnType: functionData.returnType,
+ args: [],
+ tooltip: functionData.tooltip,
+ importModule: importModule,
+ };
+ const fields: {[key: string]: any} = {};
+ fields[FIELD_MODULE_OR_CLASS_NAME] = functionData.declaringClassName;
+ const inputs: {[key: string]: any} = {};
+ for (let i = 0; i < functionData.args.length; i++) {
+ const argData = functionData.args[i];
+ extraState.args.push({
+ 'name': argData.name,
+ 'type': argData.type,
+ });
+ // Check if we should plug a variable getter block into the argument input socket.
+ const input = value.valueForFunctionArgInput(argData.type, argData.defaultValue);
+ if (input) {
+ inputs['ARG' + i] = input;
+ }
+ }
+ let block = new toolboxItems.Block(BLOCK_NAME, extraState, fields, Object.keys(inputs).length ? inputs : null);
+ if (functionData.returnType && functionData.returnType != 'None') {
+ const varName = variable.varNameForType(functionData.returnType);
+ if (varName) {
+ block = variable.createVariableSetterBlock(varName, block);
+ }
+ }
+ return block;
+}
+
+export function addInstanceMethodBlocks(
+ functions: FunctionData[],
+ contents: toolboxItems.ContentsType[]) {
+ for (const functionData of functions) {
+ const block = createInstanceMethodBlock(functionData);
+ contents.push(block);
+ }
+}
+
+function createInstanceMethodBlock(
+ functionData: FunctionData): toolboxItems.Block {
+ const extraState: CallPythonFunctionExtraState = {
+ functionKind: FunctionKind.INSTANCE,
+ returnType: functionData.returnType,
+ args: [],
+ tooltip: functionData.tooltip,
+ };
+ const fields: {[key: string]: any} = {};
+ fields[FIELD_MODULE_OR_CLASS_NAME] = functionData.declaringClassName;
+ fields[FIELD_FUNCTION_NAME] = functionData.functionName;
+ const inputs: {[key: string]: any} = {};
+ for (let i = 0; i < functionData.args.length; i++) {
+ const argData = functionData.args[i];
+ let argName = argData.name;
+ if (i === 0 && argName === 'self' && functionData.declaringClassName) {
+ argName = variable.getSelfArgName(functionData.declaringClassName);
+ }
+ extraState.args.push({
+ 'name': argName,
+ 'type': argData.type,
+ });
+ // Check if we should plug a variable getter block into the argument input socket.
+ const input = value.valueForFunctionArgInput(argData.type, argData.defaultValue);
+ if (input) {
+ inputs['ARG' + i] = input;
+ }
+ }
+ let block = new toolboxItems.Block(BLOCK_NAME, extraState, fields, Object.keys(inputs).length ? inputs : null);
+ if (functionData.returnType && functionData.returnType != 'None') {
+ const varName = variable.varNameForType(functionData.returnType);
+ if (varName) {
+ block = variable.createVariableSetterBlock(varName, block);
+ }
+ }
+ return block;
+}
+
+
+//..............................................................................
+
export type CallPythonFunctionBlock = Blockly.Block & CallPythonFunctionMixin;
interface CallPythonFunctionMixin extends CallPythonFunctionMixinType {
mrcFunctionKind: FunctionKind,
@@ -105,7 +270,7 @@ type CallPythonFunctionExtraState = {
* True if this blocks refers to an exported function (for example, from a
* user's Project).
*/
- exportedFunction: boolean,
+ exportedFunction?: boolean,
/**
* The component name. Specified only if the function kind is INSTANCE_COMPONENT.
*/
@@ -126,37 +291,37 @@ const CALL_PYTHON_FUNCTION = {
let tooltip: string;
switch (this.mrcFunctionKind) {
case FunctionKind.MODULE: {
- const moduleName = this.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
- const functionName = this.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME);
- tooltip = 'Calls the function ' + moduleName + '.' + functionName + '.';
+ const moduleName = this.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
+ const functionName = this.getFieldValue(FIELD_FUNCTION_NAME);
+ tooltip = 'Calls the module function ' + moduleName + '.' + functionName + '.';
break;
}
case FunctionKind.STATIC: {
- const className = this.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
- const functionName = this.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME);
- tooltip = 'Calls the function ' + className + '.' + functionName + '.';
+ const className = this.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
+ const functionName = this.getFieldValue(FIELD_FUNCTION_NAME);
+ tooltip = 'Calls the static method ' + className + '.' + functionName + '.';
break;
}
case FunctionKind.CONSTRUCTOR: {
- const className = this.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ const className = this.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
tooltip = 'Constructs an instance of the class ' + className + '.';
break;
}
case FunctionKind.INSTANCE: {
- const className = this.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
- const functionName = this.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME);
- tooltip = 'Calls the function ' + className + '.' + functionName + '.';
+ const className = this.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
+ const functionName = this.getFieldValue(FIELD_FUNCTION_NAME);
+ tooltip = 'Calls the instance method ' + className + '.' + functionName + '.';
break;
}
case FunctionKind.INSTANCE_WITHIN: {
- const functionName = this.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME);
- tooltip = 'Calls the method ' + functionName + '.';
+ const functionName = this.getFieldValue(FIELD_FUNCTION_NAME);
+ tooltip = 'Calls the instance method ' + functionName + '.';
break;
}
case FunctionKind.INSTANCE_COMPONENT: {
const className = this.mrcComponentClassName;
- const functionName = this.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME);
- tooltip = 'Calls the method ' + className + '.' + functionName +
+ const functionName = this.getFieldValue(FIELD_FUNCTION_NAME);
+ tooltip = 'Calls the instance method ' + className + '.' + functionName +
' on the component named ' + this.getComponentName() + '.';
break;
}
@@ -179,7 +344,6 @@ const CALL_PYTHON_FUNCTION = {
functionKind: this.mrcFunctionKind,
returnType: this.mrcReturnType,
args: [],
- exportedFunction: this.mrcExportedFunction,
};
this.mrcArgs.forEach((arg) => {
extraState.args.push({
@@ -202,6 +366,9 @@ const CALL_PYTHON_FUNCTION = {
if (this.getField(FIELD_COMPONENT_NAME)) {
extraState.componentName = this.getComponentName();
}
+ if (this.mrcExportedFunction) {
+ extraState.exportedFunction = this.mrcExportedFunction;
+ }
return extraState;
},
/**
@@ -260,35 +427,35 @@ const CALL_PYTHON_FUNCTION = {
case FunctionKind.MODULE:
this.appendDummyInput('TITLE')
.appendField('call')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_MODULE_OR_CLASS_NAME)
+ .appendField(createFieldNonEditableText(''), FIELD_MODULE_OR_CLASS_NAME)
.appendField('.')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_FUNCTION_NAME);
+ .appendField(createFieldNonEditableText(''), FIELD_FUNCTION_NAME);
break;
case FunctionKind.STATIC:
this.appendDummyInput('TITLE')
.appendField('call')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_MODULE_OR_CLASS_NAME)
+ .appendField(createFieldNonEditableText(''), FIELD_MODULE_OR_CLASS_NAME)
.appendField('.')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_FUNCTION_NAME);
+ .appendField(createFieldNonEditableText(''), FIELD_FUNCTION_NAME);
break;
case FunctionKind.CONSTRUCTOR:
this.appendDummyInput('TITLE')
.appendField('create')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ .appendField(createFieldNonEditableText(''), FIELD_MODULE_OR_CLASS_NAME);
break;
case FunctionKind.INSTANCE:
this.appendDummyInput('TITLE')
.appendField('call')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_MODULE_OR_CLASS_NAME)
+ .appendField(createFieldNonEditableText(''), FIELD_MODULE_OR_CLASS_NAME)
.appendField('.')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_FUNCTION_NAME);
+ .appendField(createFieldNonEditableText(''), FIELD_FUNCTION_NAME);
break;
case FunctionKind.INSTANCE_WITHIN: {
const input = this.getInput('TITLE');
if (!input) {
this.appendDummyInput('TITLE')
.appendField('call')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_FUNCTION_NAME);
+ .appendField(createFieldNonEditableText(''), FIELD_FUNCTION_NAME);
}
break;
}
@@ -302,7 +469,7 @@ const CALL_PYTHON_FUNCTION = {
.appendField('call')
.appendField(createFieldDropdown(componentNames), FIELD_COMPONENT_NAME)
.appendField('.')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_FUNCTION_NAME);
+ .appendField(createFieldNonEditableText(''), FIELD_FUNCTION_NAME);
break;
}
default:
@@ -348,7 +515,7 @@ const CALL_PYTHON_FUNCTION = {
return this.mrcComponentClassName;
},
renameMethod: function(this: CallPythonFunctionBlock, newName: string): void {
- this.setFieldValue(newName, pythonUtils.FIELD_FUNCTION_NAME);
+ this.setFieldValue(newName, FIELD_FUNCTION_NAME);
},
mutateMethod: function(
this: CallPythonFunctionBlock,
@@ -382,24 +549,24 @@ export const pythonFromBlock = function(
let argStartIndex = 0;
switch (callPythonFunctionBlock.mrcFunctionKind) {
case FunctionKind.MODULE: {
- const moduleName = block.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ const moduleName = block.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
const functionName = (callPythonFunctionBlock.mrcActualFunctionName)
? callPythonFunctionBlock.mrcActualFunctionName
- : block.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME);
+ : block.getFieldValue(FIELD_FUNCTION_NAME);
code = moduleName + '.' + functionName;
break;
}
case FunctionKind.STATIC: {
const callPythonFunctionBlock = block as CallPythonFunctionBlock;
- const className = block.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ const className = block.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
const functionName = (callPythonFunctionBlock.mrcActualFunctionName)
? callPythonFunctionBlock.mrcActualFunctionName
- : block.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME);
+ : block.getFieldValue(FIELD_FUNCTION_NAME);
code = className + '.' + functionName;
break;
}
case FunctionKind.CONSTRUCTOR: {
- const className = block.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ const className = block.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
code = className;
break;
}
@@ -408,13 +575,13 @@ export const pythonFromBlock = function(
const selfValue = generator.valueToCode(block, 'ARG0', Order.MEMBER);
const functionName = (callPythonFunctionBlock.mrcActualFunctionName)
? callPythonFunctionBlock.mrcActualFunctionName
- : block.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME);
+ : block.getFieldValue(FIELD_FUNCTION_NAME);
code = selfValue + '.' + functionName;
argStartIndex = 1; // Skip the self argument.
break;
}
case FunctionKind.INSTANCE_WITHIN: {
- const blocklyName = block.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME);
+ const blocklyName = block.getFieldValue(FIELD_FUNCTION_NAME);
const functionName = generator.getProcedureName(blocklyName);
code = 'self.' + functionName;
break;
@@ -423,7 +590,7 @@ export const pythonFromBlock = function(
const componentName = callPythonFunctionBlock.getComponentName();
const functionName = callPythonFunctionBlock.mrcActualFunctionName
? callPythonFunctionBlock.mrcActualFunctionName
- : block.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME);
+ : block.getFieldValue(FIELD_FUNCTION_NAME);
code = 'self.robot.' + componentName + '.' + functionName;
break;
}
@@ -461,7 +628,7 @@ function getMethodCallers(workspace: Blockly.Workspace, name: string): Blockly.B
const callBlock = block as CallPythonFunctionBlock;
return (
callBlock.mrcFunctionKind === FunctionKind.INSTANCE_WITHIN &&
- callBlock.getFieldValue(pythonUtils.FIELD_FUNCTION_NAME) === name
+ callBlock.getFieldValue(FIELD_FUNCTION_NAME) === name
);
});
}
diff --git a/src/blocks/mrc_get_python_enum_value.ts b/src/blocks/mrc_get_python_enum_value.ts
index 69fd8c06..d2650c2a 100644
--- a/src/blocks/mrc_get_python_enum_value.ts
+++ b/src/blocks/mrc_get_python_enum_value.ts
@@ -23,18 +23,22 @@
import * as Blockly from 'blockly';
import { Order } from 'blockly/python';
-import * as pythonUtils from './utils/generated/python';
-import { createFieldDropdown } from '../fields/FieldDropdown';
-import { createFieldNonEditableText } from '../fields/FieldNonEditableText';
import { getOutputCheck } from './utils/python';
+import { EnumData } from './utils/robotpy_data';
import { ExtendedPythonGenerator } from '../editor/extended_python_generator';
+import { createFieldDropdown } from '../fields/FieldDropdown';
+import { createFieldNonEditableText } from '../fields/FieldNonEditableText';
import { MRC_STYLE_ENUM } from '../themes/styles'
+import * as toolboxItems from '../toolbox/items';
// A block to access a python enum.
export const BLOCK_NAME = 'mrc_get_python_enum_value';
+const FIELD_ENUM_CLASS_NAME = 'ENUM_TYPE';
+const FIELD_ENUM_VALUE = 'ENUM_VALUE';
+
// Variables and functions used for populating the drop down field for the enum values.
const PythonEnumValues = Object.create(null);
@@ -46,6 +50,28 @@ export function initializeEnum(
PythonEnumTooltips[enumClassName] = tooltips;
}
+// Functions used for creating blocks for the toolbox.
+
+export function addEnumBlocks(enums: EnumData[], contents: toolboxItems.ContentsType[]) {
+ for (const enumData of enums) {
+ for (const enumValue of enumData.enumValues) {
+ const block = createEnumBlock(enumValue, enumData);
+ contents.push(block);
+ }
+ }
+}
+
+function createEnumBlock(enumValue: string, enumData: EnumData): toolboxItems.Block {
+ const extraState: GetPythonEnumValueExtraState = {
+ enumType: enumData.enumClassName,
+ importModule: enumData.moduleName,
+ };
+ const fields: {[key: string]: any} = {};
+ fields[FIELD_ENUM_CLASS_NAME] = enumData.enumClassName;
+ fields[FIELD_ENUM_VALUE] = enumValue;
+ return new toolboxItems.Block(BLOCK_NAME, extraState, fields, null);
+}
+
//..............................................................................
type GetPythonEnumValueBlock = Blockly.Block & GetPythonEnumValueMixin;
@@ -67,12 +93,12 @@ const GET_PYTHON_ENUM_VALUE = {
*/
init: function(this: GetPythonEnumValueBlock): void {
this.appendDummyInput('ENUM')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_ENUM_CLASS_NAME)
+ .appendField(createFieldNonEditableText(''), FIELD_ENUM_CLASS_NAME)
.appendField('.');
this.setStyle(MRC_STYLE_ENUM);
this.setTooltip(() => {
- const enumClassName = this.getFieldValue(pythonUtils.FIELD_ENUM_CLASS_NAME);
- const enumValue = this.getFieldValue(pythonUtils.FIELD_ENUM_VALUE);
+ const enumClassName = this.getFieldValue(FIELD_ENUM_CLASS_NAME);
+ const enumValue = this.getFieldValue(FIELD_ENUM_VALUE);
let tooltip = 'Gets the enum value ' + enumClassName + '.' + enumValue + '.';
const enumTooltip = PythonEnumTooltips[enumClassName]
if (enumTooltip) {
@@ -128,7 +154,7 @@ const GET_PYTHON_ENUM_VALUE = {
// Create the drop-down with the enum values.
const enumValues = PythonEnumValues[this.mrcEnumType];
this.getInput('ENUM')!
- .appendField(createFieldDropdown(enumValues), pythonUtils.FIELD_ENUM_VALUE);
+ .appendField(createFieldDropdown(enumValues), FIELD_ENUM_VALUE);
}
};
@@ -141,8 +167,8 @@ export const pythonFromBlock = function(
generator: ExtendedPythonGenerator,
) {
const getPythonEnumValueBlock = block as GetPythonEnumValueBlock;
- const enumClassName = block.getFieldValue(pythonUtils.FIELD_ENUM_CLASS_NAME);
- const enumValue = block.getFieldValue(pythonUtils.FIELD_ENUM_VALUE);
+ const enumClassName = block.getFieldValue(FIELD_ENUM_CLASS_NAME);
+ const enumValue = block.getFieldValue(FIELD_ENUM_VALUE);
if (getPythonEnumValueBlock.mrcImportModule) {
generator.addImport(getPythonEnumValueBlock.mrcImportModule);
}
diff --git a/src/blocks/mrc_get_python_variable.ts b/src/blocks/mrc_get_python_variable.ts
index 359e6e38..73116f7c 100644
--- a/src/blocks/mrc_get_python_variable.ts
+++ b/src/blocks/mrc_get_python_variable.ts
@@ -23,20 +23,31 @@
import * as Blockly from 'blockly';
import { Order } from 'blockly/python';
-import * as pythonUtils from './utils/generated/python';
-import { createFieldDropdown } from '../fields/FieldDropdown';
-import { createFieldNonEditableText } from '../fields/FieldNonEditableText';
+import {
+ createModuleOrClassVariableSetterBlock,
+ createInstanceVariableSetterBlock } from '../blocks/mrc_set_python_variable';
import { getAllowedTypesForSetCheck, getOutputCheck } from './utils/python';
+import { VariableGettersAndSetters } from './utils/robotpy_data';
+import * as variable from './utils/variable';
import { ExtendedPythonGenerator } from '../editor/extended_python_generator';
-
+import { createFieldDropdown } from '../fields/FieldDropdown';
+import { createFieldNonEditableText } from '../fields/FieldNonEditableText';
import { MRC_STYLE_VARIABLES } from '../themes/styles';
+import * as toolboxItems from '../toolbox/items';
+
+
// A block to get a python variable.
export const BLOCK_NAME = 'mrc_get_python_variable';
-const VAR_KIND_MODULE = 'module';
-const VAR_KIND_CLASS = 'class';
-const VAR_KIND_INSTANCE = 'instance';
+enum VariableKind {
+ MODULE = 'module',
+ CLASS = 'class',
+ INSTANCE = 'instance',
+}
+
+const FIELD_MODULE_OR_CLASS_NAME = 'MODULE_OR_CLASS';
+const FIELD_VARIABLE_NAME = 'VAR';
// Variables and functions used for populating the drop down field for the variable names.
@@ -50,30 +61,130 @@ function createKey(
export function initializeModuleVariableGetter(
moduleName: string, varType: string, varNames: string[], tooltips: string[]): void {
- const key = createKey(VAR_KIND_MODULE, moduleName, varType);
+ const key = createKey(VariableKind.MODULE, moduleName, varType);
PythonVariableGetterNames[key] = varNames;
PythonVariableGetterTooltips[key] = tooltips;
}
export function initializeClassVariableGetter(
className: string, varType: string, varNames: string[], tooltips: string[]): void {
- const key = createKey(VAR_KIND_CLASS, className, varType);
+ const key = createKey(VariableKind.CLASS, className, varType);
PythonVariableGetterNames[key] = varNames;
PythonVariableGetterTooltips[key] = tooltips;
}
export function initializeInstanceVariableGetter(
className: string, varType: string, varNames: string[], tooltips: string[]): void {
- const key = createKey(VAR_KIND_INSTANCE, className, varType);
+ const key = createKey(VariableKind.INSTANCE, className, varType);
PythonVariableGetterNames[key] = varNames;
PythonVariableGetterTooltips[key] = tooltips;
}
+// Functions used for creating blocks for the toolbox.
+
+export function addModuleVariableBlocks(
+ moduleName: string,
+ varsByType: {[key: string]: VariableGettersAndSetters},
+ contents: toolboxItems.ContentsType[]) {
+ addModuleOrClassVariableBlocks(
+ VariableKind.MODULE, moduleName, moduleName, varsByType, contents);
+}
+
+export function addClassVariableBlocks(
+ importModule: string,
+ className: string,
+ varsByType: {[key: string]: VariableGettersAndSetters},
+ contents: toolboxItems.ContentsType[]) {
+ addModuleOrClassVariableBlocks(
+ VariableKind.CLASS, importModule, className, varsByType, contents);
+}
+
+function addModuleOrClassVariableBlocks(
+ varKind: VariableKind,
+ importModule: string,
+ moduleOrClassName: string,
+ varsByType: {[key: string]: VariableGettersAndSetters},
+ contents: toolboxItems.ContentsType[]) {
+ for (const varType in varsByType) {
+ const variableGettersAndSetters = varsByType[varType];
+ for (let i = 0; i < variableGettersAndSetters.varNamesForGetter.length; i++) {
+ const varName = variableGettersAndSetters.varNamesForGetter[i];
+ const getterBlock = createModuleOrClassVariableGetterBlock(
+ varKind, importModule, moduleOrClassName, varType, varName);
+ contents.push(getterBlock);
+ if (variableGettersAndSetters.varNamesForSetter.includes(varName)) {
+ const setterBlock = createModuleOrClassVariableSetterBlock(
+ VariableKind.CLASS, importModule, moduleOrClassName, varType, varName);
+ contents.push(setterBlock);
+ }
+ }
+ }
+}
+
+function createModuleOrClassVariableGetterBlock(
+ varKind: VariableKind,
+ importModule: string,
+ moduleOrClassName: string,
+ varType: string,
+ varName: string): toolboxItems.Block {
+ const extraState: GetPythonVariableExtraState = {
+ varKind: varKind,
+ moduleOrClassName: moduleOrClassName,
+ varType: varType,
+ importModule: importModule,
+ };
+ const fields: {[key: string]: any} = {};
+ fields[FIELD_MODULE_OR_CLASS_NAME] = moduleOrClassName;
+ fields[FIELD_VARIABLE_NAME] = varName;
+ return new toolboxItems.Block(BLOCK_NAME, extraState, fields, null);
+}
+
+export function addInstanceVariableBlocks(
+ className: string,
+ varsByType: {[key: string]: VariableGettersAndSetters},
+ contents: toolboxItems.ContentsType[]) {
+ for (const varType in varsByType) {
+ const variableGettersAndSetters = varsByType[varType];
+ for (let i = 0; i < variableGettersAndSetters.varNamesForGetter.length; i++) {
+ const varName = variableGettersAndSetters.varNamesForGetter[i];
+ const getterBlock = createInstanceVariableGetterBlock(className, varType, varName);
+ contents.push(getterBlock);
+ if (variableGettersAndSetters.varNamesForSetter.includes(varName)) {
+ const setterBlock = createInstanceVariableSetterBlock(className, varType, varName);
+ contents.push(setterBlock);
+ }
+ }
+ }
+}
+
+function createInstanceVariableGetterBlock(
+ className: string,
+ varType: string,
+ varName: string): toolboxItems.Block {
+ const selfLabel = variable.getSelfArgName(className);
+ const extraState: GetPythonVariableExtraState = {
+ varKind: VariableKind.INSTANCE,
+ moduleOrClassName: className,
+ varType: varType,
+ selfLabel: selfLabel,
+ selfType: className,
+ };
+ const fields: {[key: string]: any} = {};
+ fields[FIELD_MODULE_OR_CLASS_NAME] = className;
+ fields[FIELD_VARIABLE_NAME] = varName;
+ const inputs: {[key: string]: any} = {};
+ const selfVarName = variable.varNameForType(className);
+ if (selfVarName) {
+ inputs['SELF'] = variable.createVariableGetterBlockValue(selfVarName);
+ }
+ return new toolboxItems.Block(BLOCK_NAME, extraState, fields, Object.keys(inputs).length ? inputs : null);
+}
+
//..............................................................................
type GetPythonVariableBlock = Blockly.Block & GetPythonVariableMixin;
interface GetPythonVariableMixin extends GetPythonVariableMixinType {
- mrcVarKind: string, // module, class, or instance
+ mrcVarKind: VariableKind,
mrcModuleOrClassName: string,
mrcVarType: string,
mrcSelfLabel: string,
@@ -120,7 +231,7 @@ type GetPythonVariableExtraState = {
* True if this blocks refers to an exported variable (for example, from a
* user's Project).
*/
- exportedVariable: boolean,
+ exportedVariable?: boolean,
};
const GET_PYTHON_VARIABLE = {
@@ -130,25 +241,25 @@ const GET_PYTHON_VARIABLE = {
init: function(this: GetPythonVariableBlock): void {
this.appendDummyInput('VAR')
.appendField('get')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_MODULE_OR_CLASS_NAME)
+ .appendField(createFieldNonEditableText(''), FIELD_MODULE_OR_CLASS_NAME)
.appendField('.');
this.setStyle(MRC_STYLE_VARIABLES);
this.setTooltip(() => {
- const varName = this.getFieldValue(pythonUtils.FIELD_VARIABLE_NAME);
+ const varName = this.getFieldValue(FIELD_VARIABLE_NAME);
let tooltip: string;
switch (this.mrcVarKind) {
- case VAR_KIND_MODULE: {
- const moduleName = this.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ case VariableKind.MODULE: {
+ const moduleName = this.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
tooltip = 'Gets the variable ' + moduleName + '.' + varName + '.';
break;
}
- case VAR_KIND_CLASS: {
- const className = this.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ case VariableKind.CLASS: {
+ const className = this.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
tooltip = 'Gets the variable ' + className + '.' + varName + '.';
break;
}
- case VAR_KIND_INSTANCE: {
- const className = this.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ case VariableKind.INSTANCE: {
+ const className = this.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
tooltip = 'Gets the variable ' + varName + ' for the given ' + className + ' object.';
break;
}
@@ -205,7 +316,7 @@ const GET_PYTHON_VARIABLE = {
this: GetPythonVariableBlock,
extraState: GetPythonVariableExtraState
): void {
- this.mrcVarKind = extraState.varKind;
+ this.mrcVarKind = extraState.varKind as VariableKind;
this.mrcModuleOrClassName = extraState.moduleOrClassName;
this.mrcVarType = extraState.varType ? extraState.varType : '';
this.mrcSelfLabel = extraState.selfLabel ? extraState.selfLabel : '';
@@ -236,9 +347,9 @@ const GET_PYTHON_VARIABLE = {
const varNames = PythonVariableGetterNames[this.mrcKey];
if (varNames) {
// Create the drop-down with the variable names.
- input.appendField(createFieldDropdown(varNames), pythonUtils.FIELD_VARIABLE_NAME);
+ input.appendField(createFieldDropdown(varNames), FIELD_VARIABLE_NAME);
} else {
- input.appendField(createFieldNonEditableText(''), pythonUtils.FIELD_VARIABLE_NAME);
+ input.appendField(createFieldNonEditableText(''), FIELD_VARIABLE_NAME);
}
}
// Add input socket for self, if necessary.
@@ -262,25 +373,25 @@ export const pythonFromBlock = function(
const getPythonVariableBlock = block as GetPythonVariableBlock;
const varName = getPythonVariableBlock.mrcActualVariableName
? getPythonVariableBlock.mrcActualVariableName
- : block.getFieldValue(pythonUtils.FIELD_VARIABLE_NAME);
+ : block.getFieldValue(FIELD_VARIABLE_NAME);
switch (getPythonVariableBlock.mrcVarKind) {
- case VAR_KIND_MODULE: {
- const moduleName = block.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ case VariableKind.MODULE: {
+ const moduleName = block.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
if (getPythonVariableBlock.mrcImportModule) {
generator.addImport(getPythonVariableBlock.mrcImportModule);
}
const code = moduleName + '.' + varName;
return [code, Order.MEMBER];
}
- case VAR_KIND_CLASS: {
- const className = block.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ case VariableKind.CLASS: {
+ const className = block.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
if (getPythonVariableBlock.mrcImportModule) {
generator.addImport(getPythonVariableBlock.mrcImportModule);
}
const code = className + '.' + varName;
return [code, Order.MEMBER];
}
- case VAR_KIND_INSTANCE: {
+ case VariableKind.INSTANCE: {
const selfValue = generator.valueToCode(block, 'SELF', Order.MEMBER);
const code = selfValue + '.' + varName;
return [code, Order.MEMBER];
diff --git a/src/blocks/mrc_set_python_variable.ts b/src/blocks/mrc_set_python_variable.ts
index 87124f04..d43d9c7f 100644
--- a/src/blocks/mrc_set_python_variable.ts
+++ b/src/blocks/mrc_set_python_variable.ts
@@ -23,21 +23,29 @@
import * as Blockly from 'blockly';
import { Order } from 'blockly/python';
-import * as pythonUtils from './utils/generated/python';
-import { createFieldDropdown } from '../fields/FieldDropdown';
-import { createFieldNonEditableText } from '../fields/FieldNonEditableText';
import { getAllowedTypesForSetCheck } from './utils/python';
+import * as variable from './utils/variable';
import { ExtendedPythonGenerator } from '../editor/extended_python_generator';
+import { createFieldDropdown } from '../fields/FieldDropdown';
+import { createFieldNonEditableText } from '../fields/FieldNonEditableText';
import { MRC_STYLE_VARIABLES } from '../themes/styles';
+import * as toolboxItems from '../toolbox/items';
+
// A block to set a python variable.
export const BLOCK_NAME = 'mrc_set_python_variable';
+// TODO(lizlooney): Consider combining VariableKind here with VariableKind in
+// mrc_get_python_variable.ts. They are identical.
+enum VariableKind {
+ MODULE = 'module',
+ CLASS = 'class',
+ INSTANCE = 'instance',
+}
-const VAR_KIND_MODULE = 'module';
-const VAR_KIND_CLASS = 'class';
-const VAR_KIND_INSTANCE = 'instance';
+const FIELD_MODULE_OR_CLASS_NAME = 'MODULE_OR_CLASS';
+const FIELD_VARIABLE_NAME = 'VAR';
// Variables and functions used for populating the drop down field for the variable names.
@@ -51,30 +59,82 @@ function createKey(
export function initializeModuleVariableSetter(
moduleName: string, varType: string, varNames: string[], tooltips: string[]): void {
- const key = createKey(VAR_KIND_MODULE, moduleName, varType);
+ const key = createKey(VariableKind.MODULE, moduleName, varType);
PythonVariableSetterNames[key] = varNames;
PythonVariableSetterTooltips[key] = tooltips;
}
export function initializeClassVariableSetter(
className: string, varType: string, varNames: string[], tooltips: string[]): void {
- const key = createKey(VAR_KIND_CLASS, className, varType);
+ const key = createKey(VariableKind.CLASS, className, varType);
PythonVariableSetterNames[key] = varNames;
PythonVariableSetterTooltips[key] = tooltips;
}
export function initializeInstanceVariableSetter(
className: string, varType: string, varNames: string[], tooltips: string[]): void {
- const key = createKey(VAR_KIND_INSTANCE, className, varType);
+ const key = createKey(VariableKind.INSTANCE, className, varType);
PythonVariableSetterNames[key] = varNames;
PythonVariableSetterTooltips[key] = tooltips;
}
+// Functions used for creating blocks for the toolbox.
+
+export function createModuleOrClassVariableSetterBlock(
+ varKind: VariableKind,
+ importModule: string,
+ moduleOrClassName: string,
+ varType: string,
+ varName: string): toolboxItems.Block {
+ const extraState: SetPythonVariableExtraState = {
+ varKind: varKind,
+ moduleOrClassName: moduleOrClassName,
+ varType: varType,
+ importModule: importModule,
+ };
+ const fields: {[key: string]: any} = {};
+ fields[FIELD_MODULE_OR_CLASS_NAME] = moduleOrClassName;
+ fields[FIELD_VARIABLE_NAME] = varName;
+ const inputs: {[key: string]: any} = {};
+ const valueVarName = variable.varNameForType(varType);
+ if (valueVarName) {
+ inputs['VALUE'] = variable.createVariableGetterBlockValue(valueVarName);
+ }
+ return new toolboxItems.Block(BLOCK_NAME, extraState, fields, Object.keys(inputs).length ? inputs : null);
+}
+
+export function createInstanceVariableSetterBlock(
+ className: string,
+ varType: string,
+ varName: string): toolboxItems.Block {
+ const selfLabel = variable.getSelfArgName(className);
+ const extraState: SetPythonVariableExtraState = {
+ varKind: VariableKind.INSTANCE,
+ moduleOrClassName: className,
+ varType: varType,
+ selfLabel: selfLabel,
+ selfType: className,
+ };
+ const fields: {[key: string]: any} = {};
+ fields[FIELD_MODULE_OR_CLASS_NAME] = className;
+ fields[FIELD_VARIABLE_NAME] = varName;
+ const inputs: {[key: string]: any} = {};
+ const valueVarName = variable.varNameForType(varType);
+ if (valueVarName) {
+ inputs['VALUE'] = variable.createVariableGetterBlockValue(valueVarName);
+ }
+ const selfVarName = variable.varNameForType(className);
+ if (selfVarName) {
+ inputs['SELF'] = variable.createVariableGetterBlockValue(selfVarName);
+ }
+ return new toolboxItems.Block(BLOCK_NAME, extraState, fields, Object.keys(inputs).length ? inputs : null);
+}
+
//..............................................................................
type SetPythonVariableBlock = Blockly.Block & SetPythonVariableMixin;
interface SetPythonVariableMixin extends SetPythonVariableMixinType {
- mrcVarKind: string, // module, class, or instance
+ mrcVarKind: VariableKind,
mrcModuleOrClassName: string,
mrcVarType: string,
mrcSelfLabel: string,
@@ -121,7 +181,7 @@ type SetPythonVariableExtraState = {
* True if this blocks refers to an exported variable (for example, from a
* user's Project).
*/
- exportedVariable: boolean,
+ exportedVariable?: boolean,
};
const SET_PYTHON_VARIABLE = {
@@ -131,25 +191,25 @@ const SET_PYTHON_VARIABLE = {
init: function(this: SetPythonVariableBlock): void {
this.appendValueInput('VALUE')
.appendField('set')
- .appendField(createFieldNonEditableText(''), pythonUtils.FIELD_MODULE_OR_CLASS_NAME)
+ .appendField(createFieldNonEditableText(''), FIELD_MODULE_OR_CLASS_NAME)
.appendField('.');
this.setStyle(MRC_STYLE_VARIABLES);
this.setTooltip(() => {
- const varName = this.getFieldValue(pythonUtils.FIELD_VARIABLE_NAME);
+ const varName = this.getFieldValue(FIELD_VARIABLE_NAME);
let tooltip: string;
switch (this.mrcVarKind) {
- case VAR_KIND_MODULE: {
- const moduleName = this.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ case VariableKind.MODULE: {
+ const moduleName = this.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
tooltip = 'Sets the variable ' + moduleName + '.' + varName + '.';
break;
}
- case VAR_KIND_CLASS: {
- const className = this.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ case VariableKind.CLASS: {
+ const className = this.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
tooltip = 'Sets the variable ' + className + '.' + varName + '.';
break;
}
- case VAR_KIND_INSTANCE: {
- const className = this.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ case VariableKind.INSTANCE: {
+ const className = this.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
tooltip = 'Sets the variable ' + varName + ' for the given ' + className + ' object.';
break;
}
@@ -206,7 +266,7 @@ const SET_PYTHON_VARIABLE = {
this: SetPythonVariableBlock,
extraState: SetPythonVariableExtraState
): void {
- this.mrcVarKind = extraState.varKind;
+ this.mrcVarKind = extraState.varKind as VariableKind;
this.mrcModuleOrClassName = extraState.moduleOrClassName;
this.mrcVarType = extraState.varType ? extraState.varType : '';
this.mrcSelfLabel = extraState.selfLabel ? extraState.selfLabel : '';
@@ -232,9 +292,9 @@ const SET_PYTHON_VARIABLE = {
const varNames = PythonVariableSetterNames[this.mrcKey];
if (varNames) {
// Create the drop-down with the variable names.
- input.appendField(createFieldDropdown(varNames), pythonUtils.FIELD_VARIABLE_NAME);
+ input.appendField(createFieldDropdown(varNames), FIELD_VARIABLE_NAME);
} else {
- input.appendField(createFieldNonEditableText(''), pythonUtils.FIELD_VARIABLE_NAME);
+ input.appendField(createFieldNonEditableText(''), FIELD_VARIABLE_NAME);
}
input.appendField('to');
if (this.mrcVarType) {
@@ -262,10 +322,10 @@ export const pythonFromBlock = function(
const setPythonVariableBlock = block as SetPythonVariableBlock;
const varName = setPythonVariableBlock.mrcActualVariableName
? setPythonVariableBlock.mrcActualVariableName
- : block.getFieldValue(pythonUtils.FIELD_VARIABLE_NAME);
+ : block.getFieldValue(FIELD_VARIABLE_NAME);
switch (setPythonVariableBlock.mrcVarKind) {
- case VAR_KIND_MODULE: {
- const moduleName = block.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ case VariableKind.MODULE: {
+ const moduleName = block.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
const value = generator.valueToCode(block, 'VALUE', Order.NONE);
if (setPythonVariableBlock.mrcImportModule) {
generator.addImport(setPythonVariableBlock.mrcImportModule);
@@ -273,8 +333,8 @@ export const pythonFromBlock = function(
const code = moduleName + '.' + varName + ' = ' + value + '\n';
return code;
}
- case VAR_KIND_CLASS: {
- const className = block.getFieldValue(pythonUtils.FIELD_MODULE_OR_CLASS_NAME);
+ case VariableKind.CLASS: {
+ const className = block.getFieldValue(FIELD_MODULE_OR_CLASS_NAME);
const value = generator.valueToCode(block, 'VALUE', Order.NONE);
if (setPythonVariableBlock.mrcImportModule) {
generator.addImport(setPythonVariableBlock.mrcImportModule);
@@ -282,7 +342,7 @@ export const pythonFromBlock = function(
const code = className + '.' + varName + ' = ' + value + '\n';
return code;
}
- case VAR_KIND_INSTANCE: {
+ case VariableKind.INSTANCE: {
const selfValue = generator.valueToCode(block, 'SELF', Order.MEMBER);
const value = generator.valueToCode(block, 'VALUE', Order.NONE);
const code = selfValue + '.' + varName + ' = ' + value + '\n';
diff --git a/src/blocks/utils/generated/initialize.ts b/src/blocks/utils/generated/initialize.ts
deleted file mode 100644
index 75c3ac4e..00000000
--- a/src/blocks/utils/generated/initialize.ts
+++ /dev/null
@@ -1,949 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as hal from '../../generated/module_hal';
-import * as hal_AddressableLEDData from '../../generated/class_hal.AddressableLEDData';
-import * as hal_CANStreamMessage from '../../generated/class_hal.CANStreamMessage';
-import * as hal_ControlWord from '../../generated/class_hal.ControlWord';
-import * as hal_JoystickAxes from '../../generated/class_hal.JoystickAxes';
-import * as hal_JoystickButtons from '../../generated/class_hal.JoystickButtons';
-import * as hal_JoystickDescriptor from '../../generated/class_hal.JoystickDescriptor';
-import * as hal_JoystickPOVs from '../../generated/class_hal.JoystickPOVs';
-import * as hal_MatchInfo from '../../generated/class_hal.MatchInfo';
-import * as hal_PowerDistributionFaults from '../../generated/class_hal.PowerDistributionFaults';
-import * as hal_PowerDistributionStickyFaults from '../../generated/class_hal.PowerDistributionStickyFaults';
-import * as hal_PowerDistributionVersion from '../../generated/class_hal.PowerDistributionVersion';
-import * as hal_REVPHCompressorConfig from '../../generated/class_hal.REVPHCompressorConfig';
-import * as hal_REVPHFaults from '../../generated/class_hal.REVPHFaults';
-import * as hal_REVPHStickyFaults from '../../generated/class_hal.REVPHStickyFaults';
-import * as hal_REVPHVersion from '../../generated/class_hal.REVPHVersion';
-import * as hal_SimBoolean from '../../generated/class_hal.SimBoolean';
-import * as hal_SimDevice from '../../generated/class_hal.SimDevice';
-import * as hal_SimDouble from '../../generated/class_hal.SimDouble';
-import * as hal_SimEnum from '../../generated/class_hal.SimEnum';
-import * as hal_SimInt from '../../generated/class_hal.SimInt';
-import * as hal_SimLong from '../../generated/class_hal.SimLong';
-import * as hal_SimValue from '../../generated/class_hal.SimValue';
-import * as hal_Value from '../../generated/class_hal.Value';
-import * as hal_exceptions from '../../generated/module_hal.exceptions';
-import * as hal_exceptions_HALError from '../../generated/class_hal.exceptions.HALError';
-import * as hal_simulation from '../../generated/module_hal.simulation';
-import * as hal_simulation_NotifierInfo from '../../generated/class_hal.simulation.NotifierInfo';
-import * as hal_simulation_SimCB from '../../generated/class_hal.simulation.SimCB';
-import * as hal_simulation_SimValueCB from '../../generated/class_hal.simulation.SimValueCB';
-import * as wpilib from '../../generated/module_wpilib';
-import * as wpilib_ADIS16448_IMU from '../../generated/class_wpilib.ADIS16448_IMU';
-import * as wpilib_ADIS16470_IMU from '../../generated/class_wpilib.ADIS16470_IMU';
-import * as wpilib_ADXL345_I2C from '../../generated/class_wpilib.ADXL345_I2C';
-import * as wpilib_ADXL345_I2C_AllAxes from '../../generated/class_wpilib.ADXL345_I2C.AllAxes';
-import * as wpilib_ADXL345_SPI from '../../generated/class_wpilib.ADXL345_SPI';
-import * as wpilib_ADXL345_SPI_AllAxes from '../../generated/class_wpilib.ADXL345_SPI.AllAxes';
-import * as wpilib_ADXL362 from '../../generated/class_wpilib.ADXL362';
-import * as wpilib_ADXL362_AllAxes from '../../generated/class_wpilib.ADXL362.AllAxes';
-import * as wpilib_ADXRS450_Gyro from '../../generated/class_wpilib.ADXRS450_Gyro';
-import * as wpilib_AddressableLED from '../../generated/class_wpilib.AddressableLED';
-import * as wpilib_AddressableLED_LEDData from '../../generated/class_wpilib.AddressableLED.LEDData';
-import * as wpilib_Alert from '../../generated/class_wpilib.Alert';
-import * as wpilib_AnalogAccelerometer from '../../generated/class_wpilib.AnalogAccelerometer';
-import * as wpilib_AnalogEncoder from '../../generated/class_wpilib.AnalogEncoder';
-import * as wpilib_AnalogGyro from '../../generated/class_wpilib.AnalogGyro';
-import * as wpilib_AnalogInput from '../../generated/class_wpilib.AnalogInput';
-import * as wpilib_AnalogOutput from '../../generated/class_wpilib.AnalogOutput';
-import * as wpilib_AnalogPotentiometer from '../../generated/class_wpilib.AnalogPotentiometer';
-import * as wpilib_AnalogTrigger from '../../generated/class_wpilib.AnalogTrigger';
-import * as wpilib_AnalogTriggerOutput from '../../generated/class_wpilib.AnalogTriggerOutput';
-import * as wpilib_BuiltInAccelerometer from '../../generated/class_wpilib.BuiltInAccelerometer';
-import * as wpilib_CAN from '../../generated/class_wpilib.CAN';
-import * as wpilib_CANData from '../../generated/class_wpilib.CANData';
-import * as wpilib_CANStatus from '../../generated/class_wpilib.CANStatus';
-import * as wpilib_Color from '../../generated/class_wpilib.Color';
-import * as wpilib_Color8Bit from '../../generated/class_wpilib.Color8Bit';
-import * as wpilib_Compressor from '../../generated/class_wpilib.Compressor';
-import * as wpilib_Counter from '../../generated/class_wpilib.Counter';
-import * as wpilib_DMC60 from '../../generated/class_wpilib.DMC60';
-import * as wpilib_DSControlWord from '../../generated/class_wpilib.DSControlWord';
-import * as wpilib_DataLogManager from '../../generated/class_wpilib.DataLogManager';
-import * as wpilib_DigitalGlitchFilter from '../../generated/class_wpilib.DigitalGlitchFilter';
-import * as wpilib_DigitalInput from '../../generated/class_wpilib.DigitalInput';
-import * as wpilib_DigitalOutput from '../../generated/class_wpilib.DigitalOutput';
-import * as wpilib_DigitalSource from '../../generated/class_wpilib.DigitalSource';
-import * as wpilib_DoubleSolenoid from '../../generated/class_wpilib.DoubleSolenoid';
-import * as wpilib_DriverStation from '../../generated/class_wpilib.DriverStation';
-import * as wpilib_DutyCycle from '../../generated/class_wpilib.DutyCycle';
-import * as wpilib_DutyCycleEncoder from '../../generated/class_wpilib.DutyCycleEncoder';
-import * as wpilib_Encoder from '../../generated/class_wpilib.Encoder';
-import * as wpilib_Field2d from '../../generated/class_wpilib.Field2d';
-import * as wpilib_FieldObject2d from '../../generated/class_wpilib.FieldObject2d';
-import * as wpilib_I2C from '../../generated/class_wpilib.I2C';
-import * as wpilib_IterativeRobotBase from '../../generated/class_wpilib.IterativeRobotBase';
-import * as wpilib_Jaguar from '../../generated/class_wpilib.Jaguar';
-import * as wpilib_Joystick from '../../generated/class_wpilib.Joystick';
-import * as wpilib_LEDPattern from '../../generated/class_wpilib.LEDPattern';
-import * as wpilib_LEDPattern_LEDReader from '../../generated/class_wpilib.LEDPattern.LEDReader';
-import * as wpilib_LiveWindow from '../../generated/class_wpilib.LiveWindow';
-import * as wpilib_Mechanism2d from '../../generated/class_wpilib.Mechanism2d';
-import * as wpilib_MechanismLigament2d from '../../generated/class_wpilib.MechanismLigament2d';
-import * as wpilib_MechanismObject2d from '../../generated/class_wpilib.MechanismObject2d';
-import * as wpilib_MechanismRoot2d from '../../generated/class_wpilib.MechanismRoot2d';
-import * as wpilib_MotorControllerGroup from '../../generated/class_wpilib.MotorControllerGroup';
-import * as wpilib_MotorSafety from '../../generated/class_wpilib.MotorSafety';
-import * as wpilib_NidecBrushless from '../../generated/class_wpilib.NidecBrushless';
-import * as wpilib_Notifier from '../../generated/class_wpilib.Notifier';
-import * as wpilib_PS4Controller from '../../generated/class_wpilib.PS4Controller';
-import * as wpilib_PS4Controller_Axis from '../../generated/class_wpilib.PS4Controller.Axis';
-import * as wpilib_PS4Controller_Button from '../../generated/class_wpilib.PS4Controller.Button';
-import * as wpilib_PS5Controller from '../../generated/class_wpilib.PS5Controller';
-import * as wpilib_PS5Controller_Axis from '../../generated/class_wpilib.PS5Controller.Axis';
-import * as wpilib_PS5Controller_Button from '../../generated/class_wpilib.PS5Controller.Button';
-import * as wpilib_PWM from '../../generated/class_wpilib.PWM';
-import * as wpilib_PWMMotorController from '../../generated/class_wpilib.PWMMotorController';
-import * as wpilib_PWMSparkFlex from '../../generated/class_wpilib.PWMSparkFlex';
-import * as wpilib_PWMSparkMax from '../../generated/class_wpilib.PWMSparkMax';
-import * as wpilib_PWMTalonFX from '../../generated/class_wpilib.PWMTalonFX';
-import * as wpilib_PWMTalonSRX from '../../generated/class_wpilib.PWMTalonSRX';
-import * as wpilib_PWMVenom from '../../generated/class_wpilib.PWMVenom';
-import * as wpilib_PWMVictorSPX from '../../generated/class_wpilib.PWMVictorSPX';
-import * as wpilib_PneumaticHub from '../../generated/class_wpilib.PneumaticHub';
-import * as wpilib_PneumaticHub_Faults from '../../generated/class_wpilib.PneumaticHub.Faults';
-import * as wpilib_PneumaticHub_StickyFaults from '../../generated/class_wpilib.PneumaticHub.StickyFaults';
-import * as wpilib_PneumaticHub_Version from '../../generated/class_wpilib.PneumaticHub.Version';
-import * as wpilib_PneumaticsBase from '../../generated/class_wpilib.PneumaticsBase';
-import * as wpilib_PneumaticsControlModule from '../../generated/class_wpilib.PneumaticsControlModule';
-import * as wpilib_PowerDistribution from '../../generated/class_wpilib.PowerDistribution';
-import * as wpilib_PowerDistribution_Faults from '../../generated/class_wpilib.PowerDistribution.Faults';
-import * as wpilib_PowerDistribution_StickyFaults from '../../generated/class_wpilib.PowerDistribution.StickyFaults';
-import * as wpilib_PowerDistribution_Version from '../../generated/class_wpilib.PowerDistribution.Version';
-import * as wpilib_Preferences from '../../generated/class_wpilib.Preferences';
-import * as wpilib_Relay from '../../generated/class_wpilib.Relay';
-import * as wpilib_RobotBase from '../../generated/class_wpilib.RobotBase';
-import * as wpilib_RobotController from '../../generated/class_wpilib.RobotController';
-import * as wpilib_RobotState from '../../generated/class_wpilib.RobotState';
-import * as wpilib_SD540 from '../../generated/class_wpilib.SD540';
-import * as wpilib_SPI from '../../generated/class_wpilib.SPI';
-import * as wpilib_SendableBuilderImpl from '../../generated/class_wpilib.SendableBuilderImpl';
-import * as wpilib_SendableChooser from '../../generated/class_wpilib.SendableChooser';
-import * as wpilib_SendableChooserBase from '../../generated/class_wpilib.SendableChooserBase';
-import * as wpilib_SensorUtil from '../../generated/class_wpilib.SensorUtil';
-import * as wpilib_SerialPort from '../../generated/class_wpilib.SerialPort';
-import * as wpilib_Servo from '../../generated/class_wpilib.Servo';
-import * as wpilib_SharpIR from '../../generated/class_wpilib.SharpIR';
-import * as wpilib_SmartDashboard from '../../generated/class_wpilib.SmartDashboard';
-import * as wpilib_Solenoid from '../../generated/class_wpilib.Solenoid';
-import * as wpilib_Spark from '../../generated/class_wpilib.Spark';
-import * as wpilib_StadiaController from '../../generated/class_wpilib.StadiaController';
-import * as wpilib_StadiaController_Axis from '../../generated/class_wpilib.StadiaController.Axis';
-import * as wpilib_StadiaController_Button from '../../generated/class_wpilib.StadiaController.Button';
-import * as wpilib_SynchronousInterrupt from '../../generated/class_wpilib.SynchronousInterrupt';
-import * as wpilib_Talon from '../../generated/class_wpilib.Talon';
-import * as wpilib_TimedRobot from '../../generated/class_wpilib.TimedRobot';
-import * as wpilib_Timer from '../../generated/class_wpilib.Timer';
-import * as wpilib_TimesliceRobot from '../../generated/class_wpilib.TimesliceRobot';
-import * as wpilib_Tracer from '../../generated/class_wpilib.Tracer';
-import * as wpilib_Ultrasonic from '../../generated/class_wpilib.Ultrasonic';
-import * as wpilib_Victor from '../../generated/class_wpilib.Victor';
-import * as wpilib_VictorSP from '../../generated/class_wpilib.VictorSP';
-import * as wpilib_Watchdog from '../../generated/class_wpilib.Watchdog';
-import * as wpilib_XboxController from '../../generated/class_wpilib.XboxController';
-import * as wpilib_XboxController_Axis from '../../generated/class_wpilib.XboxController.Axis';
-import * as wpilib_XboxController_Button from '../../generated/class_wpilib.XboxController.Button';
-import * as wpilib_cameraserver from '../../generated/module_wpilib.cameraserver';
-import * as wpilib_cameraserver_CameraServer from '../../generated/class_wpilib.cameraserver.CameraServer';
-import * as wpilib_counter from '../../generated/module_wpilib.counter';
-import * as wpilib_counter_ExternalDirectionCounter from '../../generated/class_wpilib.counter.ExternalDirectionCounter';
-import * as wpilib_counter_Tachometer from '../../generated/class_wpilib.counter.Tachometer';
-import * as wpilib_counter_UpDownCounter from '../../generated/class_wpilib.counter.UpDownCounter';
-import * as wpilib_drive from '../../generated/module_wpilib.drive';
-import * as wpilib_drive_DifferentialDrive from '../../generated/class_wpilib.drive.DifferentialDrive';
-import * as wpilib_drive_DifferentialDrive_WheelSpeeds from '../../generated/class_wpilib.drive.DifferentialDrive.WheelSpeeds';
-import * as wpilib_drive_MecanumDrive from '../../generated/class_wpilib.drive.MecanumDrive';
-import * as wpilib_drive_MecanumDrive_WheelSpeeds from '../../generated/class_wpilib.drive.MecanumDrive.WheelSpeeds';
-import * as wpilib_drive_RobotDriveBase from '../../generated/class_wpilib.drive.RobotDriveBase';
-import * as wpilib_event from '../../generated/module_wpilib.event';
-import * as wpilib_event_BooleanEvent from '../../generated/class_wpilib.event.BooleanEvent';
-import * as wpilib_event_EventLoop from '../../generated/class_wpilib.event.EventLoop';
-import * as wpilib_event_NetworkBooleanEvent from '../../generated/class_wpilib.event.NetworkBooleanEvent';
-import * as wpilib_interfaces from '../../generated/module_wpilib.interfaces';
-import * as wpilib_interfaces_CounterBase from '../../generated/class_wpilib.interfaces.CounterBase';
-import * as wpilib_interfaces_GenericHID from '../../generated/class_wpilib.interfaces.GenericHID';
-import * as wpilib_interfaces_MotorController from '../../generated/class_wpilib.interfaces.MotorController';
-import * as wpilib_shuffleboard from '../../generated/module_wpilib.shuffleboard';
-import * as wpilib_shuffleboard_ComplexWidget from '../../generated/class_wpilib.shuffleboard.ComplexWidget';
-import * as wpilib_shuffleboard_LayoutType from '../../generated/class_wpilib.shuffleboard.LayoutType';
-import * as wpilib_shuffleboard_Shuffleboard from '../../generated/class_wpilib.shuffleboard.Shuffleboard';
-import * as wpilib_shuffleboard_ShuffleboardComponentBase from '../../generated/class_wpilib.shuffleboard.ShuffleboardComponentBase';
-import * as wpilib_shuffleboard_ShuffleboardContainer from '../../generated/class_wpilib.shuffleboard.ShuffleboardContainer';
-import * as wpilib_shuffleboard_ShuffleboardLayout from '../../generated/class_wpilib.shuffleboard.ShuffleboardLayout';
-import * as wpilib_shuffleboard_ShuffleboardTab from '../../generated/class_wpilib.shuffleboard.ShuffleboardTab';
-import * as wpilib_shuffleboard_ShuffleboardValue from '../../generated/class_wpilib.shuffleboard.ShuffleboardValue';
-import * as wpilib_shuffleboard_SimpleWidget from '../../generated/class_wpilib.shuffleboard.SimpleWidget';
-import * as wpilib_shuffleboard_SuppliedBoolListValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedBoolListValueWidget';
-import * as wpilib_shuffleboard_SuppliedBoolValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedBoolValueWidget';
-import * as wpilib_shuffleboard_SuppliedDoubleListValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedDoubleListValueWidget';
-import * as wpilib_shuffleboard_SuppliedDoubleValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedDoubleValueWidget';
-import * as wpilib_shuffleboard_SuppliedFloatListValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedFloatListValueWidget';
-import * as wpilib_shuffleboard_SuppliedFloatValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedFloatValueWidget';
-import * as wpilib_shuffleboard_SuppliedIntListValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedIntListValueWidget';
-import * as wpilib_shuffleboard_SuppliedIntegerValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedIntegerValueWidget';
-import * as wpilib_shuffleboard_SuppliedRawValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedRawValueWidget';
-import * as wpilib_shuffleboard_SuppliedStringListValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedStringListValueWidget';
-import * as wpilib_shuffleboard_SuppliedStringValueWidget from '../../generated/class_wpilib.shuffleboard.SuppliedStringValueWidget';
-import * as wpilib_shuffleboard_WidgetType from '../../generated/class_wpilib.shuffleboard.WidgetType';
-import * as wpilib_shuffleboard__ComplexComponent from '../../generated/class_wpilib.shuffleboard._ComplexComponent';
-import * as wpilib_shuffleboard__ComplexWidget from '../../generated/class_wpilib.shuffleboard._ComplexWidget';
-import * as wpilib_shuffleboard__LayoutComponent from '../../generated/class_wpilib.shuffleboard._LayoutComponent';
-import * as wpilib_shuffleboard__SimpleComponent from '../../generated/class_wpilib.shuffleboard._SimpleComponent';
-import * as wpilib_shuffleboard__SimpleWidget from '../../generated/class_wpilib.shuffleboard._SimpleWidget';
-import * as wpilib_shuffleboard__SuppliedValueComponent_bool from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_bool';
-import * as wpilib_shuffleboard__SuppliedValueComponent_double from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_double';
-import * as wpilib_shuffleboard__SuppliedValueComponent_float from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_float';
-import * as wpilib_shuffleboard__SuppliedValueComponent_integer from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_integer';
-import * as wpilib_shuffleboard__SuppliedValueComponent_string from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_string';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_bool from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_bool';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_double from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_double';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_float from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_float';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_int from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_int';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_raw from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_raw';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_string from '../../generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_string';
-import * as wpilib_shuffleboard__SuppliedValueWidget_bool from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_bool';
-import * as wpilib_shuffleboard__SuppliedValueWidget_double from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_double';
-import * as wpilib_shuffleboard__SuppliedValueWidget_float from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_float';
-import * as wpilib_shuffleboard__SuppliedValueWidget_integer from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_integer';
-import * as wpilib_shuffleboard__SuppliedValueWidget_string from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_string';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_bool from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_bool';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_double from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_double';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_float from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_float';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_int from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_int';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_raw from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_raw';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_string from '../../generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_string';
-import * as wpilib_simulation from '../../generated/module_wpilib.simulation';
-import * as wpilib_simulation_ADIS16448_IMUSim from '../../generated/class_wpilib.simulation.ADIS16448_IMUSim';
-import * as wpilib_simulation_ADIS16470_IMUSim from '../../generated/class_wpilib.simulation.ADIS16470_IMUSim';
-import * as wpilib_simulation_ADXL345Sim from '../../generated/class_wpilib.simulation.ADXL345Sim';
-import * as wpilib_simulation_ADXL362Sim from '../../generated/class_wpilib.simulation.ADXL362Sim';
-import * as wpilib_simulation_ADXRS450_GyroSim from '../../generated/class_wpilib.simulation.ADXRS450_GyroSim';
-import * as wpilib_simulation_AddressableLEDSim from '../../generated/class_wpilib.simulation.AddressableLEDSim';
-import * as wpilib_simulation_AnalogEncoderSim from '../../generated/class_wpilib.simulation.AnalogEncoderSim';
-import * as wpilib_simulation_AnalogGyroSim from '../../generated/class_wpilib.simulation.AnalogGyroSim';
-import * as wpilib_simulation_AnalogInputSim from '../../generated/class_wpilib.simulation.AnalogInputSim';
-import * as wpilib_simulation_AnalogOutputSim from '../../generated/class_wpilib.simulation.AnalogOutputSim';
-import * as wpilib_simulation_AnalogTriggerSim from '../../generated/class_wpilib.simulation.AnalogTriggerSim';
-import * as wpilib_simulation_BatterySim from '../../generated/class_wpilib.simulation.BatterySim';
-import * as wpilib_simulation_BuiltInAccelerometerSim from '../../generated/class_wpilib.simulation.BuiltInAccelerometerSim';
-import * as wpilib_simulation_CTREPCMSim from '../../generated/class_wpilib.simulation.CTREPCMSim';
-import * as wpilib_simulation_CallbackStore from '../../generated/class_wpilib.simulation.CallbackStore';
-import * as wpilib_simulation_DCMotorSim from '../../generated/class_wpilib.simulation.DCMotorSim';
-import * as wpilib_simulation_DIOSim from '../../generated/class_wpilib.simulation.DIOSim';
-import * as wpilib_simulation_DifferentialDrivetrainSim from '../../generated/class_wpilib.simulation.DifferentialDrivetrainSim';
-import * as wpilib_simulation_DifferentialDrivetrainSim_KitbotGearing from '../../generated/class_wpilib.simulation.DifferentialDrivetrainSim.KitbotGearing';
-import * as wpilib_simulation_DifferentialDrivetrainSim_KitbotMotor from '../../generated/class_wpilib.simulation.DifferentialDrivetrainSim.KitbotMotor';
-import * as wpilib_simulation_DifferentialDrivetrainSim_KitbotWheelSize from '../../generated/class_wpilib.simulation.DifferentialDrivetrainSim.KitbotWheelSize';
-import * as wpilib_simulation_DifferentialDrivetrainSim_State from '../../generated/class_wpilib.simulation.DifferentialDrivetrainSim.State';
-import * as wpilib_simulation_DigitalPWMSim from '../../generated/class_wpilib.simulation.DigitalPWMSim';
-import * as wpilib_simulation_DoubleSolenoidSim from '../../generated/class_wpilib.simulation.DoubleSolenoidSim';
-import * as wpilib_simulation_DriverStationSim from '../../generated/class_wpilib.simulation.DriverStationSim';
-import * as wpilib_simulation_DutyCycleEncoderSim from '../../generated/class_wpilib.simulation.DutyCycleEncoderSim';
-import * as wpilib_simulation_DutyCycleSim from '../../generated/class_wpilib.simulation.DutyCycleSim';
-import * as wpilib_simulation_ElevatorSim from '../../generated/class_wpilib.simulation.ElevatorSim';
-import * as wpilib_simulation_EncoderSim from '../../generated/class_wpilib.simulation.EncoderSim';
-import * as wpilib_simulation_FlywheelSim from '../../generated/class_wpilib.simulation.FlywheelSim';
-import * as wpilib_simulation_GenericHIDSim from '../../generated/class_wpilib.simulation.GenericHIDSim';
-import * as wpilib_simulation_JoystickSim from '../../generated/class_wpilib.simulation.JoystickSim';
-import * as wpilib_simulation_LinearSystemSim_1_1_1 from '../../generated/class_wpilib.simulation.LinearSystemSim_1_1_1';
-import * as wpilib_simulation_LinearSystemSim_1_1_2 from '../../generated/class_wpilib.simulation.LinearSystemSim_1_1_2';
-import * as wpilib_simulation_LinearSystemSim_2_1_1 from '../../generated/class_wpilib.simulation.LinearSystemSim_2_1_1';
-import * as wpilib_simulation_LinearSystemSim_2_1_2 from '../../generated/class_wpilib.simulation.LinearSystemSim_2_1_2';
-import * as wpilib_simulation_LinearSystemSim_2_2_1 from '../../generated/class_wpilib.simulation.LinearSystemSim_2_2_1';
-import * as wpilib_simulation_LinearSystemSim_2_2_2 from '../../generated/class_wpilib.simulation.LinearSystemSim_2_2_2';
-import * as wpilib_simulation_PS4ControllerSim from '../../generated/class_wpilib.simulation.PS4ControllerSim';
-import * as wpilib_simulation_PS5ControllerSim from '../../generated/class_wpilib.simulation.PS5ControllerSim';
-import * as wpilib_simulation_PWMSim from '../../generated/class_wpilib.simulation.PWMSim';
-import * as wpilib_simulation_PneumaticsBaseSim from '../../generated/class_wpilib.simulation.PneumaticsBaseSim';
-import * as wpilib_simulation_PowerDistributionSim from '../../generated/class_wpilib.simulation.PowerDistributionSim';
-import * as wpilib_simulation_REVPHSim from '../../generated/class_wpilib.simulation.REVPHSim';
-import * as wpilib_simulation_RelaySim from '../../generated/class_wpilib.simulation.RelaySim';
-import * as wpilib_simulation_RoboRioSim from '../../generated/class_wpilib.simulation.RoboRioSim';
-import * as wpilib_simulation_SPIAccelerometerSim from '../../generated/class_wpilib.simulation.SPIAccelerometerSim';
-import * as wpilib_simulation_SendableChooserSim from '../../generated/class_wpilib.simulation.SendableChooserSim';
-import * as wpilib_simulation_SharpIRSim from '../../generated/class_wpilib.simulation.SharpIRSim';
-import * as wpilib_simulation_SimDeviceSim from '../../generated/class_wpilib.simulation.SimDeviceSim';
-import * as wpilib_simulation_SingleJointedArmSim from '../../generated/class_wpilib.simulation.SingleJointedArmSim';
-import * as wpilib_simulation_SolenoidSim from '../../generated/class_wpilib.simulation.SolenoidSim';
-import * as wpilib_simulation_StadiaControllerSim from '../../generated/class_wpilib.simulation.StadiaControllerSim';
-import * as wpilib_simulation_UltrasonicSim from '../../generated/class_wpilib.simulation.UltrasonicSim';
-import * as wpilib_simulation_XboxControllerSim from '../../generated/class_wpilib.simulation.XboxControllerSim';
-import * as wpilib_sysid_SysIdRoutineLog from '../../generated/class_wpilib.sysid.SysIdRoutineLog';
-import * as wpilib_sysid_SysIdRoutineLog_MotorLog from '../../generated/class_wpilib.sysid.SysIdRoutineLog.MotorLog';
-import * as wpimath from '../../generated/module_wpimath';
-import * as wpimath_controller from '../../generated/module_wpimath.controller';
-import * as wpimath_controller_ArmFeedforward from '../../generated/class_wpimath.controller.ArmFeedforward';
-import * as wpimath_controller_BangBangController from '../../generated/class_wpimath.controller.BangBangController';
-import * as wpimath_controller_ControlAffinePlantInversionFeedforward_1_1 from '../../generated/class_wpimath.controller.ControlAffinePlantInversionFeedforward_1_1';
-import * as wpimath_controller_ControlAffinePlantInversionFeedforward_2_1 from '../../generated/class_wpimath.controller.ControlAffinePlantInversionFeedforward_2_1';
-import * as wpimath_controller_ControlAffinePlantInversionFeedforward_2_2 from '../../generated/class_wpimath.controller.ControlAffinePlantInversionFeedforward_2_2';
-import * as wpimath_controller_DifferentialDriveAccelerationLimiter from '../../generated/class_wpimath.controller.DifferentialDriveAccelerationLimiter';
-import * as wpimath_controller_DifferentialDriveWheelVoltages from '../../generated/class_wpimath.controller.DifferentialDriveWheelVoltages';
-import * as wpimath_controller_ElevatorFeedforward from '../../generated/class_wpimath.controller.ElevatorFeedforward';
-import * as wpimath_controller_HolonomicDriveController from '../../generated/class_wpimath.controller.HolonomicDriveController';
-import * as wpimath_controller_ImplicitModelFollower_1_1 from '../../generated/class_wpimath.controller.ImplicitModelFollower_1_1';
-import * as wpimath_controller_ImplicitModelFollower_2_1 from '../../generated/class_wpimath.controller.ImplicitModelFollower_2_1';
-import * as wpimath_controller_ImplicitModelFollower_2_2 from '../../generated/class_wpimath.controller.ImplicitModelFollower_2_2';
-import * as wpimath_controller_LTVDifferentialDriveController from '../../generated/class_wpimath.controller.LTVDifferentialDriveController';
-import * as wpimath_controller_LTVUnicycleController from '../../generated/class_wpimath.controller.LTVUnicycleController';
-import * as wpimath_controller_LinearPlantInversionFeedforward_1_1 from '../../generated/class_wpimath.controller.LinearPlantInversionFeedforward_1_1';
-import * as wpimath_controller_LinearPlantInversionFeedforward_2_1 from '../../generated/class_wpimath.controller.LinearPlantInversionFeedforward_2_1';
-import * as wpimath_controller_LinearPlantInversionFeedforward_2_2 from '../../generated/class_wpimath.controller.LinearPlantInversionFeedforward_2_2';
-import * as wpimath_controller_LinearPlantInversionFeedforward_3_2 from '../../generated/class_wpimath.controller.LinearPlantInversionFeedforward_3_2';
-import * as wpimath_controller_LinearQuadraticRegulator_1_1 from '../../generated/class_wpimath.controller.LinearQuadraticRegulator_1_1';
-import * as wpimath_controller_LinearQuadraticRegulator_2_1 from '../../generated/class_wpimath.controller.LinearQuadraticRegulator_2_1';
-import * as wpimath_controller_LinearQuadraticRegulator_2_2 from '../../generated/class_wpimath.controller.LinearQuadraticRegulator_2_2';
-import * as wpimath_controller_LinearQuadraticRegulator_3_2 from '../../generated/class_wpimath.controller.LinearQuadraticRegulator_3_2';
-import * as wpimath_controller_PIDController from '../../generated/class_wpimath.controller.PIDController';
-import * as wpimath_controller_ProfiledPIDController from '../../generated/class_wpimath.controller.ProfiledPIDController';
-import * as wpimath_controller_ProfiledPIDControllerRadians from '../../generated/class_wpimath.controller.ProfiledPIDControllerRadians';
-import * as wpimath_controller_RamseteController from '../../generated/class_wpimath.controller.RamseteController';
-import * as wpimath_controller_SimpleMotorFeedforwardMeters from '../../generated/class_wpimath.controller.SimpleMotorFeedforwardMeters';
-import * as wpimath_controller_SimpleMotorFeedforwardRadians from '../../generated/class_wpimath.controller.SimpleMotorFeedforwardRadians';
-import * as wpimath_estimator from '../../generated/module_wpimath.estimator';
-import * as wpimath_estimator_DifferentialDrivePoseEstimator from '../../generated/class_wpimath.estimator.DifferentialDrivePoseEstimator';
-import * as wpimath_estimator_DifferentialDrivePoseEstimator3d from '../../generated/class_wpimath.estimator.DifferentialDrivePoseEstimator3d';
-import * as wpimath_estimator_DifferentialDrivePoseEstimator3dBase from '../../generated/class_wpimath.estimator.DifferentialDrivePoseEstimator3dBase';
-import * as wpimath_estimator_DifferentialDrivePoseEstimatorBase from '../../generated/class_wpimath.estimator.DifferentialDrivePoseEstimatorBase';
-import * as wpimath_estimator_ExtendedKalmanFilter_1_1_1 from '../../generated/class_wpimath.estimator.ExtendedKalmanFilter_1_1_1';
-import * as wpimath_estimator_ExtendedKalmanFilter_2_1_1 from '../../generated/class_wpimath.estimator.ExtendedKalmanFilter_2_1_1';
-import * as wpimath_estimator_ExtendedKalmanFilter_2_2_2 from '../../generated/class_wpimath.estimator.ExtendedKalmanFilter_2_2_2';
-import * as wpimath_estimator_KalmanFilter_1_1_1 from '../../generated/class_wpimath.estimator.KalmanFilter_1_1_1';
-import * as wpimath_estimator_KalmanFilter_2_1_1 from '../../generated/class_wpimath.estimator.KalmanFilter_2_1_1';
-import * as wpimath_estimator_KalmanFilter_2_2_2 from '../../generated/class_wpimath.estimator.KalmanFilter_2_2_2';
-import * as wpimath_estimator_KalmanFilter_3_2_3 from '../../generated/class_wpimath.estimator.KalmanFilter_3_2_3';
-import * as wpimath_estimator_MecanumDrivePoseEstimator from '../../generated/class_wpimath.estimator.MecanumDrivePoseEstimator';
-import * as wpimath_estimator_MecanumDrivePoseEstimator3d from '../../generated/class_wpimath.estimator.MecanumDrivePoseEstimator3d';
-import * as wpimath_estimator_MecanumDrivePoseEstimator3dBase from '../../generated/class_wpimath.estimator.MecanumDrivePoseEstimator3dBase';
-import * as wpimath_estimator_MecanumDrivePoseEstimatorBase from '../../generated/class_wpimath.estimator.MecanumDrivePoseEstimatorBase';
-import * as wpimath_estimator_SwerveDrive2PoseEstimator from '../../generated/class_wpimath.estimator.SwerveDrive2PoseEstimator';
-import * as wpimath_estimator_SwerveDrive2PoseEstimator3d from '../../generated/class_wpimath.estimator.SwerveDrive2PoseEstimator3d';
-import * as wpimath_estimator_SwerveDrive2PoseEstimator3dBase from '../../generated/class_wpimath.estimator.SwerveDrive2PoseEstimator3dBase';
-import * as wpimath_estimator_SwerveDrive2PoseEstimatorBase from '../../generated/class_wpimath.estimator.SwerveDrive2PoseEstimatorBase';
-import * as wpimath_estimator_SwerveDrive3PoseEstimator from '../../generated/class_wpimath.estimator.SwerveDrive3PoseEstimator';
-import * as wpimath_estimator_SwerveDrive3PoseEstimator3d from '../../generated/class_wpimath.estimator.SwerveDrive3PoseEstimator3d';
-import * as wpimath_estimator_SwerveDrive3PoseEstimator3dBase from '../../generated/class_wpimath.estimator.SwerveDrive3PoseEstimator3dBase';
-import * as wpimath_estimator_SwerveDrive3PoseEstimatorBase from '../../generated/class_wpimath.estimator.SwerveDrive3PoseEstimatorBase';
-import * as wpimath_estimator_SwerveDrive4PoseEstimator from '../../generated/class_wpimath.estimator.SwerveDrive4PoseEstimator';
-import * as wpimath_estimator_SwerveDrive4PoseEstimator3d from '../../generated/class_wpimath.estimator.SwerveDrive4PoseEstimator3d';
-import * as wpimath_estimator_SwerveDrive4PoseEstimator3dBase from '../../generated/class_wpimath.estimator.SwerveDrive4PoseEstimator3dBase';
-import * as wpimath_estimator_SwerveDrive4PoseEstimatorBase from '../../generated/class_wpimath.estimator.SwerveDrive4PoseEstimatorBase';
-import * as wpimath_estimator_SwerveDrive6PoseEstimator from '../../generated/class_wpimath.estimator.SwerveDrive6PoseEstimator';
-import * as wpimath_estimator_SwerveDrive6PoseEstimator3d from '../../generated/class_wpimath.estimator.SwerveDrive6PoseEstimator3d';
-import * as wpimath_estimator_SwerveDrive6PoseEstimator3dBase from '../../generated/class_wpimath.estimator.SwerveDrive6PoseEstimator3dBase';
-import * as wpimath_estimator_SwerveDrive6PoseEstimatorBase from '../../generated/class_wpimath.estimator.SwerveDrive6PoseEstimatorBase';
-import * as wpimath_filter from '../../generated/module_wpimath.filter';
-import * as wpimath_filter_Debouncer from '../../generated/class_wpimath.filter.Debouncer';
-import * as wpimath_filter_LinearFilter from '../../generated/class_wpimath.filter.LinearFilter';
-import * as wpimath_filter_MedianFilter from '../../generated/class_wpimath.filter.MedianFilter';
-import * as wpimath_filter_SlewRateLimiter from '../../generated/class_wpimath.filter.SlewRateLimiter';
-import * as wpimath_geometry from '../../generated/module_wpimath.geometry';
-import * as wpimath_geometry_CoordinateAxis from '../../generated/class_wpimath.geometry.CoordinateAxis';
-import * as wpimath_geometry_CoordinateSystem from '../../generated/class_wpimath.geometry.CoordinateSystem';
-import * as wpimath_geometry_Ellipse2d from '../../generated/class_wpimath.geometry.Ellipse2d';
-import * as wpimath_geometry_Pose2d from '../../generated/class_wpimath.geometry.Pose2d';
-import * as wpimath_geometry_Pose3d from '../../generated/class_wpimath.geometry.Pose3d';
-import * as wpimath_geometry_Quaternion from '../../generated/class_wpimath.geometry.Quaternion';
-import * as wpimath_geometry_Rectangle2d from '../../generated/class_wpimath.geometry.Rectangle2d';
-import * as wpimath_geometry_Rotation2d from '../../generated/class_wpimath.geometry.Rotation2d';
-import * as wpimath_geometry_Rotation3d from '../../generated/class_wpimath.geometry.Rotation3d';
-import * as wpimath_geometry_Transform2d from '../../generated/class_wpimath.geometry.Transform2d';
-import * as wpimath_geometry_Transform3d from '../../generated/class_wpimath.geometry.Transform3d';
-import * as wpimath_geometry_Translation2d from '../../generated/class_wpimath.geometry.Translation2d';
-import * as wpimath_geometry_Translation3d from '../../generated/class_wpimath.geometry.Translation3d';
-import * as wpimath_geometry_Twist2d from '../../generated/class_wpimath.geometry.Twist2d';
-import * as wpimath_geometry_Twist3d from '../../generated/class_wpimath.geometry.Twist3d';
-import * as wpimath_interpolation from '../../generated/module_wpimath.interpolation';
-import * as wpimath_interpolation_TimeInterpolatableFloatBuffer from '../../generated/class_wpimath.interpolation.TimeInterpolatableFloatBuffer';
-import * as wpimath_interpolation_TimeInterpolatablePose2dBuffer from '../../generated/class_wpimath.interpolation.TimeInterpolatablePose2dBuffer';
-import * as wpimath_interpolation_TimeInterpolatablePose3dBuffer from '../../generated/class_wpimath.interpolation.TimeInterpolatablePose3dBuffer';
-import * as wpimath_interpolation_TimeInterpolatableRotation2dBuffer from '../../generated/class_wpimath.interpolation.TimeInterpolatableRotation2dBuffer';
-import * as wpimath_interpolation_TimeInterpolatableRotation3dBuffer from '../../generated/class_wpimath.interpolation.TimeInterpolatableRotation3dBuffer';
-import * as wpimath_interpolation_TimeInterpolatableTranslation2dBuffer from '../../generated/class_wpimath.interpolation.TimeInterpolatableTranslation2dBuffer';
-import * as wpimath_interpolation_TimeInterpolatableTranslation3dBuffer from '../../generated/class_wpimath.interpolation.TimeInterpolatableTranslation3dBuffer';
-import * as wpimath_kinematics from '../../generated/module_wpimath.kinematics';
-import * as wpimath_kinematics_ChassisSpeeds from '../../generated/class_wpimath.kinematics.ChassisSpeeds';
-import * as wpimath_kinematics_DifferentialDriveKinematics from '../../generated/class_wpimath.kinematics.DifferentialDriveKinematics';
-import * as wpimath_kinematics_DifferentialDriveKinematicsBase from '../../generated/class_wpimath.kinematics.DifferentialDriveKinematicsBase';
-import * as wpimath_kinematics_DifferentialDriveOdometry from '../../generated/class_wpimath.kinematics.DifferentialDriveOdometry';
-import * as wpimath_kinematics_DifferentialDriveOdometry3d from '../../generated/class_wpimath.kinematics.DifferentialDriveOdometry3d';
-import * as wpimath_kinematics_DifferentialDriveOdometry3dBase from '../../generated/class_wpimath.kinematics.DifferentialDriveOdometry3dBase';
-import * as wpimath_kinematics_DifferentialDriveOdometryBase from '../../generated/class_wpimath.kinematics.DifferentialDriveOdometryBase';
-import * as wpimath_kinematics_DifferentialDriveWheelPositions from '../../generated/class_wpimath.kinematics.DifferentialDriveWheelPositions';
-import * as wpimath_kinematics_DifferentialDriveWheelSpeeds from '../../generated/class_wpimath.kinematics.DifferentialDriveWheelSpeeds';
-import * as wpimath_kinematics_MecanumDriveKinematics from '../../generated/class_wpimath.kinematics.MecanumDriveKinematics';
-import * as wpimath_kinematics_MecanumDriveKinematicsBase from '../../generated/class_wpimath.kinematics.MecanumDriveKinematicsBase';
-import * as wpimath_kinematics_MecanumDriveOdometry from '../../generated/class_wpimath.kinematics.MecanumDriveOdometry';
-import * as wpimath_kinematics_MecanumDriveOdometry3d from '../../generated/class_wpimath.kinematics.MecanumDriveOdometry3d';
-import * as wpimath_kinematics_MecanumDriveOdometry3dBase from '../../generated/class_wpimath.kinematics.MecanumDriveOdometry3dBase';
-import * as wpimath_kinematics_MecanumDriveOdometryBase from '../../generated/class_wpimath.kinematics.MecanumDriveOdometryBase';
-import * as wpimath_kinematics_MecanumDriveWheelPositions from '../../generated/class_wpimath.kinematics.MecanumDriveWheelPositions';
-import * as wpimath_kinematics_MecanumDriveWheelSpeeds from '../../generated/class_wpimath.kinematics.MecanumDriveWheelSpeeds';
-import * as wpimath_kinematics_SwerveDrive2Kinematics from '../../generated/class_wpimath.kinematics.SwerveDrive2Kinematics';
-import * as wpimath_kinematics_SwerveDrive2KinematicsBase from '../../generated/class_wpimath.kinematics.SwerveDrive2KinematicsBase';
-import * as wpimath_kinematics_SwerveDrive2Odometry from '../../generated/class_wpimath.kinematics.SwerveDrive2Odometry';
-import * as wpimath_kinematics_SwerveDrive2Odometry3d from '../../generated/class_wpimath.kinematics.SwerveDrive2Odometry3d';
-import * as wpimath_kinematics_SwerveDrive2Odometry3dBase from '../../generated/class_wpimath.kinematics.SwerveDrive2Odometry3dBase';
-import * as wpimath_kinematics_SwerveDrive2OdometryBase from '../../generated/class_wpimath.kinematics.SwerveDrive2OdometryBase';
-import * as wpimath_kinematics_SwerveDrive3Kinematics from '../../generated/class_wpimath.kinematics.SwerveDrive3Kinematics';
-import * as wpimath_kinematics_SwerveDrive3KinematicsBase from '../../generated/class_wpimath.kinematics.SwerveDrive3KinematicsBase';
-import * as wpimath_kinematics_SwerveDrive3Odometry from '../../generated/class_wpimath.kinematics.SwerveDrive3Odometry';
-import * as wpimath_kinematics_SwerveDrive3Odometry3d from '../../generated/class_wpimath.kinematics.SwerveDrive3Odometry3d';
-import * as wpimath_kinematics_SwerveDrive3Odometry3dBase from '../../generated/class_wpimath.kinematics.SwerveDrive3Odometry3dBase';
-import * as wpimath_kinematics_SwerveDrive3OdometryBase from '../../generated/class_wpimath.kinematics.SwerveDrive3OdometryBase';
-import * as wpimath_kinematics_SwerveDrive4Kinematics from '../../generated/class_wpimath.kinematics.SwerveDrive4Kinematics';
-import * as wpimath_kinematics_SwerveDrive4KinematicsBase from '../../generated/class_wpimath.kinematics.SwerveDrive4KinematicsBase';
-import * as wpimath_kinematics_SwerveDrive4Odometry from '../../generated/class_wpimath.kinematics.SwerveDrive4Odometry';
-import * as wpimath_kinematics_SwerveDrive4Odometry3d from '../../generated/class_wpimath.kinematics.SwerveDrive4Odometry3d';
-import * as wpimath_kinematics_SwerveDrive4Odometry3dBase from '../../generated/class_wpimath.kinematics.SwerveDrive4Odometry3dBase';
-import * as wpimath_kinematics_SwerveDrive4OdometryBase from '../../generated/class_wpimath.kinematics.SwerveDrive4OdometryBase';
-import * as wpimath_kinematics_SwerveDrive6Kinematics from '../../generated/class_wpimath.kinematics.SwerveDrive6Kinematics';
-import * as wpimath_kinematics_SwerveDrive6KinematicsBase from '../../generated/class_wpimath.kinematics.SwerveDrive6KinematicsBase';
-import * as wpimath_kinematics_SwerveDrive6Odometry from '../../generated/class_wpimath.kinematics.SwerveDrive6Odometry';
-import * as wpimath_kinematics_SwerveDrive6Odometry3d from '../../generated/class_wpimath.kinematics.SwerveDrive6Odometry3d';
-import * as wpimath_kinematics_SwerveDrive6Odometry3dBase from '../../generated/class_wpimath.kinematics.SwerveDrive6Odometry3dBase';
-import * as wpimath_kinematics_SwerveDrive6OdometryBase from '../../generated/class_wpimath.kinematics.SwerveDrive6OdometryBase';
-import * as wpimath_kinematics_SwerveModulePosition from '../../generated/class_wpimath.kinematics.SwerveModulePosition';
-import * as wpimath_kinematics_SwerveModuleState from '../../generated/class_wpimath.kinematics.SwerveModuleState';
-import * as wpimath_optimization from '../../generated/module_wpimath.optimization';
-import * as wpimath_optimization_SimulatedAnnealing from '../../generated/class_wpimath.optimization.SimulatedAnnealing';
-import * as wpimath_path from '../../generated/module_wpimath.path';
-import * as wpimath_path_TravelingSalesman from '../../generated/class_wpimath.path.TravelingSalesman';
-import * as wpimath_spline from '../../generated/module_wpimath.spline';
-import * as wpimath_spline_CubicHermiteSpline from '../../generated/class_wpimath.spline.CubicHermiteSpline';
-import * as wpimath_spline_QuinticHermiteSpline from '../../generated/class_wpimath.spline.QuinticHermiteSpline';
-import * as wpimath_spline_Spline3 from '../../generated/class_wpimath.spline.Spline3';
-import * as wpimath_spline_Spline3_ControlVector from '../../generated/class_wpimath.spline.Spline3.ControlVector';
-import * as wpimath_spline_Spline5 from '../../generated/class_wpimath.spline.Spline5';
-import * as wpimath_spline_Spline5_ControlVector from '../../generated/class_wpimath.spline.Spline5.ControlVector';
-import * as wpimath_spline_SplineHelper from '../../generated/class_wpimath.spline.SplineHelper';
-import * as wpimath_spline_SplineParameterizer from '../../generated/class_wpimath.spline.SplineParameterizer';
-import * as wpimath_system from '../../generated/module_wpimath.system';
-import * as wpimath_system_LinearSystemLoop_1_1_1 from '../../generated/class_wpimath.system.LinearSystemLoop_1_1_1';
-import * as wpimath_system_LinearSystemLoop_2_1_1 from '../../generated/class_wpimath.system.LinearSystemLoop_2_1_1';
-import * as wpimath_system_LinearSystemLoop_2_2_2 from '../../generated/class_wpimath.system.LinearSystemLoop_2_2_2';
-import * as wpimath_system_LinearSystemLoop_3_2_3 from '../../generated/class_wpimath.system.LinearSystemLoop_3_2_3';
-import * as wpimath_system_LinearSystem_1_1_1 from '../../generated/class_wpimath.system.LinearSystem_1_1_1';
-import * as wpimath_system_LinearSystem_1_1_2 from '../../generated/class_wpimath.system.LinearSystem_1_1_2';
-import * as wpimath_system_LinearSystem_1_1_3 from '../../generated/class_wpimath.system.LinearSystem_1_1_3';
-import * as wpimath_system_LinearSystem_2_1_1 from '../../generated/class_wpimath.system.LinearSystem_2_1_1';
-import * as wpimath_system_LinearSystem_2_1_2 from '../../generated/class_wpimath.system.LinearSystem_2_1_2';
-import * as wpimath_system_LinearSystem_2_1_3 from '../../generated/class_wpimath.system.LinearSystem_2_1_3';
-import * as wpimath_system_LinearSystem_2_2_1 from '../../generated/class_wpimath.system.LinearSystem_2_2_1';
-import * as wpimath_system_LinearSystem_2_2_2 from '../../generated/class_wpimath.system.LinearSystem_2_2_2';
-import * as wpimath_system_LinearSystem_2_2_3 from '../../generated/class_wpimath.system.LinearSystem_2_2_3';
-import * as wpimath_system_LinearSystem_3_2_1 from '../../generated/class_wpimath.system.LinearSystem_3_2_1';
-import * as wpimath_system_LinearSystem_3_2_2 from '../../generated/class_wpimath.system.LinearSystem_3_2_2';
-import * as wpimath_system_LinearSystem_3_2_3 from '../../generated/class_wpimath.system.LinearSystem_3_2_3';
-import * as wpimath_system_plant from '../../generated/module_wpimath.system.plant';
-import * as wpimath_system_plant_DCMotor from '../../generated/class_wpimath.system.plant.DCMotor';
-import * as wpimath_system_plant_LinearSystemId from '../../generated/class_wpimath.system.plant.LinearSystemId';
-import * as wpimath_trajectory from '../../generated/module_wpimath.trajectory';
-import * as wpimath_trajectory_ExponentialProfileMeterVolts from '../../generated/class_wpimath.trajectory.ExponentialProfileMeterVolts';
-import * as wpimath_trajectory_ExponentialProfileMeterVolts_Constraints from '../../generated/class_wpimath.trajectory.ExponentialProfileMeterVolts.Constraints';
-import * as wpimath_trajectory_ExponentialProfileMeterVolts_ProfileTiming from '../../generated/class_wpimath.trajectory.ExponentialProfileMeterVolts.ProfileTiming';
-import * as wpimath_trajectory_ExponentialProfileMeterVolts_State from '../../generated/class_wpimath.trajectory.ExponentialProfileMeterVolts.State';
-import * as wpimath_trajectory_Trajectory from '../../generated/class_wpimath.trajectory.Trajectory';
-import * as wpimath_trajectory_Trajectory_State from '../../generated/class_wpimath.trajectory.Trajectory.State';
-import * as wpimath_trajectory_TrajectoryConfig from '../../generated/class_wpimath.trajectory.TrajectoryConfig';
-import * as wpimath_trajectory_TrajectoryGenerator from '../../generated/class_wpimath.trajectory.TrajectoryGenerator';
-import * as wpimath_trajectory_TrajectoryParameterizer from '../../generated/class_wpimath.trajectory.TrajectoryParameterizer';
-import * as wpimath_trajectory_TrajectoryUtil from '../../generated/class_wpimath.trajectory.TrajectoryUtil';
-import * as wpimath_trajectory_TrapezoidProfile from '../../generated/class_wpimath.trajectory.TrapezoidProfile';
-import * as wpimath_trajectory_TrapezoidProfile_Constraints from '../../generated/class_wpimath.trajectory.TrapezoidProfile.Constraints';
-import * as wpimath_trajectory_TrapezoidProfile_State from '../../generated/class_wpimath.trajectory.TrapezoidProfile.State';
-import * as wpimath_trajectory_TrapezoidProfileRadians from '../../generated/class_wpimath.trajectory.TrapezoidProfileRadians';
-import * as wpimath_trajectory_TrapezoidProfileRadians_Constraints from '../../generated/class_wpimath.trajectory.TrapezoidProfileRadians.Constraints';
-import * as wpimath_trajectory_TrapezoidProfileRadians_State from '../../generated/class_wpimath.trajectory.TrapezoidProfileRadians.State';
-import * as wpimath_trajectory_constraint from '../../generated/module_wpimath.trajectory.constraint';
-import * as wpimath_trajectory_constraint_CentripetalAccelerationConstraint from '../../generated/class_wpimath.trajectory.constraint.CentripetalAccelerationConstraint';
-import * as wpimath_trajectory_constraint_DifferentialDriveKinematicsConstraint from '../../generated/class_wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint';
-import * as wpimath_trajectory_constraint_DifferentialDriveVoltageConstraint from '../../generated/class_wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint';
-import * as wpimath_trajectory_constraint_EllipticalRegionConstraint from '../../generated/class_wpimath.trajectory.constraint.EllipticalRegionConstraint';
-import * as wpimath_trajectory_constraint_MaxVelocityConstraint from '../../generated/class_wpimath.trajectory.constraint.MaxVelocityConstraint';
-import * as wpimath_trajectory_constraint_MecanumDriveKinematicsConstraint from '../../generated/class_wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint';
-import * as wpimath_trajectory_constraint_RectangularRegionConstraint from '../../generated/class_wpimath.trajectory.constraint.RectangularRegionConstraint';
-import * as wpimath_trajectory_constraint_SwerveDrive2KinematicsConstraint from '../../generated/class_wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint';
-import * as wpimath_trajectory_constraint_SwerveDrive3KinematicsConstraint from '../../generated/class_wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint';
-import * as wpimath_trajectory_constraint_SwerveDrive4KinematicsConstraint from '../../generated/class_wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint';
-import * as wpimath_trajectory_constraint_SwerveDrive6KinematicsConstraint from '../../generated/class_wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint';
-import * as wpimath_trajectory_constraint_TrajectoryConstraint from '../../generated/class_wpimath.trajectory.constraint.TrajectoryConstraint';
-import * as wpimath_trajectory_constraint_TrajectoryConstraint_MinMax from '../../generated/class_wpimath.trajectory.constraint.TrajectoryConstraint.MinMax';
-import * as wpimath_units from '../../generated/module_wpimath.units';
-
-export function initialize() {
- hal.initialize();
- hal_AddressableLEDData.initialize();
- hal_CANStreamMessage.initialize();
- hal_ControlWord.initialize();
- hal_JoystickAxes.initialize();
- hal_JoystickButtons.initialize();
- hal_JoystickDescriptor.initialize();
- hal_JoystickPOVs.initialize();
- hal_MatchInfo.initialize();
- hal_PowerDistributionFaults.initialize();
- hal_PowerDistributionStickyFaults.initialize();
- hal_PowerDistributionVersion.initialize();
- hal_REVPHCompressorConfig.initialize();
- hal_REVPHFaults.initialize();
- hal_REVPHStickyFaults.initialize();
- hal_REVPHVersion.initialize();
- hal_SimBoolean.initialize();
- hal_SimDevice.initialize();
- hal_SimDouble.initialize();
- hal_SimEnum.initialize();
- hal_SimInt.initialize();
- hal_SimLong.initialize();
- hal_SimValue.initialize();
- hal_Value.initialize();
- hal_exceptions.initialize();
- hal_exceptions_HALError.initialize();
- hal_simulation.initialize();
- hal_simulation_NotifierInfo.initialize();
- hal_simulation_SimCB.initialize();
- hal_simulation_SimValueCB.initialize();
- wpilib.initialize();
- wpilib_ADIS16448_IMU.initialize();
- wpilib_ADIS16470_IMU.initialize();
- wpilib_ADXL345_I2C.initialize();
- wpilib_ADXL345_I2C_AllAxes.initialize();
- wpilib_ADXL345_SPI.initialize();
- wpilib_ADXL345_SPI_AllAxes.initialize();
- wpilib_ADXL362.initialize();
- wpilib_ADXL362_AllAxes.initialize();
- wpilib_ADXRS450_Gyro.initialize();
- wpilib_AddressableLED.initialize();
- wpilib_AddressableLED_LEDData.initialize();
- wpilib_Alert.initialize();
- wpilib_AnalogAccelerometer.initialize();
- wpilib_AnalogEncoder.initialize();
- wpilib_AnalogGyro.initialize();
- wpilib_AnalogInput.initialize();
- wpilib_AnalogOutput.initialize();
- wpilib_AnalogPotentiometer.initialize();
- wpilib_AnalogTrigger.initialize();
- wpilib_AnalogTriggerOutput.initialize();
- wpilib_BuiltInAccelerometer.initialize();
- wpilib_CAN.initialize();
- wpilib_CANData.initialize();
- wpilib_CANStatus.initialize();
- wpilib_Color.initialize();
- wpilib_Color8Bit.initialize();
- wpilib_Compressor.initialize();
- wpilib_Counter.initialize();
- wpilib_DMC60.initialize();
- wpilib_DSControlWord.initialize();
- wpilib_DataLogManager.initialize();
- wpilib_DigitalGlitchFilter.initialize();
- wpilib_DigitalInput.initialize();
- wpilib_DigitalOutput.initialize();
- wpilib_DigitalSource.initialize();
- wpilib_DoubleSolenoid.initialize();
- wpilib_DriverStation.initialize();
- wpilib_DutyCycle.initialize();
- wpilib_DutyCycleEncoder.initialize();
- wpilib_Encoder.initialize();
- wpilib_Field2d.initialize();
- wpilib_FieldObject2d.initialize();
- wpilib_I2C.initialize();
- wpilib_IterativeRobotBase.initialize();
- wpilib_Jaguar.initialize();
- wpilib_Joystick.initialize();
- wpilib_LEDPattern.initialize();
- wpilib_LEDPattern_LEDReader.initialize();
- wpilib_LiveWindow.initialize();
- wpilib_Mechanism2d.initialize();
- wpilib_MechanismLigament2d.initialize();
- wpilib_MechanismObject2d.initialize();
- wpilib_MechanismRoot2d.initialize();
- wpilib_MotorControllerGroup.initialize();
- wpilib_MotorSafety.initialize();
- wpilib_NidecBrushless.initialize();
- wpilib_Notifier.initialize();
- wpilib_PS4Controller.initialize();
- wpilib_PS4Controller_Axis.initialize();
- wpilib_PS4Controller_Button.initialize();
- wpilib_PS5Controller.initialize();
- wpilib_PS5Controller_Axis.initialize();
- wpilib_PS5Controller_Button.initialize();
- wpilib_PWM.initialize();
- wpilib_PWMMotorController.initialize();
- wpilib_PWMSparkFlex.initialize();
- wpilib_PWMSparkMax.initialize();
- wpilib_PWMTalonFX.initialize();
- wpilib_PWMTalonSRX.initialize();
- wpilib_PWMVenom.initialize();
- wpilib_PWMVictorSPX.initialize();
- wpilib_PneumaticHub.initialize();
- wpilib_PneumaticHub_Faults.initialize();
- wpilib_PneumaticHub_StickyFaults.initialize();
- wpilib_PneumaticHub_Version.initialize();
- wpilib_PneumaticsBase.initialize();
- wpilib_PneumaticsControlModule.initialize();
- wpilib_PowerDistribution.initialize();
- wpilib_PowerDistribution_Faults.initialize();
- wpilib_PowerDistribution_StickyFaults.initialize();
- wpilib_PowerDistribution_Version.initialize();
- wpilib_Preferences.initialize();
- wpilib_Relay.initialize();
- wpilib_RobotBase.initialize();
- wpilib_RobotController.initialize();
- wpilib_RobotState.initialize();
- wpilib_SD540.initialize();
- wpilib_SPI.initialize();
- wpilib_SendableBuilderImpl.initialize();
- wpilib_SendableChooser.initialize();
- wpilib_SendableChooserBase.initialize();
- wpilib_SensorUtil.initialize();
- wpilib_SerialPort.initialize();
- wpilib_Servo.initialize();
- wpilib_SharpIR.initialize();
- wpilib_SmartDashboard.initialize();
- wpilib_Solenoid.initialize();
- wpilib_Spark.initialize();
- wpilib_StadiaController.initialize();
- wpilib_StadiaController_Axis.initialize();
- wpilib_StadiaController_Button.initialize();
- wpilib_SynchronousInterrupt.initialize();
- wpilib_Talon.initialize();
- wpilib_TimedRobot.initialize();
- wpilib_Timer.initialize();
- wpilib_TimesliceRobot.initialize();
- wpilib_Tracer.initialize();
- wpilib_Ultrasonic.initialize();
- wpilib_Victor.initialize();
- wpilib_VictorSP.initialize();
- wpilib_Watchdog.initialize();
- wpilib_XboxController.initialize();
- wpilib_XboxController_Axis.initialize();
- wpilib_XboxController_Button.initialize();
- wpilib_cameraserver.initialize();
- wpilib_cameraserver_CameraServer.initialize();
- wpilib_counter.initialize();
- wpilib_counter_ExternalDirectionCounter.initialize();
- wpilib_counter_Tachometer.initialize();
- wpilib_counter_UpDownCounter.initialize();
- wpilib_drive.initialize();
- wpilib_drive_DifferentialDrive.initialize();
- wpilib_drive_DifferentialDrive_WheelSpeeds.initialize();
- wpilib_drive_MecanumDrive.initialize();
- wpilib_drive_MecanumDrive_WheelSpeeds.initialize();
- wpilib_drive_RobotDriveBase.initialize();
- wpilib_event.initialize();
- wpilib_event_BooleanEvent.initialize();
- wpilib_event_EventLoop.initialize();
- wpilib_event_NetworkBooleanEvent.initialize();
- wpilib_interfaces.initialize();
- wpilib_interfaces_CounterBase.initialize();
- wpilib_interfaces_GenericHID.initialize();
- wpilib_interfaces_MotorController.initialize();
- wpilib_shuffleboard.initialize();
- wpilib_shuffleboard_ComplexWidget.initialize();
- wpilib_shuffleboard_LayoutType.initialize();
- wpilib_shuffleboard_Shuffleboard.initialize();
- wpilib_shuffleboard_ShuffleboardComponentBase.initialize();
- wpilib_shuffleboard_ShuffleboardContainer.initialize();
- wpilib_shuffleboard_ShuffleboardLayout.initialize();
- wpilib_shuffleboard_ShuffleboardTab.initialize();
- wpilib_shuffleboard_ShuffleboardValue.initialize();
- wpilib_shuffleboard_SimpleWidget.initialize();
- wpilib_shuffleboard_SuppliedBoolListValueWidget.initialize();
- wpilib_shuffleboard_SuppliedBoolValueWidget.initialize();
- wpilib_shuffleboard_SuppliedDoubleListValueWidget.initialize();
- wpilib_shuffleboard_SuppliedDoubleValueWidget.initialize();
- wpilib_shuffleboard_SuppliedFloatListValueWidget.initialize();
- wpilib_shuffleboard_SuppliedFloatValueWidget.initialize();
- wpilib_shuffleboard_SuppliedIntListValueWidget.initialize();
- wpilib_shuffleboard_SuppliedIntegerValueWidget.initialize();
- wpilib_shuffleboard_SuppliedRawValueWidget.initialize();
- wpilib_shuffleboard_SuppliedStringListValueWidget.initialize();
- wpilib_shuffleboard_SuppliedStringValueWidget.initialize();
- wpilib_shuffleboard_WidgetType.initialize();
- wpilib_shuffleboard__ComplexComponent.initialize();
- wpilib_shuffleboard__ComplexWidget.initialize();
- wpilib_shuffleboard__LayoutComponent.initialize();
- wpilib_shuffleboard__SimpleComponent.initialize();
- wpilib_shuffleboard__SimpleWidget.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_bool.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_double.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_float.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_integer.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_string.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_vector_bool.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_vector_double.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_vector_float.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_vector_int.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_vector_raw.initialize();
- wpilib_shuffleboard__SuppliedValueComponent_vector_string.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_bool.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_double.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_float.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_integer.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_string.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_vector_bool.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_vector_double.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_vector_float.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_vector_int.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_vector_raw.initialize();
- wpilib_shuffleboard__SuppliedValueWidget_vector_string.initialize();
- wpilib_simulation.initialize();
- wpilib_simulation_ADIS16448_IMUSim.initialize();
- wpilib_simulation_ADIS16470_IMUSim.initialize();
- wpilib_simulation_ADXL345Sim.initialize();
- wpilib_simulation_ADXL362Sim.initialize();
- wpilib_simulation_ADXRS450_GyroSim.initialize();
- wpilib_simulation_AddressableLEDSim.initialize();
- wpilib_simulation_AnalogEncoderSim.initialize();
- wpilib_simulation_AnalogGyroSim.initialize();
- wpilib_simulation_AnalogInputSim.initialize();
- wpilib_simulation_AnalogOutputSim.initialize();
- wpilib_simulation_AnalogTriggerSim.initialize();
- wpilib_simulation_BatterySim.initialize();
- wpilib_simulation_BuiltInAccelerometerSim.initialize();
- wpilib_simulation_CTREPCMSim.initialize();
- wpilib_simulation_CallbackStore.initialize();
- wpilib_simulation_DCMotorSim.initialize();
- wpilib_simulation_DIOSim.initialize();
- wpilib_simulation_DifferentialDrivetrainSim.initialize();
- wpilib_simulation_DifferentialDrivetrainSim_KitbotGearing.initialize();
- wpilib_simulation_DifferentialDrivetrainSim_KitbotMotor.initialize();
- wpilib_simulation_DifferentialDrivetrainSim_KitbotWheelSize.initialize();
- wpilib_simulation_DifferentialDrivetrainSim_State.initialize();
- wpilib_simulation_DigitalPWMSim.initialize();
- wpilib_simulation_DoubleSolenoidSim.initialize();
- wpilib_simulation_DriverStationSim.initialize();
- wpilib_simulation_DutyCycleEncoderSim.initialize();
- wpilib_simulation_DutyCycleSim.initialize();
- wpilib_simulation_ElevatorSim.initialize();
- wpilib_simulation_EncoderSim.initialize();
- wpilib_simulation_FlywheelSim.initialize();
- wpilib_simulation_GenericHIDSim.initialize();
- wpilib_simulation_JoystickSim.initialize();
- wpilib_simulation_LinearSystemSim_1_1_1.initialize();
- wpilib_simulation_LinearSystemSim_1_1_2.initialize();
- wpilib_simulation_LinearSystemSim_2_1_1.initialize();
- wpilib_simulation_LinearSystemSim_2_1_2.initialize();
- wpilib_simulation_LinearSystemSim_2_2_1.initialize();
- wpilib_simulation_LinearSystemSim_2_2_2.initialize();
- wpilib_simulation_PS4ControllerSim.initialize();
- wpilib_simulation_PS5ControllerSim.initialize();
- wpilib_simulation_PWMSim.initialize();
- wpilib_simulation_PneumaticsBaseSim.initialize();
- wpilib_simulation_PowerDistributionSim.initialize();
- wpilib_simulation_REVPHSim.initialize();
- wpilib_simulation_RelaySim.initialize();
- wpilib_simulation_RoboRioSim.initialize();
- wpilib_simulation_SPIAccelerometerSim.initialize();
- wpilib_simulation_SendableChooserSim.initialize();
- wpilib_simulation_SharpIRSim.initialize();
- wpilib_simulation_SimDeviceSim.initialize();
- wpilib_simulation_SingleJointedArmSim.initialize();
- wpilib_simulation_SolenoidSim.initialize();
- wpilib_simulation_StadiaControllerSim.initialize();
- wpilib_simulation_UltrasonicSim.initialize();
- wpilib_simulation_XboxControllerSim.initialize();
- wpilib_sysid_SysIdRoutineLog.initialize();
- wpilib_sysid_SysIdRoutineLog_MotorLog.initialize();
- wpimath.initialize();
- wpimath_controller.initialize();
- wpimath_controller_ArmFeedforward.initialize();
- wpimath_controller_BangBangController.initialize();
- wpimath_controller_ControlAffinePlantInversionFeedforward_1_1.initialize();
- wpimath_controller_ControlAffinePlantInversionFeedforward_2_1.initialize();
- wpimath_controller_ControlAffinePlantInversionFeedforward_2_2.initialize();
- wpimath_controller_DifferentialDriveAccelerationLimiter.initialize();
- wpimath_controller_DifferentialDriveWheelVoltages.initialize();
- wpimath_controller_ElevatorFeedforward.initialize();
- wpimath_controller_HolonomicDriveController.initialize();
- wpimath_controller_ImplicitModelFollower_1_1.initialize();
- wpimath_controller_ImplicitModelFollower_2_1.initialize();
- wpimath_controller_ImplicitModelFollower_2_2.initialize();
- wpimath_controller_LTVDifferentialDriveController.initialize();
- wpimath_controller_LTVUnicycleController.initialize();
- wpimath_controller_LinearPlantInversionFeedforward_1_1.initialize();
- wpimath_controller_LinearPlantInversionFeedforward_2_1.initialize();
- wpimath_controller_LinearPlantInversionFeedforward_2_2.initialize();
- wpimath_controller_LinearPlantInversionFeedforward_3_2.initialize();
- wpimath_controller_LinearQuadraticRegulator_1_1.initialize();
- wpimath_controller_LinearQuadraticRegulator_2_1.initialize();
- wpimath_controller_LinearQuadraticRegulator_2_2.initialize();
- wpimath_controller_LinearQuadraticRegulator_3_2.initialize();
- wpimath_controller_PIDController.initialize();
- wpimath_controller_ProfiledPIDController.initialize();
- wpimath_controller_ProfiledPIDControllerRadians.initialize();
- wpimath_controller_RamseteController.initialize();
- wpimath_controller_SimpleMotorFeedforwardMeters.initialize();
- wpimath_controller_SimpleMotorFeedforwardRadians.initialize();
- wpimath_estimator.initialize();
- wpimath_estimator_DifferentialDrivePoseEstimator.initialize();
- wpimath_estimator_DifferentialDrivePoseEstimator3d.initialize();
- wpimath_estimator_DifferentialDrivePoseEstimator3dBase.initialize();
- wpimath_estimator_DifferentialDrivePoseEstimatorBase.initialize();
- wpimath_estimator_ExtendedKalmanFilter_1_1_1.initialize();
- wpimath_estimator_ExtendedKalmanFilter_2_1_1.initialize();
- wpimath_estimator_ExtendedKalmanFilter_2_2_2.initialize();
- wpimath_estimator_KalmanFilter_1_1_1.initialize();
- wpimath_estimator_KalmanFilter_2_1_1.initialize();
- wpimath_estimator_KalmanFilter_2_2_2.initialize();
- wpimath_estimator_KalmanFilter_3_2_3.initialize();
- wpimath_estimator_MecanumDrivePoseEstimator.initialize();
- wpimath_estimator_MecanumDrivePoseEstimator3d.initialize();
- wpimath_estimator_MecanumDrivePoseEstimator3dBase.initialize();
- wpimath_estimator_MecanumDrivePoseEstimatorBase.initialize();
- wpimath_estimator_SwerveDrive2PoseEstimator.initialize();
- wpimath_estimator_SwerveDrive2PoseEstimator3d.initialize();
- wpimath_estimator_SwerveDrive2PoseEstimator3dBase.initialize();
- wpimath_estimator_SwerveDrive2PoseEstimatorBase.initialize();
- wpimath_estimator_SwerveDrive3PoseEstimator.initialize();
- wpimath_estimator_SwerveDrive3PoseEstimator3d.initialize();
- wpimath_estimator_SwerveDrive3PoseEstimator3dBase.initialize();
- wpimath_estimator_SwerveDrive3PoseEstimatorBase.initialize();
- wpimath_estimator_SwerveDrive4PoseEstimator.initialize();
- wpimath_estimator_SwerveDrive4PoseEstimator3d.initialize();
- wpimath_estimator_SwerveDrive4PoseEstimator3dBase.initialize();
- wpimath_estimator_SwerveDrive4PoseEstimatorBase.initialize();
- wpimath_estimator_SwerveDrive6PoseEstimator.initialize();
- wpimath_estimator_SwerveDrive6PoseEstimator3d.initialize();
- wpimath_estimator_SwerveDrive6PoseEstimator3dBase.initialize();
- wpimath_estimator_SwerveDrive6PoseEstimatorBase.initialize();
- wpimath_filter.initialize();
- wpimath_filter_Debouncer.initialize();
- wpimath_filter_LinearFilter.initialize();
- wpimath_filter_MedianFilter.initialize();
- wpimath_filter_SlewRateLimiter.initialize();
- wpimath_geometry.initialize();
- wpimath_geometry_CoordinateAxis.initialize();
- wpimath_geometry_CoordinateSystem.initialize();
- wpimath_geometry_Ellipse2d.initialize();
- wpimath_geometry_Pose2d.initialize();
- wpimath_geometry_Pose3d.initialize();
- wpimath_geometry_Quaternion.initialize();
- wpimath_geometry_Rectangle2d.initialize();
- wpimath_geometry_Rotation2d.initialize();
- wpimath_geometry_Rotation3d.initialize();
- wpimath_geometry_Transform2d.initialize();
- wpimath_geometry_Transform3d.initialize();
- wpimath_geometry_Translation2d.initialize();
- wpimath_geometry_Translation3d.initialize();
- wpimath_geometry_Twist2d.initialize();
- wpimath_geometry_Twist3d.initialize();
- wpimath_interpolation.initialize();
- wpimath_interpolation_TimeInterpolatableFloatBuffer.initialize();
- wpimath_interpolation_TimeInterpolatablePose2dBuffer.initialize();
- wpimath_interpolation_TimeInterpolatablePose3dBuffer.initialize();
- wpimath_interpolation_TimeInterpolatableRotation2dBuffer.initialize();
- wpimath_interpolation_TimeInterpolatableRotation3dBuffer.initialize();
- wpimath_interpolation_TimeInterpolatableTranslation2dBuffer.initialize();
- wpimath_interpolation_TimeInterpolatableTranslation3dBuffer.initialize();
- wpimath_kinematics.initialize();
- wpimath_kinematics_ChassisSpeeds.initialize();
- wpimath_kinematics_DifferentialDriveKinematics.initialize();
- wpimath_kinematics_DifferentialDriveKinematicsBase.initialize();
- wpimath_kinematics_DifferentialDriveOdometry.initialize();
- wpimath_kinematics_DifferentialDriveOdometry3d.initialize();
- wpimath_kinematics_DifferentialDriveOdometry3dBase.initialize();
- wpimath_kinematics_DifferentialDriveOdometryBase.initialize();
- wpimath_kinematics_DifferentialDriveWheelPositions.initialize();
- wpimath_kinematics_DifferentialDriveWheelSpeeds.initialize();
- wpimath_kinematics_MecanumDriveKinematics.initialize();
- wpimath_kinematics_MecanumDriveKinematicsBase.initialize();
- wpimath_kinematics_MecanumDriveOdometry.initialize();
- wpimath_kinematics_MecanumDriveOdometry3d.initialize();
- wpimath_kinematics_MecanumDriveOdometry3dBase.initialize();
- wpimath_kinematics_MecanumDriveOdometryBase.initialize();
- wpimath_kinematics_MecanumDriveWheelPositions.initialize();
- wpimath_kinematics_MecanumDriveWheelSpeeds.initialize();
- wpimath_kinematics_SwerveDrive2Kinematics.initialize();
- wpimath_kinematics_SwerveDrive2KinematicsBase.initialize();
- wpimath_kinematics_SwerveDrive2Odometry.initialize();
- wpimath_kinematics_SwerveDrive2Odometry3d.initialize();
- wpimath_kinematics_SwerveDrive2Odometry3dBase.initialize();
- wpimath_kinematics_SwerveDrive2OdometryBase.initialize();
- wpimath_kinematics_SwerveDrive3Kinematics.initialize();
- wpimath_kinematics_SwerveDrive3KinematicsBase.initialize();
- wpimath_kinematics_SwerveDrive3Odometry.initialize();
- wpimath_kinematics_SwerveDrive3Odometry3d.initialize();
- wpimath_kinematics_SwerveDrive3Odometry3dBase.initialize();
- wpimath_kinematics_SwerveDrive3OdometryBase.initialize();
- wpimath_kinematics_SwerveDrive4Kinematics.initialize();
- wpimath_kinematics_SwerveDrive4KinematicsBase.initialize();
- wpimath_kinematics_SwerveDrive4Odometry.initialize();
- wpimath_kinematics_SwerveDrive4Odometry3d.initialize();
- wpimath_kinematics_SwerveDrive4Odometry3dBase.initialize();
- wpimath_kinematics_SwerveDrive4OdometryBase.initialize();
- wpimath_kinematics_SwerveDrive6Kinematics.initialize();
- wpimath_kinematics_SwerveDrive6KinematicsBase.initialize();
- wpimath_kinematics_SwerveDrive6Odometry.initialize();
- wpimath_kinematics_SwerveDrive6Odometry3d.initialize();
- wpimath_kinematics_SwerveDrive6Odometry3dBase.initialize();
- wpimath_kinematics_SwerveDrive6OdometryBase.initialize();
- wpimath_kinematics_SwerveModulePosition.initialize();
- wpimath_kinematics_SwerveModuleState.initialize();
- wpimath_optimization.initialize();
- wpimath_optimization_SimulatedAnnealing.initialize();
- wpimath_path.initialize();
- wpimath_path_TravelingSalesman.initialize();
- wpimath_spline.initialize();
- wpimath_spline_CubicHermiteSpline.initialize();
- wpimath_spline_QuinticHermiteSpline.initialize();
- wpimath_spline_Spline3.initialize();
- wpimath_spline_Spline3_ControlVector.initialize();
- wpimath_spline_Spline5.initialize();
- wpimath_spline_Spline5_ControlVector.initialize();
- wpimath_spline_SplineHelper.initialize();
- wpimath_spline_SplineParameterizer.initialize();
- wpimath_system.initialize();
- wpimath_system_LinearSystemLoop_1_1_1.initialize();
- wpimath_system_LinearSystemLoop_2_1_1.initialize();
- wpimath_system_LinearSystemLoop_2_2_2.initialize();
- wpimath_system_LinearSystemLoop_3_2_3.initialize();
- wpimath_system_LinearSystem_1_1_1.initialize();
- wpimath_system_LinearSystem_1_1_2.initialize();
- wpimath_system_LinearSystem_1_1_3.initialize();
- wpimath_system_LinearSystem_2_1_1.initialize();
- wpimath_system_LinearSystem_2_1_2.initialize();
- wpimath_system_LinearSystem_2_1_3.initialize();
- wpimath_system_LinearSystem_2_2_1.initialize();
- wpimath_system_LinearSystem_2_2_2.initialize();
- wpimath_system_LinearSystem_2_2_3.initialize();
- wpimath_system_LinearSystem_3_2_1.initialize();
- wpimath_system_LinearSystem_3_2_2.initialize();
- wpimath_system_LinearSystem_3_2_3.initialize();
- wpimath_system_plant.initialize();
- wpimath_system_plant_DCMotor.initialize();
- wpimath_system_plant_LinearSystemId.initialize();
- wpimath_trajectory.initialize();
- wpimath_trajectory_ExponentialProfileMeterVolts.initialize();
- wpimath_trajectory_ExponentialProfileMeterVolts_Constraints.initialize();
- wpimath_trajectory_ExponentialProfileMeterVolts_ProfileTiming.initialize();
- wpimath_trajectory_ExponentialProfileMeterVolts_State.initialize();
- wpimath_trajectory_Trajectory.initialize();
- wpimath_trajectory_Trajectory_State.initialize();
- wpimath_trajectory_TrajectoryConfig.initialize();
- wpimath_trajectory_TrajectoryGenerator.initialize();
- wpimath_trajectory_TrajectoryParameterizer.initialize();
- wpimath_trajectory_TrajectoryUtil.initialize();
- wpimath_trajectory_TrapezoidProfile.initialize();
- wpimath_trajectory_TrapezoidProfile_Constraints.initialize();
- wpimath_trajectory_TrapezoidProfile_State.initialize();
- wpimath_trajectory_TrapezoidProfileRadians.initialize();
- wpimath_trajectory_TrapezoidProfileRadians_Constraints.initialize();
- wpimath_trajectory_TrapezoidProfileRadians_State.initialize();
- wpimath_trajectory_constraint.initialize();
- wpimath_trajectory_constraint_CentripetalAccelerationConstraint.initialize();
- wpimath_trajectory_constraint_DifferentialDriveKinematicsConstraint.initialize();
- wpimath_trajectory_constraint_DifferentialDriveVoltageConstraint.initialize();
- wpimath_trajectory_constraint_EllipticalRegionConstraint.initialize();
- wpimath_trajectory_constraint_MaxVelocityConstraint.initialize();
- wpimath_trajectory_constraint_MecanumDriveKinematicsConstraint.initialize();
- wpimath_trajectory_constraint_RectangularRegionConstraint.initialize();
- wpimath_trajectory_constraint_SwerveDrive2KinematicsConstraint.initialize();
- wpimath_trajectory_constraint_SwerveDrive3KinematicsConstraint.initialize();
- wpimath_trajectory_constraint_SwerveDrive4KinematicsConstraint.initialize();
- wpimath_trajectory_constraint_SwerveDrive6KinematicsConstraint.initialize();
- wpimath_trajectory_constraint_TrajectoryConstraint.initialize();
- wpimath_trajectory_constraint_TrajectoryConstraint_MinMax.initialize();
- wpimath_units.initialize();
-}
diff --git a/src/blocks/utils/generated/python.ts b/src/blocks/utils/generated/python.ts
deleted file mode 100644
index 66f30538..00000000
--- a/src/blocks/utils/generated/python.ts
+++ /dev/null
@@ -1,1319 +0,0 @@
-// This file was generated. Do not edit!
-
-// Blocks constants and utilities.
-
-export const FIELD_MODULE_OR_CLASS_NAME = "MODULE_OR_CLASS";
-export const FIELD_VARIABLE_NAME = "VAR";
-export const FIELD_FUNCTION_NAME = "FUNC";
-export const FIELD_ENUM_CLASS_NAME = "ENUM_TYPE";
-export const FIELD_ENUM_VALUE = "ENUM_VALUE";
-
-export function getAlias(type: string): string {
- if (type === "wpimath.units.abvolts") {
- return "float";
- }
- if (type === "wpimath.units.acres") {
- return "float";
- }
- if (type === "wpimath.units.ampere_hours") {
- return "float";
- }
- if (type === "wpimath.units.amperes") {
- return "float";
- }
- if (type === "wpimath.units.angstroms") {
- return "float";
- }
- if (type === "wpimath.units.arcminutes") {
- return "float";
- }
- if (type === "wpimath.units.arcseconds") {
- return "float";
- }
- if (type === "wpimath.units.astronicalUnits") {
- return "float";
- }
- if (type === "wpimath.units.atmospheres") {
- return "float";
- }
- if (type === "wpimath.units.barrels") {
- return "float";
- }
- if (type === "wpimath.units.bars") {
- return "float";
- }
- if (type === "wpimath.units.becquerels") {
- return "float";
- }
- if (type === "wpimath.units.british_thermal_units") {
- return "float";
- }
- if (type === "wpimath.units.british_thermal_units_59") {
- return "float";
- }
- if (type === "wpimath.units.british_thermal_units_iso") {
- return "float";
- }
- if (type === "wpimath.units.bushels") {
- return "float";
- }
- if (type === "wpimath.units.calories") {
- return "float";
- }
- if (type === "wpimath.units.candelas") {
- return "float";
- }
- if (type === "wpimath.units.carats") {
- return "float";
- }
- if (type === "wpimath.units.celsius") {
- return "float";
- }
- if (type === "wpimath.units.centimeters") {
- return "float";
- }
- if (type === "wpimath.units.chains") {
- return "float";
- }
- if (type === "wpimath.units.cords") {
- return "float";
- }
- if (type === "wpimath.units.coulombs") {
- return "float";
- }
- if (type === "wpimath.units.cubic_fathoms") {
- return "float";
- }
- if (type === "wpimath.units.cubic_feet") {
- return "float";
- }
- if (type === "wpimath.units.cubic_inches") {
- return "float";
- }
- if (type === "wpimath.units.cubic_kilometers") {
- return "float";
- }
- if (type === "wpimath.units.cubic_meters") {
- return "float";
- }
- if (type === "wpimath.units.cubic_miles") {
- return "float";
- }
- if (type === "wpimath.units.cubic_millimeters") {
- return "float";
- }
- if (type === "wpimath.units.cubic_yards") {
- return "float";
- }
- if (type === "wpimath.units.cubits") {
- return "float";
- }
- if (type === "wpimath.units.cups") {
- return "float";
- }
- if (type === "wpimath.units.curies") {
- return "float";
- }
- if (type === "wpimath.units.dashes") {
- return "float";
- }
- if (type === "wpimath.units.days") {
- return "float";
- }
- if (type === "wpimath.units.degrees") {
- return "float";
- }
- if (type === "wpimath.units.degrees_per_second") {
- return "float";
- }
- if (type === "wpimath.units.degrees_per_second_squared") {
- return "float";
- }
- if (type === "wpimath.units.degrees_squared") {
- return "float";
- }
- if (type === "wpimath.units.drams") {
- return "float";
- }
- if (type === "wpimath.units.drops") {
- return "float";
- }
- if (type === "wpimath.units.dynes") {
- return "float";
- }
- if (type === "wpimath.units.exabits") {
- return "float";
- }
- if (type === "wpimath.units.exabits_per_second") {
- return "float";
- }
- if (type === "wpimath.units.exabytes") {
- return "float";
- }
- if (type === "wpimath.units.exabytes_per_second") {
- return "float";
- }
- if (type === "wpimath.units.fahrenheit") {
- return "float";
- }
- if (type === "wpimath.units.farads") {
- return "float";
- }
- if (type === "wpimath.units.fathoms") {
- return "float";
- }
- if (type === "wpimath.units.feet") {
- return "float";
- }
- if (type === "wpimath.units.feet_per_second") {
- return "float";
- }
- if (type === "wpimath.units.feet_per_second_squared") {
- return "float";
- }
- if (type === "wpimath.units.fifths") {
- return "float";
- }
- if (type === "wpimath.units.fluid_ounces") {
- return "float";
- }
- if (type === "wpimath.units.foot_poundals") {
- return "float";
- }
- if (type === "wpimath.units.foot_pounds") {
- return "float";
- }
- if (type === "wpimath.units.footcandles") {
- return "float";
- }
- if (type === "wpimath.units.furlongs") {
- return "float";
- }
- if (type === "wpimath.units.gallons") {
- return "float";
- }
- if (type === "wpimath.units.gauss") {
- return "float";
- }
- if (type === "wpimath.units.gills") {
- return "float";
- }
- if (type === "wpimath.units.gradians") {
- return "float";
- }
- if (type === "wpimath.units.grams") {
- return "float";
- }
- if (type === "wpimath.units.grams_per_milliliter") {
- return "float";
- }
- if (type === "wpimath.units.grays") {
- return "float";
- }
- if (type === "wpimath.units.gregorian_years") {
- return "float";
- }
- if (type === "wpimath.units.hands") {
- return "float";
- }
- if (type === "wpimath.units.hectares") {
- return "float";
- }
- if (type === "wpimath.units.henries") {
- return "float";
- }
- if (type === "wpimath.units.hertz") {
- return "float";
- }
- if (type === "wpimath.units.horsepower") {
- return "float";
- }
- if (type === "wpimath.units.hours") {
- return "float";
- }
- if (type === "wpimath.units.inch_pounds") {
- return "float";
- }
- if (type === "wpimath.units.inches") {
- return "float";
- }
- if (type === "wpimath.units.joules") {
- return "float";
- }
- if (type === "wpimath.units.julian_years") {
- return "float";
- }
- if (type === "wpimath.units.kelvin") {
- return "float";
- }
- if (type === "wpimath.units.kiloampere_hours") {
- return "float";
- }
- if (type === "wpimath.units.kiloamperes") {
- return "float";
- }
- if (type === "wpimath.units.kilobecquerels") {
- return "float";
- }
- if (type === "wpimath.units.kilocalories") {
- return "float";
- }
- if (type === "wpimath.units.kilocandelas") {
- return "float";
- }
- if (type === "wpimath.units.kilocoulombs") {
- return "float";
- }
- if (type === "wpimath.units.kilofarads") {
- return "float";
- }
- if (type === "wpimath.units.kilogram_square_meters") {
- return "float";
- }
- if (type === "wpimath.units.kilograms") {
- return "float";
- }
- if (type === "wpimath.units.kilograms_per_cubic_meter") {
- return "float";
- }
- if (type === "wpimath.units.kilograms_per_liter") {
- return "float";
- }
- if (type === "wpimath.units.kilograys") {
- return "float";
- }
- if (type === "wpimath.units.kilohenries") {
- return "float";
- }
- if (type === "wpimath.units.kilohertz") {
- return "float";
- }
- if (type === "wpimath.units.kilojoules") {
- return "float";
- }
- if (type === "wpimath.units.kiloliters") {
- return "float";
- }
- if (type === "wpimath.units.kilolumens") {
- return "float";
- }
- if (type === "wpimath.units.kiloluxes") {
- return "float";
- }
- if (type === "wpimath.units.kilometers") {
- return "float";
- }
- if (type === "wpimath.units.kilometers_per_hour") {
- return "float";
- }
- if (type === "wpimath.units.kilonewtons") {
- return "float";
- }
- if (type === "wpimath.units.kiloohms") {
- return "float";
- }
- if (type === "wpimath.units.kilopascals") {
- return "float";
- }
- if (type === "wpimath.units.kiloponds") {
- return "float";
- }
- if (type === "wpimath.units.kiloradians") {
- return "float";
- }
- if (type === "wpimath.units.kiloseconds") {
- return "float";
- }
- if (type === "wpimath.units.kilosiemens") {
- return "float";
- }
- if (type === "wpimath.units.kilosieverts") {
- return "float";
- }
- if (type === "wpimath.units.kilosteradians") {
- return "float";
- }
- if (type === "wpimath.units.kiloteslas") {
- return "float";
- }
- if (type === "wpimath.units.kilovolts") {
- return "float";
- }
- if (type === "wpimath.units.kilowatt_hours") {
- return "float";
- }
- if (type === "wpimath.units.kilowatts") {
- return "float";
- }
- if (type === "wpimath.units.kilowebers") {
- return "float";
- }
- if (type === "wpimath.units.knots") {
- return "float";
- }
- if (type === "wpimath.units.leagues") {
- return "float";
- }
- if (type === "wpimath.units.lightyears") {
- return "float";
- }
- if (type === "wpimath.units.liters") {
- return "float";
- }
- if (type === "wpimath.units.long_tons") {
- return "float";
- }
- if (type === "wpimath.units.lumens") {
- return "float";
- }
- if (type === "wpimath.units.lumens_per_square_inch") {
- return "float";
- }
- if (type === "wpimath.units.luxes") {
- return "float";
- }
- if (type === "wpimath.units.maxwells") {
- return "float";
- }
- if (type === "wpimath.units.mbars") {
- return "float";
- }
- if (type === "wpimath.units.meter_kilograms") {
- return "float";
- }
- if (type === "wpimath.units.meters") {
- return "float";
- }
- if (type === "wpimath.units.meters_per_second") {
- return "float";
- }
- if (type === "wpimath.units.meters_per_second_squared") {
- return "float";
- }
- if (type === "wpimath.units.meters_per_second_squared_per_volt") {
- return "float";
- }
- if (type === "wpimath.units.metric_tons") {
- return "float";
- }
- if (type === "wpimath.units.microampere_hours") {
- return "float";
- }
- if (type === "wpimath.units.microamperes") {
- return "float";
- }
- if (type === "wpimath.units.microbecquerels") {
- return "float";
- }
- if (type === "wpimath.units.microcalories") {
- return "float";
- }
- if (type === "wpimath.units.microcandelas") {
- return "float";
- }
- if (type === "wpimath.units.microcoulombs") {
- return "float";
- }
- if (type === "wpimath.units.microfarads") {
- return "float";
- }
- if (type === "wpimath.units.micrograms") {
- return "float";
- }
- if (type === "wpimath.units.micrograys") {
- return "float";
- }
- if (type === "wpimath.units.microhenries") {
- return "float";
- }
- if (type === "wpimath.units.microhertz") {
- return "float";
- }
- if (type === "wpimath.units.microjoules") {
- return "float";
- }
- if (type === "wpimath.units.microliters") {
- return "float";
- }
- if (type === "wpimath.units.microlumens") {
- return "float";
- }
- if (type === "wpimath.units.microluxes") {
- return "float";
- }
- if (type === "wpimath.units.micrometers") {
- return "float";
- }
- if (type === "wpimath.units.micronewtons") {
- return "float";
- }
- if (type === "wpimath.units.microohms") {
- return "float";
- }
- if (type === "wpimath.units.micropascals") {
- return "float";
- }
- if (type === "wpimath.units.microradians") {
- return "float";
- }
- if (type === "wpimath.units.microseconds") {
- return "float";
- }
- if (type === "wpimath.units.microsiemens") {
- return "float";
- }
- if (type === "wpimath.units.microsieverts") {
- return "float";
- }
- if (type === "wpimath.units.microsteradians") {
- return "float";
- }
- if (type === "wpimath.units.microteslas") {
- return "float";
- }
- if (type === "wpimath.units.microvolts") {
- return "float";
- }
- if (type === "wpimath.units.microwatts") {
- return "float";
- }
- if (type === "wpimath.units.microwebers") {
- return "float";
- }
- if (type === "wpimath.units.miles") {
- return "float";
- }
- if (type === "wpimath.units.miles_per_hour") {
- return "float";
- }
- if (type === "wpimath.units.milliampere_hours") {
- return "float";
- }
- if (type === "wpimath.units.milliamperes") {
- return "float";
- }
- if (type === "wpimath.units.milliarcseconds") {
- return "float";
- }
- if (type === "wpimath.units.milliarcseconds_per_year") {
- return "float";
- }
- if (type === "wpimath.units.millibecquerels") {
- return "float";
- }
- if (type === "wpimath.units.millicalories") {
- return "float";
- }
- if (type === "wpimath.units.millicandelas") {
- return "float";
- }
- if (type === "wpimath.units.millicoulombs") {
- return "float";
- }
- if (type === "wpimath.units.millifarads") {
- return "float";
- }
- if (type === "wpimath.units.milligrams") {
- return "float";
- }
- if (type === "wpimath.units.milligrays") {
- return "float";
- }
- if (type === "wpimath.units.millihenries") {
- return "float";
- }
- if (type === "wpimath.units.millihertz") {
- return "float";
- }
- if (type === "wpimath.units.millijoules") {
- return "float";
- }
- if (type === "wpimath.units.milliliters") {
- return "float";
- }
- if (type === "wpimath.units.millilumens") {
- return "float";
- }
- if (type === "wpimath.units.milliluxes") {
- return "float";
- }
- if (type === "wpimath.units.millimeters") {
- return "float";
- }
- if (type === "wpimath.units.millinewtons") {
- return "float";
- }
- if (type === "wpimath.units.milliohms") {
- return "float";
- }
- if (type === "wpimath.units.millipascals") {
- return "float";
- }
- if (type === "wpimath.units.milliradians") {
- return "float";
- }
- if (type === "wpimath.units.milliseconds") {
- return "float";
- }
- if (type === "wpimath.units.millisiemens") {
- return "float";
- }
- if (type === "wpimath.units.millisieverts") {
- return "float";
- }
- if (type === "wpimath.units.millisteradians") {
- return "float";
- }
- if (type === "wpimath.units.milliteslas") {
- return "float";
- }
- if (type === "wpimath.units.millivolts") {
- return "float";
- }
- if (type === "wpimath.units.milliwatts") {
- return "float";
- }
- if (type === "wpimath.units.milliwebers") {
- return "float";
- }
- if (type === "wpimath.units.mils") {
- return "float";
- }
- if (type === "wpimath.units.minutes") {
- return "float";
- }
- if (type === "wpimath.units.moles") {
- return "float";
- }
- if (type === "wpimath.units.nanoampere_hours") {
- return "float";
- }
- if (type === "wpimath.units.nanoamperes") {
- return "float";
- }
- if (type === "wpimath.units.nanobecquerels") {
- return "float";
- }
- if (type === "wpimath.units.nanocalories") {
- return "float";
- }
- if (type === "wpimath.units.nanocandelas") {
- return "float";
- }
- if (type === "wpimath.units.nanocoulombs") {
- return "float";
- }
- if (type === "wpimath.units.nanofarads") {
- return "float";
- }
- if (type === "wpimath.units.nanograms") {
- return "float";
- }
- if (type === "wpimath.units.nanograys") {
- return "float";
- }
- if (type === "wpimath.units.nanohenries") {
- return "float";
- }
- if (type === "wpimath.units.nanohertz") {
- return "float";
- }
- if (type === "wpimath.units.nanojoules") {
- return "float";
- }
- if (type === "wpimath.units.nanoliters") {
- return "float";
- }
- if (type === "wpimath.units.nanolumens") {
- return "float";
- }
- if (type === "wpimath.units.nanoluxes") {
- return "float";
- }
- if (type === "wpimath.units.nanometers") {
- return "float";
- }
- if (type === "wpimath.units.nanonewtons") {
- return "float";
- }
- if (type === "wpimath.units.nanoohms") {
- return "float";
- }
- if (type === "wpimath.units.nanopascals") {
- return "float";
- }
- if (type === "wpimath.units.nanoradians") {
- return "float";
- }
- if (type === "wpimath.units.nanoseconds") {
- return "float";
- }
- if (type === "wpimath.units.nanosiemens") {
- return "float";
- }
- if (type === "wpimath.units.nanosieverts") {
- return "float";
- }
- if (type === "wpimath.units.nanosteradians") {
- return "float";
- }
- if (type === "wpimath.units.nanoteslas") {
- return "float";
- }
- if (type === "wpimath.units.nanovolts") {
- return "float";
- }
- if (type === "wpimath.units.nanowatts") {
- return "float";
- }
- if (type === "wpimath.units.nanowebers") {
- return "float";
- }
- if (type === "wpimath.units.nauticalLeagues") {
- return "float";
- }
- if (type === "wpimath.units.nauticalMiles") {
- return "float";
- }
- if (type === "wpimath.units.newton_meters") {
- return "float";
- }
- if (type === "wpimath.units.newtons") {
- return "float";
- }
- if (type === "wpimath.units.ohms") {
- return "float";
- }
- if (type === "wpimath.units.ounces") {
- return "float";
- }
- if (type === "wpimath.units.ounces_per_cubic_foot") {
- return "float";
- }
- if (type === "wpimath.units.ounces_per_cubic_inch") {
- return "float";
- }
- if (type === "wpimath.units.ounces_per_gallon") {
- return "float";
- }
- if (type === "wpimath.units.parsecs") {
- return "float";
- }
- if (type === "wpimath.units.parts_per_billion") {
- return "float";
- }
- if (type === "wpimath.units.parts_per_million") {
- return "float";
- }
- if (type === "wpimath.units.parts_per_trillion") {
- return "float";
- }
- if (type === "wpimath.units.pascals") {
- return "float";
- }
- if (type === "wpimath.units.pecks") {
- return "float";
- }
- if (type === "wpimath.units.percent") {
- return "float";
- }
- if (type === "wpimath.units.phots") {
- return "float";
- }
- if (type === "wpimath.units.pinches") {
- return "float";
- }
- if (type === "wpimath.units.pints") {
- return "float";
- }
- if (type === "wpimath.units.poundals") {
- return "float";
- }
- if (type === "wpimath.units.pounds") {
- return "float";
- }
- if (type === "wpimath.units.pounds_per_cubic_foot") {
- return "float";
- }
- if (type === "wpimath.units.pounds_per_cubic_inch") {
- return "float";
- }
- if (type === "wpimath.units.pounds_per_gallon") {
- return "float";
- }
- if (type === "wpimath.units.pounds_per_square_inch") {
- return "float";
- }
- if (type === "wpimath.units.quarts") {
- return "float";
- }
- if (type === "wpimath.units.radians") {
- return "float";
- }
- if (type === "wpimath.units.radians_per_meter") {
- return "float";
- }
- if (type === "wpimath.units.radians_per_second") {
- return "float";
- }
- if (type === "wpimath.units.radians_per_second_per_volt") {
- return "float";
- }
- if (type === "wpimath.units.radians_per_second_squared") {
- return "float";
- }
- if (type === "wpimath.units.rads") {
- return "float";
- }
- if (type === "wpimath.units.rankine") {
- return "float";
- }
- if (type === "wpimath.units.reaumur") {
- return "float";
- }
- if (type === "wpimath.units.revolutions_per_minute") {
- return "float";
- }
- if (type === "wpimath.units.rutherfords") {
- return "float";
- }
- if (type === "wpimath.units.sacks") {
- return "float";
- }
- if (type === "wpimath.units.seconds") {
- return "float";
- }
- if (type === "wpimath.units.short_tons") {
- return "float";
- }
- if (type === "wpimath.units.shots") {
- return "float";
- }
- if (type === "wpimath.units.siemens") {
- return "float";
- }
- if (type === "wpimath.units.sieverts") {
- return "float";
- }
- if (type === "wpimath.units.slugs") {
- return "float";
- }
- if (type === "wpimath.units.slugs_per_cubic_foot") {
- return "float";
- }
- if (type === "wpimath.units.spats") {
- return "float";
- }
- if (type === "wpimath.units.square_feet") {
- return "float";
- }
- if (type === "wpimath.units.square_inches") {
- return "float";
- }
- if (type === "wpimath.units.square_kilometers") {
- return "float";
- }
- if (type === "wpimath.units.square_meters") {
- return "float";
- }
- if (type === "wpimath.units.square_miles") {
- return "float";
- }
- if (type === "wpimath.units.standard_gravity") {
- return "float";
- }
- if (type === "wpimath.units.statvolts") {
- return "float";
- }
- if (type === "wpimath.units.steradians") {
- return "float";
- }
- if (type === "wpimath.units.stone") {
- return "float";
- }
- if (type === "wpimath.units.strikes") {
- return "float";
- }
- if (type === "wpimath.units.tablespoons") {
- return "float";
- }
- if (type === "wpimath.units.teaspoons") {
- return "float";
- }
- if (type === "wpimath.units.teslas") {
- return "float";
- }
- if (type === "wpimath.units.therms") {
- return "float";
- }
- if (type === "wpimath.units.torrs") {
- return "float";
- }
- if (type === "wpimath.units.turns") {
- return "float";
- }
- if (type === "wpimath.units.turns_per_second") {
- return "float";
- }
- if (type === "wpimath.units.turns_per_second_squared") {
- return "float";
- }
- if (type === "wpimath.units.unit_seconds_squared_per_unit") {
- return "float";
- }
- if (type === "wpimath.units.units_per_second") {
- return "float";
- }
- if (type === "wpimath.units.units_per_second_squared") {
- return "float";
- }
- if (type === "wpimath.units.volt_seconds") {
- return "float";
- }
- if (type === "wpimath.units.volt_seconds_per_feet") {
- return "float";
- }
- if (type === "wpimath.units.volt_seconds_per_meter") {
- return "float";
- }
- if (type === "wpimath.units.volt_seconds_per_radian") {
- return "float";
- }
- if (type === "wpimath.units.volt_seconds_squared") {
- return "float";
- }
- if (type === "wpimath.units.volt_seconds_squared_per_feet") {
- return "float";
- }
- if (type === "wpimath.units.volt_seconds_squared_per_meter") {
- return "float";
- }
- if (type === "wpimath.units.volt_seconds_squared_per_radian") {
- return "float";
- }
- if (type === "wpimath.units.volts") {
- return "float";
- }
- if (type === "wpimath.units.watt_hours") {
- return "float";
- }
- if (type === "wpimath.units.watts") {
- return "float";
- }
- if (type === "wpimath.units.webers") {
- return "float";
- }
- if (type === "wpimath.units.weeks") {
- return "float";
- }
- if (type === "wpimath.units.yards") {
- return "float";
- }
- if (type === "wpimath.units.years") {
- return "float";
- }
- return "";
-}
-
-// For the given python type, returns an array of compatible input types.
-export function getAllowedTypes(type: string): string[] {
- // Subclasses
- if (type === "hal.AddressableLEDData") {
- return ['hal.AddressableLEDData', 'wpilib.AddressableLED.LEDData'];
- }
- if (type === "hal.SimValue") {
- return ['hal.SimValue', 'hal.SimBoolean', 'hal.SimDouble', 'hal.SimEnum', 'hal.SimInt', 'hal.SimLong'];
- }
- if (type === "ntcore.BooleanArrayPublisher") {
- return ['ntcore.BooleanArrayPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.BooleanArraySubscriber") {
- return ['ntcore.BooleanArraySubscriber', 'ntcore.BooleanArrayEntry'];
- }
- if (type === "ntcore.BooleanPublisher") {
- return ['ntcore.BooleanPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.BooleanSubscriber") {
- return ['ntcore.BooleanSubscriber', 'ntcore.BooleanEntry'];
- }
- if (type === "ntcore.DoubleArrayPublisher") {
- return ['ntcore.DoubleArrayPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.DoubleArraySubscriber") {
- return ['ntcore.DoubleArraySubscriber', 'ntcore.DoubleArrayEntry'];
- }
- if (type === "ntcore.DoublePublisher") {
- return ['ntcore.DoublePublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.DoubleSubscriber") {
- return ['ntcore.DoubleSubscriber', 'ntcore.DoubleEntry'];
- }
- if (type === "ntcore.FloatArrayPublisher") {
- return ['ntcore.FloatArrayPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.FloatArraySubscriber") {
- return ['ntcore.FloatArraySubscriber', 'ntcore.FloatArrayEntry'];
- }
- if (type === "ntcore.FloatPublisher") {
- return ['ntcore.FloatPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.FloatSubscriber") {
- return ['ntcore.FloatSubscriber', 'ntcore.FloatEntry'];
- }
- if (type === "ntcore.GenericPublisher") {
- return ['ntcore.GenericPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.GenericSubscriber") {
- return ['ntcore.GenericSubscriber', 'ntcore.GenericEntry'];
- }
- if (type === "ntcore.IntegerArrayPublisher") {
- return ['ntcore.IntegerArrayPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.IntegerArraySubscriber") {
- return ['ntcore.IntegerArraySubscriber', 'ntcore.IntegerArrayEntry'];
- }
- if (type === "ntcore.IntegerPublisher") {
- return ['ntcore.IntegerPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.IntegerSubscriber") {
- return ['ntcore.IntegerSubscriber', 'ntcore.IntegerEntry'];
- }
- if (type === "ntcore.NTSendable") {
- return ['ntcore.NTSendable', 'wpilib.ADXL345_I2C', 'wpilib.ADXL345_SPI', 'wpilib.ADXL362', 'wpilib.Field2d', 'wpilib.Mechanism2d'];
- }
- if (type === "ntcore.NTSendableBuilder") {
- return ['ntcore.NTSendableBuilder', 'wpilib.SendableBuilderImpl'];
- }
- if (type === "ntcore.Publisher") {
- return ['ntcore.Publisher', 'ntcore.BooleanArrayPublisher', 'ntcore.BooleanPublisher', 'ntcore.DoubleArrayPublisher', 'ntcore.DoublePublisher', 'ntcore.FloatArrayPublisher', 'ntcore.FloatPublisher', 'ntcore.GenericPublisher', 'ntcore.IntegerArrayPublisher', 'ntcore.IntegerPublisher', 'ntcore.RawPublisher', 'ntcore.StringArrayPublisher', 'ntcore.StringPublisher', 'ntcore.StructArrayPublisher', 'ntcore.StructPublisher'];
- }
- if (type === "ntcore.RawPublisher") {
- return ['ntcore.RawPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.RawSubscriber") {
- return ['ntcore.RawSubscriber', 'ntcore.RawEntry'];
- }
- if (type === "ntcore.StringArrayPublisher") {
- return ['ntcore.StringArrayPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.StringArraySubscriber") {
- return ['ntcore.StringArraySubscriber', 'ntcore.StringArrayEntry'];
- }
- if (type === "ntcore.StringPublisher") {
- return ['ntcore.StringPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.StringSubscriber") {
- return ['ntcore.StringSubscriber', 'ntcore.StringEntry'];
- }
- if (type === "ntcore.StructArrayPublisher") {
- return ['ntcore.StructArrayPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.StructArraySubscriber") {
- return ['ntcore.StructArraySubscriber', 'ntcore.StructArrayEntry'];
- }
- if (type === "ntcore.StructPublisher") {
- return ['ntcore.StructPublisher', 'ntcore.Subscriber'];
- }
- if (type === "ntcore.StructSubscriber") {
- return ['ntcore.StructSubscriber', 'ntcore.StructEntry'];
- }
- if (type === "ntcore.Subscriber") {
- return ['ntcore.Subscriber', 'ntcore.BooleanArraySubscriber', 'ntcore.BooleanSubscriber', 'ntcore.DoubleArraySubscriber', 'ntcore.DoubleSubscriber', 'ntcore.FloatArraySubscriber', 'ntcore.FloatSubscriber', 'ntcore.GenericSubscriber', 'ntcore.IntegerArraySubscriber', 'ntcore.IntegerSubscriber', 'ntcore.RawSubscriber', 'ntcore.StringArraySubscriber', 'ntcore.StringSubscriber', 'ntcore.StructArraySubscriber', 'ntcore.StructSubscriber'];
- }
- if (type === "ntcore.Topic") {
- return ['ntcore.Topic', 'ntcore.BooleanArrayTopic', 'ntcore.BooleanTopic', 'ntcore.DoubleArrayTopic', 'ntcore.DoubleTopic', 'ntcore.FloatArrayTopic', 'ntcore.FloatTopic', 'ntcore.IntegerArrayTopic', 'ntcore.IntegerTopic', 'ntcore.RawTopic', 'ntcore.StringArrayTopic', 'ntcore.StringTopic', 'ntcore.StructArrayTopic', 'ntcore.StructTopic'];
- }
- if (type === "wpilib.DigitalSource") {
- return ['wpilib.DigitalSource', 'wpilib.AnalogTriggerOutput', 'wpilib.DigitalInput', 'wpilib.DigitalOutput'];
- }
- if (type === "wpilib.IterativeRobotBase") {
- return ['wpilib.IterativeRobotBase', 'wpilib.TimedRobot'];
- }
- if (type === "wpilib.MechanismObject2d") {
- return ['wpilib.MechanismObject2d', 'wpilib.MechanismLigament2d'];
- }
- if (type === "wpilib.MotorSafety") {
- return ['wpilib.MotorSafety', 'wpilib.interfaces.MotorController', 'wpilib.Relay', 'wpilib.drive.RobotDriveBase'];
- }
- if (type === "wpilib.PWM") {
- return ['wpilib.PWM', 'wpilib.Servo'];
- }
- if (type === "wpilib.PWMMotorController") {
- return ['wpilib.PWMMotorController', 'wpilib.DMC60', 'wpilib.Jaguar', 'wpilib.PWMSparkFlex', 'wpilib.PWMSparkMax', 'wpilib.PWMTalonFX', 'wpilib.PWMTalonSRX', 'wpilib.PWMVenom', 'wpilib.PWMVictorSPX', 'wpilib.SD540', 'wpilib.Spark', 'wpilib.Talon', 'wpilib.Victor', 'wpilib.VictorSP'];
- }
- if (type === "wpilib.PneumaticsBase") {
- return ['wpilib.PneumaticsBase', 'wpilib.PneumaticHub', 'wpilib.PneumaticsControlModule'];
- }
- if (type === "wpilib.RobotBase") {
- return ['wpilib.RobotBase', 'wpilib.IterativeRobotBase'];
- }
- if (type === "wpilib.SendableChooserBase") {
- return ['wpilib.SendableChooserBase', 'wpilib.SendableChooser'];
- }
- if (type === "wpilib.TimedRobot") {
- return ['wpilib.TimedRobot', 'wpilib.TimesliceRobot'];
- }
- if (type === "wpilib.drive.RobotDriveBase") {
- return ['wpilib.drive.RobotDriveBase', 'wpilib.drive.DifferentialDrive', 'wpilib.drive.MecanumDrive'];
- }
- if (type === "wpilib.event.BooleanEvent") {
- return ['wpilib.event.BooleanEvent', 'wpilib.event.NetworkBooleanEvent'];
- }
- if (type === "wpilib.interfaces.CounterBase") {
- return ['wpilib.interfaces.CounterBase', 'wpilib.Counter', 'wpilib.Encoder'];
- }
- if (type === "wpilib.interfaces.GenericHID") {
- return ['wpilib.interfaces.GenericHID', 'wpilib.Joystick', 'wpilib.PS4Controller', 'wpilib.PS5Controller', 'wpilib.StadiaController', 'wpilib.XboxController'];
- }
- if (type === "wpilib.interfaces.MotorController") {
- return ['wpilib.interfaces.MotorController', 'wpilib.PWMMotorController', 'wpiutil.Sendable', 'wpilib.NidecBrushless'];
- }
- if (type === "wpilib.shuffleboard.ShuffleboardComponentBase") {
- return ['wpilib.shuffleboard.ShuffleboardComponentBase', 'wpilib.shuffleboard._ComplexComponent', 'wpilib.shuffleboard._LayoutComponent', 'wpilib.shuffleboard._SimpleComponent', 'wpilib.shuffleboard._SuppliedValueComponent_vector_bool', 'wpilib.shuffleboard._SuppliedValueComponent_bool', 'wpilib.shuffleboard._SuppliedValueComponent_vector_double', 'wpilib.shuffleboard._SuppliedValueComponent_double', 'wpilib.shuffleboard._SuppliedValueComponent_vector_float', 'wpilib.shuffleboard._SuppliedValueComponent_float', 'wpilib.shuffleboard._SuppliedValueComponent_vector_int', 'wpilib.shuffleboard._SuppliedValueComponent_integer', 'wpilib.shuffleboard._SuppliedValueComponent_vector_raw', 'wpilib.shuffleboard._SuppliedValueComponent_vector_string', 'wpilib.shuffleboard._SuppliedValueComponent_string'];
- }
- if (type === "wpilib.shuffleboard.ShuffleboardContainer") {
- return ['wpilib.shuffleboard.ShuffleboardContainer', 'wpilib.shuffleboard.ShuffleboardComponentBase', 'wpilib.shuffleboard.ShuffleboardTab'];
- }
- if (type === "wpilib.shuffleboard.ShuffleboardValue") {
- return ['wpilib.shuffleboard.ShuffleboardValue', 'wpilib.shuffleboard.ShuffleboardComponentBase', 'wpilib.shuffleboard.ShuffleboardContainer'];
- }
- if (type === "wpilib.shuffleboard._ComplexComponent") {
- return ['wpilib.shuffleboard._ComplexComponent', 'wpilib.shuffleboard._ComplexWidget'];
- }
- if (type === "wpilib.shuffleboard._ComplexWidget") {
- return ['wpilib.shuffleboard._ComplexWidget', 'wpilib.shuffleboard.ComplexWidget'];
- }
- if (type === "wpilib.shuffleboard._LayoutComponent") {
- return ['wpilib.shuffleboard._LayoutComponent', 'wpilib.shuffleboard.ShuffleboardLayout'];
- }
- if (type === "wpilib.shuffleboard._SimpleComponent") {
- return ['wpilib.shuffleboard._SimpleComponent', 'wpilib.shuffleboard._SimpleWidget'];
- }
- if (type === "wpilib.shuffleboard._SimpleWidget") {
- return ['wpilib.shuffleboard._SimpleWidget', 'wpilib.shuffleboard.SimpleWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_bool") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_bool', 'wpilib.shuffleboard._SuppliedValueWidget_bool'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_double") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_double', 'wpilib.shuffleboard._SuppliedValueWidget_double'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_float") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_float', 'wpilib.shuffleboard._SuppliedValueWidget_float'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_integer") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_integer', 'wpilib.shuffleboard._SuppliedValueWidget_integer'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_string") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_string', 'wpilib.shuffleboard._SuppliedValueWidget_string'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_vector_bool") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_vector_bool', 'wpilib.shuffleboard._SuppliedValueWidget_vector_bool'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_vector_double") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_vector_double', 'wpilib.shuffleboard._SuppliedValueWidget_vector_double'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_vector_float") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_vector_float', 'wpilib.shuffleboard._SuppliedValueWidget_vector_float'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_vector_int") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_vector_int', 'wpilib.shuffleboard._SuppliedValueWidget_vector_int'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_vector_raw") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_vector_raw', 'wpilib.shuffleboard._SuppliedValueWidget_vector_raw'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueComponent_vector_string") {
- return ['wpilib.shuffleboard._SuppliedValueComponent_vector_string', 'wpilib.shuffleboard._SuppliedValueWidget_vector_string'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_bool") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_bool', 'wpilib.shuffleboard.SuppliedBoolValueWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_double") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_double', 'wpilib.shuffleboard.SuppliedDoubleValueWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_float") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_float', 'wpilib.shuffleboard.SuppliedFloatValueWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_integer") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_integer', 'wpilib.shuffleboard.SuppliedIntegerValueWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_string") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_string', 'wpilib.shuffleboard.SuppliedStringValueWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_vector_bool") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_vector_bool', 'wpilib.shuffleboard.SuppliedBoolListValueWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_vector_double") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_vector_double', 'wpilib.shuffleboard.SuppliedDoubleListValueWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_vector_float") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_vector_float', 'wpilib.shuffleboard.SuppliedFloatListValueWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_vector_int") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_vector_int', 'wpilib.shuffleboard.SuppliedIntListValueWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_vector_raw") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_vector_raw', 'wpilib.shuffleboard.SuppliedRawValueWidget'];
- }
- if (type === "wpilib.shuffleboard._SuppliedValueWidget_vector_string") {
- return ['wpilib.shuffleboard._SuppliedValueWidget_vector_string', 'wpilib.shuffleboard.SuppliedStringListValueWidget'];
- }
- if (type === "wpilib.simulation.GenericHIDSim") {
- return ['wpilib.simulation.GenericHIDSim', 'wpilib.simulation.JoystickSim', 'wpilib.simulation.PS4ControllerSim', 'wpilib.simulation.PS5ControllerSim', 'wpilib.simulation.StadiaControllerSim', 'wpilib.simulation.XboxControllerSim'];
- }
- if (type === "wpilib.simulation.LinearSystemSim_1_1_1") {
- return ['wpilib.simulation.LinearSystemSim_1_1_1', 'wpilib.simulation.FlywheelSim'];
- }
- if (type === "wpilib.simulation.LinearSystemSim_2_1_2") {
- return ['wpilib.simulation.LinearSystemSim_2_1_2', 'wpilib.simulation.DCMotorSim', 'wpilib.simulation.ElevatorSim', 'wpilib.simulation.SingleJointedArmSim'];
- }
- if (type === "wpilib.simulation.PneumaticsBaseSim") {
- return ['wpilib.simulation.PneumaticsBaseSim', 'wpilib.simulation.CTREPCMSim', 'wpilib.simulation.REVPHSim'];
- }
- if (type === "wpimath.estimator.DifferentialDrivePoseEstimator3dBase") {
- return ['wpimath.estimator.DifferentialDrivePoseEstimator3dBase', 'wpimath.estimator.DifferentialDrivePoseEstimator3d'];
- }
- if (type === "wpimath.estimator.DifferentialDrivePoseEstimatorBase") {
- return ['wpimath.estimator.DifferentialDrivePoseEstimatorBase', 'wpimath.estimator.DifferentialDrivePoseEstimator'];
- }
- if (type === "wpimath.estimator.MecanumDrivePoseEstimator3dBase") {
- return ['wpimath.estimator.MecanumDrivePoseEstimator3dBase', 'wpimath.estimator.MecanumDrivePoseEstimator3d'];
- }
- if (type === "wpimath.estimator.MecanumDrivePoseEstimatorBase") {
- return ['wpimath.estimator.MecanumDrivePoseEstimatorBase', 'wpimath.estimator.MecanumDrivePoseEstimator'];
- }
- if (type === "wpimath.estimator.SwerveDrive2PoseEstimator3dBase") {
- return ['wpimath.estimator.SwerveDrive2PoseEstimator3dBase', 'wpimath.estimator.SwerveDrive2PoseEstimator3d'];
- }
- if (type === "wpimath.estimator.SwerveDrive2PoseEstimatorBase") {
- return ['wpimath.estimator.SwerveDrive2PoseEstimatorBase', 'wpimath.estimator.SwerveDrive2PoseEstimator'];
- }
- if (type === "wpimath.estimator.SwerveDrive3PoseEstimator3dBase") {
- return ['wpimath.estimator.SwerveDrive3PoseEstimator3dBase', 'wpimath.estimator.SwerveDrive3PoseEstimator3d'];
- }
- if (type === "wpimath.estimator.SwerveDrive3PoseEstimatorBase") {
- return ['wpimath.estimator.SwerveDrive3PoseEstimatorBase', 'wpimath.estimator.SwerveDrive3PoseEstimator'];
- }
- if (type === "wpimath.estimator.SwerveDrive4PoseEstimator3dBase") {
- return ['wpimath.estimator.SwerveDrive4PoseEstimator3dBase', 'wpimath.estimator.SwerveDrive4PoseEstimator3d'];
- }
- if (type === "wpimath.estimator.SwerveDrive4PoseEstimatorBase") {
- return ['wpimath.estimator.SwerveDrive4PoseEstimatorBase', 'wpimath.estimator.SwerveDrive4PoseEstimator'];
- }
- if (type === "wpimath.estimator.SwerveDrive6PoseEstimator3dBase") {
- return ['wpimath.estimator.SwerveDrive6PoseEstimator3dBase', 'wpimath.estimator.SwerveDrive6PoseEstimator3d'];
- }
- if (type === "wpimath.estimator.SwerveDrive6PoseEstimatorBase") {
- return ['wpimath.estimator.SwerveDrive6PoseEstimatorBase', 'wpimath.estimator.SwerveDrive6PoseEstimator'];
- }
- if (type === "wpimath.kinematics.DifferentialDriveKinematicsBase") {
- return ['wpimath.kinematics.DifferentialDriveKinematicsBase', 'wpimath.kinematics.DifferentialDriveKinematics'];
- }
- if (type === "wpimath.kinematics.DifferentialDriveOdometry3dBase") {
- return ['wpimath.kinematics.DifferentialDriveOdometry3dBase', 'wpimath.kinematics.DifferentialDriveOdometry3d'];
- }
- if (type === "wpimath.kinematics.DifferentialDriveOdometryBase") {
- return ['wpimath.kinematics.DifferentialDriveOdometryBase', 'wpimath.kinematics.DifferentialDriveOdometry'];
- }
- if (type === "wpimath.kinematics.MecanumDriveKinematicsBase") {
- return ['wpimath.kinematics.MecanumDriveKinematicsBase', 'wpimath.kinematics.MecanumDriveKinematics'];
- }
- if (type === "wpimath.kinematics.MecanumDriveOdometry3dBase") {
- return ['wpimath.kinematics.MecanumDriveOdometry3dBase', 'wpimath.kinematics.MecanumDriveOdometry3d'];
- }
- if (type === "wpimath.kinematics.MecanumDriveOdometryBase") {
- return ['wpimath.kinematics.MecanumDriveOdometryBase', 'wpimath.kinematics.MecanumDriveOdometry'];
- }
- if (type === "wpimath.kinematics.SwerveDrive2KinematicsBase") {
- return ['wpimath.kinematics.SwerveDrive2KinematicsBase', 'wpimath.kinematics.SwerveDrive2Kinematics'];
- }
- if (type === "wpimath.kinematics.SwerveDrive2Odometry3dBase") {
- return ['wpimath.kinematics.SwerveDrive2Odometry3dBase', 'wpimath.kinematics.SwerveDrive2Odometry3d'];
- }
- if (type === "wpimath.kinematics.SwerveDrive2OdometryBase") {
- return ['wpimath.kinematics.SwerveDrive2OdometryBase', 'wpimath.kinematics.SwerveDrive2Odometry'];
- }
- if (type === "wpimath.kinematics.SwerveDrive3KinematicsBase") {
- return ['wpimath.kinematics.SwerveDrive3KinematicsBase', 'wpimath.kinematics.SwerveDrive3Kinematics'];
- }
- if (type === "wpimath.kinematics.SwerveDrive3Odometry3dBase") {
- return ['wpimath.kinematics.SwerveDrive3Odometry3dBase', 'wpimath.kinematics.SwerveDrive3Odometry3d'];
- }
- if (type === "wpimath.kinematics.SwerveDrive3OdometryBase") {
- return ['wpimath.kinematics.SwerveDrive3OdometryBase', 'wpimath.kinematics.SwerveDrive3Odometry'];
- }
- if (type === "wpimath.kinematics.SwerveDrive4KinematicsBase") {
- return ['wpimath.kinematics.SwerveDrive4KinematicsBase', 'wpimath.kinematics.SwerveDrive4Kinematics'];
- }
- if (type === "wpimath.kinematics.SwerveDrive4Odometry3dBase") {
- return ['wpimath.kinematics.SwerveDrive4Odometry3dBase', 'wpimath.kinematics.SwerveDrive4Odometry3d'];
- }
- if (type === "wpimath.kinematics.SwerveDrive4OdometryBase") {
- return ['wpimath.kinematics.SwerveDrive4OdometryBase', 'wpimath.kinematics.SwerveDrive4Odometry'];
- }
- if (type === "wpimath.kinematics.SwerveDrive6KinematicsBase") {
- return ['wpimath.kinematics.SwerveDrive6KinematicsBase', 'wpimath.kinematics.SwerveDrive6Kinematics'];
- }
- if (type === "wpimath.kinematics.SwerveDrive6Odometry3dBase") {
- return ['wpimath.kinematics.SwerveDrive6Odometry3dBase', 'wpimath.kinematics.SwerveDrive6Odometry3d'];
- }
- if (type === "wpimath.kinematics.SwerveDrive6OdometryBase") {
- return ['wpimath.kinematics.SwerveDrive6OdometryBase', 'wpimath.kinematics.SwerveDrive6Odometry'];
- }
- if (type === "wpimath.spline.Spline3") {
- return ['wpimath.spline.Spline3', 'wpimath.spline.CubicHermiteSpline'];
- }
- if (type === "wpimath.spline.Spline5") {
- return ['wpimath.spline.Spline5', 'wpimath.spline.QuinticHermiteSpline'];
- }
- if (type === "wpimath.trajectory.constraint.TrajectoryConstraint") {
- return ['wpimath.trajectory.constraint.TrajectoryConstraint', 'wpimath.trajectory.constraint.CentripetalAccelerationConstraint', 'wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint', 'wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint', 'wpimath.trajectory.constraint.EllipticalRegionConstraint', 'wpimath.trajectory.constraint.MaxVelocityConstraint', 'wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint', 'wpimath.trajectory.constraint.RectangularRegionConstraint', 'wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint', 'wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint', 'wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint', 'wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint'];
- }
- if (type === "wpiutil.Sendable") {
- return ['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.DigitalSource', 'wpilib.BuiltInAccelerometer', 'wpilib.Compressor', 'wpilib.interfaces.CounterBase', 'wpilib.MotorSafety', 'wpilib.DigitalGlitchFilter', 'wpilib.DoubleSolenoid', 'wpilib.DutyCycle', 'wpilib.DutyCycleEncoder', 'wpilib.MotorControllerGroup', 'wpilib.interfaces.GenericHID', 'wpilib.PWM', 'wpilib.PowerDistribution', 'wpilib.SendableChooserBase', 'wpilib.SharpIR', 'wpilib.Solenoid', 'wpilib.Ultrasonic', 'wpilib.counter.ExternalDirectionCounter', 'wpilib.counter.Tachometer', 'wpilib.counter.UpDownCounter', 'wpimath.controller.BangBangController', 'wpimath.controller.PIDController', 'wpimath.controller.ProfiledPIDController', 'wpimath.controller.ProfiledPIDControllerRadians'];
- }
- if (type === "wpiutil.SendableBuilder") {
- return ['wpiutil.SendableBuilder', 'ntcore.NTSendableBuilder'];
- }
- if (type === "wpiutil.log.DataLog") {
- return ['wpiutil.log.DataLog', 'wpiutil.DataLogBackgroundWriter', 'wpiutil.DataLogWriter'];
- }
- if (type === "wpiutil.log.DataLogEntry") {
- return ['wpiutil.log.DataLogEntry', '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.StructArrayLogEntry', 'wpiutil.log.StructLogEntry'];
- }
- if (type === "wpiutil.log._BooleanArrayLogEntryImpl") {
- return ['wpiutil.log._BooleanArrayLogEntryImpl', 'wpiutil.log.BooleanArrayLogEntry'];
- }
- if (type === "wpiutil.log._BooleanLogEntryImpl") {
- return ['wpiutil.log._BooleanLogEntryImpl', 'wpiutil.log.BooleanLogEntry'];
- }
- if (type === "wpiutil.log._DoubleArrayLogEntryImpl") {
- return ['wpiutil.log._DoubleArrayLogEntryImpl', 'wpiutil.log.DoubleArrayLogEntry'];
- }
- if (type === "wpiutil.log._DoubleLogEntryImpl") {
- return ['wpiutil.log._DoubleLogEntryImpl', 'wpiutil.log.DoubleLogEntry'];
- }
- if (type === "wpiutil.log._FloatArrayLogEntryImpl") {
- return ['wpiutil.log._FloatArrayLogEntryImpl', 'wpiutil.log.FloatArrayLogEntry'];
- }
- if (type === "wpiutil.log._FloatLogEntryImpl") {
- return ['wpiutil.log._FloatLogEntryImpl', 'wpiutil.log.FloatLogEntry'];
- }
- if (type === "wpiutil.log._IntegerArrayLogEntryImpl") {
- return ['wpiutil.log._IntegerArrayLogEntryImpl', 'wpiutil.log.IntegerArrayLogEntry'];
- }
- if (type === "wpiutil.log._IntegerLogEntryImpl") {
- return ['wpiutil.log._IntegerLogEntryImpl', 'wpiutil.log.IntegerLogEntry'];
- }
- if (type === "wpiutil.log._RawLogEntryImpl") {
- return ['wpiutil.log._RawLogEntryImpl', 'wpiutil.log.RawLogEntry'];
- }
- if (type === "wpiutil.log._StringArrayLogEntryImpl") {
- return ['wpiutil.log._StringArrayLogEntryImpl', 'wpiutil.log.StringArrayLogEntry'];
- }
- if (type === "wpiutil.log._StringLogEntryImpl") {
- return ['wpiutil.log._StringLogEntryImpl', 'wpiutil.log.StringLogEntry'];
- }
-
- return [type];
-}
diff --git a/src/blocks/utils/generated/robotpy_data.json b/src/blocks/utils/generated/robotpy_data.json
new file mode 100644
index 00000000..be63f5da
--- /dev/null
+++ b/src/blocks/utils/generated/robotpy_data.json
@@ -0,0 +1,116065 @@
+{
+ "aliases": {
+ "wpimath.units.abvolts": "float",
+ "wpimath.units.acres": "float",
+ "wpimath.units.ampere_hours": "float",
+ "wpimath.units.amperes": "float",
+ "wpimath.units.angstroms": "float",
+ "wpimath.units.arcminutes": "float",
+ "wpimath.units.arcseconds": "float",
+ "wpimath.units.astronicalUnits": "float",
+ "wpimath.units.atmospheres": "float",
+ "wpimath.units.barrels": "float",
+ "wpimath.units.bars": "float",
+ "wpimath.units.becquerels": "float",
+ "wpimath.units.british_thermal_units": "float",
+ "wpimath.units.british_thermal_units_59": "float",
+ "wpimath.units.british_thermal_units_iso": "float",
+ "wpimath.units.bushels": "float",
+ "wpimath.units.calories": "float",
+ "wpimath.units.candelas": "float",
+ "wpimath.units.carats": "float",
+ "wpimath.units.celsius": "float",
+ "wpimath.units.centimeters": "float",
+ "wpimath.units.chains": "float",
+ "wpimath.units.cords": "float",
+ "wpimath.units.coulombs": "float",
+ "wpimath.units.cubic_fathoms": "float",
+ "wpimath.units.cubic_feet": "float",
+ "wpimath.units.cubic_inches": "float",
+ "wpimath.units.cubic_kilometers": "float",
+ "wpimath.units.cubic_meters": "float",
+ "wpimath.units.cubic_miles": "float",
+ "wpimath.units.cubic_millimeters": "float",
+ "wpimath.units.cubic_yards": "float",
+ "wpimath.units.cubits": "float",
+ "wpimath.units.cups": "float",
+ "wpimath.units.curies": "float",
+ "wpimath.units.dashes": "float",
+ "wpimath.units.days": "float",
+ "wpimath.units.degrees": "float",
+ "wpimath.units.degrees_per_second": "float",
+ "wpimath.units.degrees_per_second_squared": "float",
+ "wpimath.units.degrees_squared": "float",
+ "wpimath.units.drams": "float",
+ "wpimath.units.drops": "float",
+ "wpimath.units.dynes": "float",
+ "wpimath.units.exabits": "float",
+ "wpimath.units.exabits_per_second": "float",
+ "wpimath.units.exabytes": "float",
+ "wpimath.units.exabytes_per_second": "float",
+ "wpimath.units.fahrenheit": "float",
+ "wpimath.units.farads": "float",
+ "wpimath.units.fathoms": "float",
+ "wpimath.units.feet": "float",
+ "wpimath.units.feet_per_second": "float",
+ "wpimath.units.feet_per_second_squared": "float",
+ "wpimath.units.fifths": "float",
+ "wpimath.units.fluid_ounces": "float",
+ "wpimath.units.foot_poundals": "float",
+ "wpimath.units.foot_pounds": "float",
+ "wpimath.units.footcandles": "float",
+ "wpimath.units.furlongs": "float",
+ "wpimath.units.gallons": "float",
+ "wpimath.units.gauss": "float",
+ "wpimath.units.gills": "float",
+ "wpimath.units.gradians": "float",
+ "wpimath.units.grams": "float",
+ "wpimath.units.grams_per_milliliter": "float",
+ "wpimath.units.grays": "float",
+ "wpimath.units.gregorian_years": "float",
+ "wpimath.units.hands": "float",
+ "wpimath.units.hectares": "float",
+ "wpimath.units.henries": "float",
+ "wpimath.units.hertz": "float",
+ "wpimath.units.horsepower": "float",
+ "wpimath.units.hours": "float",
+ "wpimath.units.inch_pounds": "float",
+ "wpimath.units.inches": "float",
+ "wpimath.units.joules": "float",
+ "wpimath.units.julian_years": "float",
+ "wpimath.units.kelvin": "float",
+ "wpimath.units.kiloampere_hours": "float",
+ "wpimath.units.kiloamperes": "float",
+ "wpimath.units.kilobecquerels": "float",
+ "wpimath.units.kilocalories": "float",
+ "wpimath.units.kilocandelas": "float",
+ "wpimath.units.kilocoulombs": "float",
+ "wpimath.units.kilofarads": "float",
+ "wpimath.units.kilogram_square_meters": "float",
+ "wpimath.units.kilograms": "float",
+ "wpimath.units.kilograms_per_cubic_meter": "float",
+ "wpimath.units.kilograms_per_liter": "float",
+ "wpimath.units.kilograys": "float",
+ "wpimath.units.kilohenries": "float",
+ "wpimath.units.kilohertz": "float",
+ "wpimath.units.kilojoules": "float",
+ "wpimath.units.kiloliters": "float",
+ "wpimath.units.kilolumens": "float",
+ "wpimath.units.kiloluxes": "float",
+ "wpimath.units.kilometers": "float",
+ "wpimath.units.kilometers_per_hour": "float",
+ "wpimath.units.kilonewtons": "float",
+ "wpimath.units.kiloohms": "float",
+ "wpimath.units.kilopascals": "float",
+ "wpimath.units.kiloponds": "float",
+ "wpimath.units.kiloradians": "float",
+ "wpimath.units.kiloseconds": "float",
+ "wpimath.units.kilosiemens": "float",
+ "wpimath.units.kilosieverts": "float",
+ "wpimath.units.kilosteradians": "float",
+ "wpimath.units.kiloteslas": "float",
+ "wpimath.units.kilovolts": "float",
+ "wpimath.units.kilowatt_hours": "float",
+ "wpimath.units.kilowatts": "float",
+ "wpimath.units.kilowebers": "float",
+ "wpimath.units.knots": "float",
+ "wpimath.units.leagues": "float",
+ "wpimath.units.lightyears": "float",
+ "wpimath.units.liters": "float",
+ "wpimath.units.long_tons": "float",
+ "wpimath.units.lumens": "float",
+ "wpimath.units.lumens_per_square_inch": "float",
+ "wpimath.units.luxes": "float",
+ "wpimath.units.maxwells": "float",
+ "wpimath.units.mbars": "float",
+ "wpimath.units.meter_kilograms": "float",
+ "wpimath.units.meters": "float",
+ "wpimath.units.meters_per_second": "float",
+ "wpimath.units.meters_per_second_squared": "float",
+ "wpimath.units.meters_per_second_squared_per_volt": "float",
+ "wpimath.units.metric_tons": "float",
+ "wpimath.units.microampere_hours": "float",
+ "wpimath.units.microamperes": "float",
+ "wpimath.units.microbecquerels": "float",
+ "wpimath.units.microcalories": "float",
+ "wpimath.units.microcandelas": "float",
+ "wpimath.units.microcoulombs": "float",
+ "wpimath.units.microfarads": "float",
+ "wpimath.units.micrograms": "float",
+ "wpimath.units.micrograys": "float",
+ "wpimath.units.microhenries": "float",
+ "wpimath.units.microhertz": "float",
+ "wpimath.units.microjoules": "float",
+ "wpimath.units.microliters": "float",
+ "wpimath.units.microlumens": "float",
+ "wpimath.units.microluxes": "float",
+ "wpimath.units.micrometers": "float",
+ "wpimath.units.micronewtons": "float",
+ "wpimath.units.microohms": "float",
+ "wpimath.units.micropascals": "float",
+ "wpimath.units.microradians": "float",
+ "wpimath.units.microseconds": "float",
+ "wpimath.units.microsiemens": "float",
+ "wpimath.units.microsieverts": "float",
+ "wpimath.units.microsteradians": "float",
+ "wpimath.units.microteslas": "float",
+ "wpimath.units.microvolts": "float",
+ "wpimath.units.microwatts": "float",
+ "wpimath.units.microwebers": "float",
+ "wpimath.units.miles": "float",
+ "wpimath.units.miles_per_hour": "float",
+ "wpimath.units.milliampere_hours": "float",
+ "wpimath.units.milliamperes": "float",
+ "wpimath.units.milliarcseconds": "float",
+ "wpimath.units.milliarcseconds_per_year": "float",
+ "wpimath.units.millibecquerels": "float",
+ "wpimath.units.millicalories": "float",
+ "wpimath.units.millicandelas": "float",
+ "wpimath.units.millicoulombs": "float",
+ "wpimath.units.millifarads": "float",
+ "wpimath.units.milligrams": "float",
+ "wpimath.units.milligrays": "float",
+ "wpimath.units.millihenries": "float",
+ "wpimath.units.millihertz": "float",
+ "wpimath.units.millijoules": "float",
+ "wpimath.units.milliliters": "float",
+ "wpimath.units.millilumens": "float",
+ "wpimath.units.milliluxes": "float",
+ "wpimath.units.millimeters": "float",
+ "wpimath.units.millinewtons": "float",
+ "wpimath.units.milliohms": "float",
+ "wpimath.units.millipascals": "float",
+ "wpimath.units.milliradians": "float",
+ "wpimath.units.milliseconds": "float",
+ "wpimath.units.millisiemens": "float",
+ "wpimath.units.millisieverts": "float",
+ "wpimath.units.millisteradians": "float",
+ "wpimath.units.milliteslas": "float",
+ "wpimath.units.millivolts": "float",
+ "wpimath.units.milliwatts": "float",
+ "wpimath.units.milliwebers": "float",
+ "wpimath.units.mils": "float",
+ "wpimath.units.minutes": "float",
+ "wpimath.units.moles": "float",
+ "wpimath.units.nanoampere_hours": "float",
+ "wpimath.units.nanoamperes": "float",
+ "wpimath.units.nanobecquerels": "float",
+ "wpimath.units.nanocalories": "float",
+ "wpimath.units.nanocandelas": "float",
+ "wpimath.units.nanocoulombs": "float",
+ "wpimath.units.nanofarads": "float",
+ "wpimath.units.nanograms": "float",
+ "wpimath.units.nanograys": "float",
+ "wpimath.units.nanohenries": "float",
+ "wpimath.units.nanohertz": "float",
+ "wpimath.units.nanojoules": "float",
+ "wpimath.units.nanoliters": "float",
+ "wpimath.units.nanolumens": "float",
+ "wpimath.units.nanoluxes": "float",
+ "wpimath.units.nanometers": "float",
+ "wpimath.units.nanonewtons": "float",
+ "wpimath.units.nanoohms": "float",
+ "wpimath.units.nanopascals": "float",
+ "wpimath.units.nanoradians": "float",
+ "wpimath.units.nanoseconds": "float",
+ "wpimath.units.nanosiemens": "float",
+ "wpimath.units.nanosieverts": "float",
+ "wpimath.units.nanosteradians": "float",
+ "wpimath.units.nanoteslas": "float",
+ "wpimath.units.nanovolts": "float",
+ "wpimath.units.nanowatts": "float",
+ "wpimath.units.nanowebers": "float",
+ "wpimath.units.nauticalLeagues": "float",
+ "wpimath.units.nauticalMiles": "float",
+ "wpimath.units.newton_meters": "float",
+ "wpimath.units.newtons": "float",
+ "wpimath.units.ohms": "float",
+ "wpimath.units.ounces": "float",
+ "wpimath.units.ounces_per_cubic_foot": "float",
+ "wpimath.units.ounces_per_cubic_inch": "float",
+ "wpimath.units.ounces_per_gallon": "float",
+ "wpimath.units.parsecs": "float",
+ "wpimath.units.parts_per_billion": "float",
+ "wpimath.units.parts_per_million": "float",
+ "wpimath.units.parts_per_trillion": "float",
+ "wpimath.units.pascals": "float",
+ "wpimath.units.pecks": "float",
+ "wpimath.units.percent": "float",
+ "wpimath.units.phots": "float",
+ "wpimath.units.pinches": "float",
+ "wpimath.units.pints": "float",
+ "wpimath.units.poundals": "float",
+ "wpimath.units.pounds": "float",
+ "wpimath.units.pounds_per_cubic_foot": "float",
+ "wpimath.units.pounds_per_cubic_inch": "float",
+ "wpimath.units.pounds_per_gallon": "float",
+ "wpimath.units.pounds_per_square_inch": "float",
+ "wpimath.units.quarts": "float",
+ "wpimath.units.radians": "float",
+ "wpimath.units.radians_per_meter": "float",
+ "wpimath.units.radians_per_second": "float",
+ "wpimath.units.radians_per_second_per_volt": "float",
+ "wpimath.units.radians_per_second_squared": "float",
+ "wpimath.units.rads": "float",
+ "wpimath.units.rankine": "float",
+ "wpimath.units.reaumur": "float",
+ "wpimath.units.revolutions_per_minute": "float",
+ "wpimath.units.rutherfords": "float",
+ "wpimath.units.sacks": "float",
+ "wpimath.units.seconds": "float",
+ "wpimath.units.short_tons": "float",
+ "wpimath.units.shots": "float",
+ "wpimath.units.siemens": "float",
+ "wpimath.units.sieverts": "float",
+ "wpimath.units.slugs": "float",
+ "wpimath.units.slugs_per_cubic_foot": "float",
+ "wpimath.units.spats": "float",
+ "wpimath.units.square_feet": "float",
+ "wpimath.units.square_inches": "float",
+ "wpimath.units.square_kilometers": "float",
+ "wpimath.units.square_meters": "float",
+ "wpimath.units.square_miles": "float",
+ "wpimath.units.standard_gravity": "float",
+ "wpimath.units.statvolts": "float",
+ "wpimath.units.steradians": "float",
+ "wpimath.units.stone": "float",
+ "wpimath.units.strikes": "float",
+ "wpimath.units.tablespoons": "float",
+ "wpimath.units.teaspoons": "float",
+ "wpimath.units.teslas": "float",
+ "wpimath.units.therms": "float",
+ "wpimath.units.torrs": "float",
+ "wpimath.units.turns": "float",
+ "wpimath.units.turns_per_second": "float",
+ "wpimath.units.turns_per_second_squared": "float",
+ "wpimath.units.unit_seconds_squared_per_unit": "float",
+ "wpimath.units.units_per_second": "float",
+ "wpimath.units.units_per_second_squared": "float",
+ "wpimath.units.volt_seconds": "float",
+ "wpimath.units.volt_seconds_per_feet": "float",
+ "wpimath.units.volt_seconds_per_meter": "float",
+ "wpimath.units.volt_seconds_per_radian": "float",
+ "wpimath.units.volt_seconds_squared": "float",
+ "wpimath.units.volt_seconds_squared_per_feet": "float",
+ "wpimath.units.volt_seconds_squared_per_meter": "float",
+ "wpimath.units.volt_seconds_squared_per_radian": "float",
+ "wpimath.units.volts": "float",
+ "wpimath.units.watt_hours": "float",
+ "wpimath.units.watts": "float",
+ "wpimath.units.webers": "float",
+ "wpimath.units.weeks": "float",
+ "wpimath.units.yards": "float",
+ "wpimath.units.years": "float"
+ },
+ "classes": [
+ {
+ "className": "hal.AddressableLEDData",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.AddressableLEDData",
+ "functionName": "__init__",
+ "returnType": "hal.AddressableLEDData",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "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": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.CANStreamMessage",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.CANStreamMessage",
+ "functionName": "__init__",
+ "returnType": "hal.CANStreamMessage",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "data",
+ "tooltip": "The message data",
+ "type": "memoryview",
+ "writable": null
+ },
+ {
+ "name": "dataSize",
+ "tooltip": "The size of the data received (0-8 bytes)",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "messageID",
+ "tooltip": "The message ID",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "timeStamp",
+ "tooltip": "The packet received timestamp (based off of CLOCK_MONOTONIC)",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.ControlWord",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.ControlWord",
+ "functionName": "__init__",
+ "returnType": "hal.ControlWord",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "autonomous",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "control_reserved",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "dsAttached",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "eStop",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "enabled",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "fmsAttached",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "test",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.JoystickAxes",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.JoystickAxes",
+ "functionName": "__init__",
+ "returnType": "hal.JoystickAxes",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "axes",
+ "tooltip": "",
+ "type": "memoryview",
+ "writable": null
+ },
+ {
+ "name": "count",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "raw",
+ "tooltip": "",
+ "type": "memoryview",
+ "writable": null
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.JoystickButtons",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.JoystickButtons",
+ "functionName": "__init__",
+ "returnType": "hal.JoystickButtons",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "buttons",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "count",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.JoystickDescriptor",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.JoystickDescriptor",
+ "functionName": "__init__",
+ "returnType": "hal.JoystickDescriptor",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "axisCount",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "axisTypes",
+ "tooltip": "",
+ "type": "memoryview",
+ "writable": null
+ },
+ {
+ "name": "buttonCount",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "isXbox",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "name",
+ "tooltip": "",
+ "type": "memoryview",
+ "writable": null
+ },
+ {
+ "name": "povCount",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "type",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.JoystickPOVs",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.JoystickPOVs",
+ "functionName": "__init__",
+ "returnType": "hal.JoystickPOVs",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "count",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "povs",
+ "tooltip": "",
+ "type": "memoryview",
+ "writable": null
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.MatchInfo",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.MatchInfo",
+ "functionName": "__init__",
+ "returnType": "hal.MatchInfo",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "eventName",
+ "tooltip": "",
+ "type": "memoryview",
+ "writable": null
+ },
+ {
+ "name": "gameSpecificMessage",
+ "tooltip": "",
+ "type": "memoryview",
+ "writable": null
+ },
+ {
+ "name": "gameSpecificMessageSize",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "matchNumber",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "matchType",
+ "tooltip": "",
+ "type": "hal.MatchType",
+ "writable": true
+ },
+ {
+ "name": "replayNumber",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.PowerDistributionFaults",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.PowerDistributionFaults",
+ "functionName": "__init__",
+ "returnType": "hal.PowerDistributionFaults",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "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
+ },
+ {
+ "name": "channel9BreakerFault",
+ "tooltip": "Breaker fault on channel 9.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "hardwareFault",
+ "tooltip": "The hardware on the device has malfunctioned.",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.PowerDistributionStickyFaults",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.PowerDistributionStickyFaults",
+ "functionName": "__init__",
+ "returnType": "hal.PowerDistributionStickyFaults",
+ "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": "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
+ },
+ {
+ "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
+ },
+ {
+ "name": "hasReset",
+ "tooltip": "The device has rebooted.",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.PowerDistributionVersion",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.PowerDistributionVersion",
+ "functionName": "__init__",
+ "returnType": "hal.PowerDistributionVersion",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "firmwareFix",
+ "tooltip": "Firmware fix version number.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "firmwareMajor",
+ "tooltip": "Firmware major version number.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "firmwareMinor",
+ "tooltip": "Firmware minor version number.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "hardwareMajor",
+ "tooltip": "Hardware major version number.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "hardwareMinor",
+ "tooltip": "Hardware minor version number.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "uniqueId",
+ "tooltip": "Unique ID.",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.REVPHCompressorConfig",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.REVPHCompressorConfig",
+ "functionName": "__init__",
+ "returnType": "hal.REVPHCompressorConfig",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "forceDisable",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "maxAnalogVoltage",
+ "tooltip": "",
+ "type": "float",
+ "writable": true
+ },
+ {
+ "name": "minAnalogVoltage",
+ "tooltip": "",
+ "type": "float",
+ "writable": true
+ },
+ {
+ "name": "useDigital",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.REVPHFaults",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.REVPHFaults",
+ "functionName": "__init__",
+ "returnType": "hal.REVPHFaults",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "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
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.REVPHStickyFaults",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.REVPHStickyFaults",
+ "functionName": "__init__",
+ "returnType": "hal.REVPHStickyFaults",
+ "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
+ },
+ {
+ "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
+ },
+ {
+ "name": "hasReset",
+ "tooltip": "The device has rebooted.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "solenoidOverCurrent",
+ "tooltip": "An overcurrent event occurred on a solenoid output.",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.REVPHVersion",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.REVPHVersion",
+ "functionName": "__init__",
+ "returnType": "hal.REVPHVersion",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "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": "uniqueId",
+ "tooltip": "The device's unique ID.",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.SimBoolean",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimBoolean",
+ "functionName": "__init__",
+ "returnType": "hal.SimBoolean",
+ "tooltip": "Wraps a simulated value handle as returned by HAL_CreateSimValueBoolean().\n\n:param handle: simulated value handle"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimBoolean"
+ }
+ ],
+ "declaringClassName": "hal.SimBoolean",
+ "functionName": "get",
+ "returnType": "bool",
+ "tooltip": "Gets the simulated value.\n\n:returns: The current value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimBoolean"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "hal.SimBoolean",
+ "functionName": "set",
+ "returnType": "None",
+ "tooltip": "Sets the simulated value.\n\n:param value: the value to set"
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "type",
+ "tooltip": "",
+ "type": "hal.Type",
+ "writable": null
+ },
+ {
+ "name": "value",
+ "tooltip": "",
+ "type": "bool",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.SimDevice",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "hal.SimDevice",
+ "functionName": "__init__",
+ "returnType": "hal.SimDevice",
+ "tooltip": "Creates a simulated device.\n\nThe device name must be unique. Returns null if the device name\nalready exists. If multiple instances of the same device are desired,\nrecommend appending the instance/unique identifier in brackets to the base\nname, e.g. \"device[1]\".\n\nUsing a device name of the form \"Type:Name\" will create a WebSockets node\nwith a type value of \"Type\" and a device value of \"Name\"\n\nIf not in simulation, results in an \"empty\" object that evaluates to false\nin a boolean context.\n\n:param name: device name"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimDevice",
+ "functionName": "__init__",
+ "returnType": "hal.SimDevice",
+ "tooltip": "Creates a simulated device.\n\nThe device name must be unique. Returns null if the device name\nalready exists. This is a convenience method that appends index in\nbrackets to the device name, e.g. passing index=1 results in \"device[1]\"\nfor the device name.\n\nUsing a device name of the form \"Type:Name\" will create a WebSockets node\nwith a type value of \"Type\" and a device value of \"Name\"\n\nIf not in simulation, results in an \"empty\" object that evaluates to false\nin a boolean context.\n\n:param name: device name\n:param index: device index number to append to name"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimDevice",
+ "functionName": "__init__",
+ "returnType": "hal.SimDevice",
+ "tooltip": "Creates a simulated device.\n\nThe device name must be unique. Returns null if the device name\nalready exists. This is a convenience method that appends index and\nchannel in brackets to the device name, e.g. passing index=1 and channel=2\nresults in \"device[1,2]\" for the device name.\n\nUsing a device name of the form \"Type:Name\" will create a WebSockets node\nwith a type value of \"Type\" and a device value of \"Name\"\n\nIf not in simulation, results in an \"empty\" object that evaluates to false\nin a boolean context.\n\n:param name: device name\n:param index: device index number to append to name\n:param channel: device channel number to append to name"
+ }
+ ],
+ "enums": [
+ {
+ "enumClassName": "hal.SimDevice.Direction",
+ "enumValues": [
+ "kBidir",
+ "kInput",
+ "kOutput"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Direction of a simulated value (from the perspective of user code).\n\nMembers:\n\n kInput\n\n kOutput\n\n kBidir"
+ }
+ ],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimDevice"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "direction",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialValue",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "hal.SimDevice",
+ "functionName": "createBoolean",
+ "returnType": "hal.SimBoolean",
+ "tooltip": "Creates a boolean value on the simulated device.\n\nIf not in simulation, results in an \"empty\" object that evaluates to false\nin a boolean context.\n\n:param name: value name\n:param direction: input/output/bidir (from perspective of user code)\n:param initialValue: initial value\n\n:returns: simulated boolean value object"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimDevice"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "direction",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialValue",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "hal.SimDevice",
+ "functionName": "createDouble",
+ "returnType": "hal.SimDouble",
+ "tooltip": "Creates a double value on the simulated device.\n\nIf not in simulation, results in an \"empty\" object that evaluates to false\nin a boolean context.\n\n:param name: value name\n:param direction: input/output/bidir (from perspective of user code)\n:param initialValue: initial value\n\n:returns: simulated double value object"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimDevice"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "direction",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "options",
+ "type": "list[str]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialValue",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimDevice",
+ "functionName": "createEnum",
+ "returnType": "hal.SimEnum",
+ "tooltip": "Creates an enumerated value on the simulated device.\n\nEnumerated values are always in the range 0 to numOptions-1.\n\nIf not in simulation, results in an \"empty\" object that evaluates to false\nin a boolean context.\n\n:param name: value name\n:param direction: input/output/bidir (from perspective of user code)\n:param options: array of option descriptions\n:param initialValue: initial value (selection)\n\n:returns: simulated enum value object"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimDevice"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "direction",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "options",
+ "type": "list[str]"
+ },
+ {
+ "defaultValue": null,
+ "name": "optionValues",
+ "type": "list[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialValue",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimDevice",
+ "functionName": "createEnumDouble",
+ "returnType": "hal.SimEnum",
+ "tooltip": "Creates an enumerated value on the simulated device with double values.\n\nEnumerated values are always in the range 0 to numOptions-1.\n\nIf not in simulation, results in an \"empty\" object that evaluates to false\nin a boolean context.\n\n:param name: value name\n:param direction: input/output/bidir (from perspective of user code)\n:param options: array of option descriptions\n:param optionValues: array of option values (must be the same size as\n options)\n:param initialValue: initial value (selection)\n\n:returns: simulated enum value object"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimDevice"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "direction",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialValue",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimDevice",
+ "functionName": "createInt",
+ "returnType": "hal.SimInt",
+ "tooltip": "Creates an int value on the simulated device.\n\nIf not in simulation, results in an \"empty\" object that evaluates to false\nin a boolean context.\n\n:param name: value name\n:param direction: input/output/bidir (from perspective of user code)\n:param initialValue: initial value\n\n:returns: simulated double value object"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimDevice"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "direction",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialValue",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimDevice",
+ "functionName": "createLong",
+ "returnType": "hal.SimLong",
+ "tooltip": "Creates a long value on the simulated device.\n\nIf not in simulation, results in an \"empty\" object that evaluates to false\nin a boolean context.\n\n:param name: value name\n:param direction: input/output/bidir (from perspective of user code)\n:param initialValue: initial value\n\n:returns: simulated double value object"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimDevice"
+ }
+ ],
+ "declaringClassName": "hal.SimDevice",
+ "functionName": "getName",
+ "returnType": "str",
+ "tooltip": "Get the name of the simulated device.\n\n:returns: name"
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "name",
+ "tooltip": "",
+ "type": "str",
+ "writable": null
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.SimDouble",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimDouble",
+ "functionName": "__init__",
+ "returnType": "hal.SimDouble",
+ "tooltip": "Wraps a simulated value handle as returned by HAL_CreateSimValueDouble().\n\n:param handle: simulated value handle"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimDouble"
+ }
+ ],
+ "declaringClassName": "hal.SimDouble",
+ "functionName": "get",
+ "returnType": "float",
+ "tooltip": "Gets the simulated value.\n\n:returns: The current value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimDouble"
+ }
+ ],
+ "declaringClassName": "hal.SimDouble",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the simulated value to 0. Use this instead of Set(0) for resetting\nincremental sensor values like encoder counts or gyro accumulated angle\nto ensure correct behavior in a distributed system (e.g. WebSockets)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimDouble"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "hal.SimDouble",
+ "functionName": "set",
+ "returnType": "None",
+ "tooltip": "Sets the simulated value.\n\n:param value: the value to set"
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "type",
+ "tooltip": "",
+ "type": "hal.Type",
+ "writable": null
+ },
+ {
+ "name": "value",
+ "tooltip": "",
+ "type": "float",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.SimEnum",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimEnum",
+ "functionName": "__init__",
+ "returnType": "hal.SimEnum",
+ "tooltip": "Wraps a simulated value handle as returned by HAL_CreateSimValueEnum().\n\n:param handle: simulated value handle"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimEnum"
+ }
+ ],
+ "declaringClassName": "hal.SimEnum",
+ "functionName": "get",
+ "returnType": "int",
+ "tooltip": "Gets the simulated value.\n\n:returns: The current value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimEnum"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimEnum",
+ "functionName": "set",
+ "returnType": "None",
+ "tooltip": "Sets the simulated value.\n\n:param value: the value to set"
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "type",
+ "tooltip": "",
+ "type": "hal.Type",
+ "writable": null
+ },
+ {
+ "name": "value",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.SimInt",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimInt",
+ "functionName": "__init__",
+ "returnType": "hal.SimInt",
+ "tooltip": "Wraps a simulated value handle as returned by HAL_CreateSimValueInt().\n\n:param handle: simulated value handle"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimInt"
+ }
+ ],
+ "declaringClassName": "hal.SimInt",
+ "functionName": "get",
+ "returnType": "int",
+ "tooltip": "Gets the simulated value.\n\n:returns: The current value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimInt"
+ }
+ ],
+ "declaringClassName": "hal.SimInt",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the simulated value to 0. Use this instead of Set(0) for resetting\nincremental sensor values like encoder counts or gyro accumulated angle\nto ensure correct behavior in a distributed system (e.g. WebSockets)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimInt"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimInt",
+ "functionName": "set",
+ "returnType": "None",
+ "tooltip": "Sets the simulated value.\n\n:param value: the value to set"
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "type",
+ "tooltip": "",
+ "type": "hal.Type",
+ "writable": null
+ },
+ {
+ "name": "value",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.SimLong",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimLong",
+ "functionName": "__init__",
+ "returnType": "hal.SimLong",
+ "tooltip": "Wraps a simulated value handle as returned by HAL_CreateSimValueLong().\n\n:param handle: simulated value handle"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimLong"
+ }
+ ],
+ "declaringClassName": "hal.SimLong",
+ "functionName": "get",
+ "returnType": "int",
+ "tooltip": "Gets the simulated value.\n\n:returns: The current value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimLong"
+ }
+ ],
+ "declaringClassName": "hal.SimLong",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the simulated value to 0. Use this instead of Set(0) for resetting\nincremental sensor values like encoder counts or gyro accumulated angle\nto ensure correct behavior in a distributed system (e.g. WebSockets)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.SimLong"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimLong",
+ "functionName": "set",
+ "returnType": "None",
+ "tooltip": "Sets the simulated value.\n\n:param value: the value to set"
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "type",
+ "tooltip": "",
+ "type": "hal.Type",
+ "writable": null
+ },
+ {
+ "name": "value",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.SimValue",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "hal.SimValue",
+ "functionName": "__init__",
+ "returnType": "hal.SimValue",
+ "tooltip": "Wraps a simulated value handle as returned by HAL_CreateSimValue().\n\n:param handle: simulated value handle"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "type",
+ "tooltip": "",
+ "type": "hal.Type",
+ "writable": null
+ },
+ {
+ "name": "value",
+ "tooltip": "",
+ "type": "object",
+ "writable": null
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.Value",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "type",
+ "tooltip": "",
+ "type": "hal.Type",
+ "writable": null
+ },
+ {
+ "name": "value",
+ "tooltip": "",
+ "type": "object",
+ "writable": null
+ }
+ ],
+ "moduleName": "hal",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.exceptions.HALError",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "hal.exceptions",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.simulation.NotifierInfo",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "hal.simulation.NotifierInfo",
+ "functionName": "__init__",
+ "returnType": "hal.simulation.NotifierInfo",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "handle",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "name",
+ "tooltip": "",
+ "type": "memoryview",
+ "writable": null
+ },
+ {
+ "name": "timeout",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "waitTimeValid",
+ "tooltip": "",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "hal.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.simulation.SimCB",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.simulation.SimCB"
+ }
+ ],
+ "declaringClassName": "hal.simulation.SimCB",
+ "functionName": "cancel",
+ "returnType": "None",
+ "tooltip": "Cancel the callback"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "hal.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "hal.simulation.SimValueCB",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "hal.simulation.SimValueCB"
+ }
+ ],
+ "declaringClassName": "hal.simulation.SimValueCB",
+ "functionName": "cancel",
+ "returnType": "None",
+ "tooltip": "Cancel the callback"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "hal.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.ADIS16448_IMU",
+ "classVariables": [],
+ "constructors": [
+ {
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "yaw_axis",
+ "type": "wpilib.ADIS16448_IMU.IMUAxis"
+ },
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "wpilib.SPI.Port"
+ },
+ {
+ "defaultValue": null,
+ "name": "cal_time",
+ "type": "wpilib.ADIS16448_IMU.CalibrationTime"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "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."
+ }
+ ],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ },
+ {
+ "defaultValue": null,
+ "name": "new_cal_time",
+ "type": "wpilib.ADIS16448_IMU.CalibrationTime"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ },
+ {
+ "defaultValue": null,
+ "name": "decimationRate",
+ "type": "int"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getAccelX",
+ "returnType": "wpimath.units.meters_per_second_squared",
+ "tooltip": "Returns the acceleration in the X axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getAccelY",
+ "returnType": "wpimath.units.meters_per_second_squared",
+ "tooltip": "Returns the acceleration in the Y axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getAccelZ",
+ "returnType": "wpimath.units.meters_per_second_squared",
+ "tooltip": "Returns the acceleration in the Z axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getAngle",
+ "returnType": "wpimath.units.degrees",
+ "tooltip": "Returns the yaw axis angle in degrees (CCW positive)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getBarometricPressure",
+ "returnType": "wpimath.units.pounds_per_square_inch",
+ "tooltip": "Returns the barometric pressure."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getGyroAngleY",
+ "returnType": "wpimath.units.degrees",
+ "tooltip": "Returns the accumulated gyro angle in the Y axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getGyroRateX",
+ "returnType": "wpimath.units.degrees_per_second",
+ "tooltip": "Returns the angular rate in the X axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getMagneticFieldX",
+ "returnType": "wpimath.units.teslas",
+ "tooltip": "Returns the magnetic field strength in the X axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getMagneticFieldY",
+ "returnType": "wpimath.units.teslas",
+ "tooltip": "Returns the magnetic field strength in the Y axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getMagneticFieldZ",
+ "returnType": "wpimath.units.teslas",
+ "tooltip": "Returns the magnetic field strength in the Z axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getPort",
+ "returnType": "int",
+ "tooltip": "Get the SPI port number.\n\n:returns: The SPI port number."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "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)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getTemperature",
+ "returnType": "wpimath.units.celsius",
+ "tooltip": "Returns the temperature."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "getYawAxis",
+ "returnType": "wpilib.ADIS16448_IMU.IMUAxis",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16448_IMU"
+ },
+ {
+ "defaultValue": null,
+ "name": "yaw_axis",
+ "type": "wpilib.ADIS16448_IMU.IMUAxis"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16448_IMU",
+ "functionName": "setYawAxis",
+ "returnType": "int",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.ADIS16470_IMU",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "yaw_axis",
+ "type": "wpilib.ADIS16470_IMU.IMUAxis"
+ },
+ {
+ "defaultValue": null,
+ "name": "pitch_axis",
+ "type": "wpilib.ADIS16470_IMU.IMUAxis"
+ },
+ {
+ "defaultValue": null,
+ "name": "roll_axis",
+ "type": "wpilib.ADIS16470_IMU.IMUAxis"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "yaw_axis",
+ "type": "wpilib.ADIS16470_IMU.IMUAxis"
+ },
+ {
+ "defaultValue": null,
+ "name": "pitch_axis",
+ "type": "wpilib.ADIS16470_IMU.IMUAxis"
+ },
+ {
+ "defaultValue": null,
+ "name": "roll_axis",
+ "type": "wpilib.ADIS16470_IMU.IMUAxis"
+ },
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "wpilib.SPI.Port"
+ },
+ {
+ "defaultValue": null,
+ "name": "cal_time",
+ "type": "wpilib.ADIS16470_IMU.CalibrationTime"
+ }
+ ],
+ "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."
+ },
+ {
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "functionName": "calibrate",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ },
+ {
+ "defaultValue": null,
+ "name": "new_cal_time",
+ "type": "wpilib.ADIS16470_IMU.CalibrationTime"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "functionName": "getAccelY",
+ "returnType": "wpimath.units.meters_per_second_squared",
+ "tooltip": "Returns the acceleration in the Y axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ },
+ {
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ },
+ {
+ "defaultValue": "",
+ "name": "axis",
+ "type": "wpilib.ADIS16470_IMU.IMUAxis"
+ }
+ ],
+ "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)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "functionName": "getXComplementaryAngle",
+ "returnType": "wpimath.units.degrees",
+ "tooltip": "Returns the X-axis complementary angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "functionName": "getXFilteredAccelAngle",
+ "returnType": "wpimath.units.degrees",
+ "tooltip": "Returns the X-axis filtered acceleration angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "functionName": "getYComplementaryAngle",
+ "returnType": "wpimath.units.degrees",
+ "tooltip": "Returns the Y-axis complementary angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "wpilib.ADIS16470_IMU.IMUAxis"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "functionName": "setGyroAngleX",
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "functionName": "setGyroAngleY",
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADIS16470_IMU"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpilib.ADIS16470_IMU",
+ "functionName": "setGyroAngleZ",
+ "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)"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.ADXL345_I2C",
+ "classVariables": [
+ {
+ "name": "kAddress",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ }
+ ],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "wpilib.I2C.Port"
+ },
+ {
+ "defaultValue": "",
+ "name": "range",
+ "type": "wpilib.ADXL345_I2C.Range"
+ },
+ {
+ "defaultValue": "29",
+ "name": "deviceAddress",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL345_I2C",
+ "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."
+ },
+ {
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_I2C"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "wpilib.ADXL345_I2C.Axes"
+ }
+ ],
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_I2C"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL345_I2C",
+ "functionName": "getI2CDeviceAddress",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_I2C"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL345_I2C",
+ "functionName": "getI2CPort",
+ "returnType": "wpilib.I2C.Port",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_I2C"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_I2C"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_I2C"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_I2C"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "ntcore.NTSendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL345_I2C",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_I2C"
+ },
+ {
+ "defaultValue": null,
+ "name": "range",
+ "type": "wpilib.ADXL345_I2C.Range"
+ }
+ ],
+ "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
+ },
+ {
+ "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.ADXL345_SPI",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "wpilib.SPI.Port"
+ },
+ {
+ "defaultValue": "",
+ "name": "range",
+ "type": "wpilib.ADXL345_SPI.Range"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL345_SPI",
+ "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."
+ },
+ {
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "wpilib.ADXL345_SPI.Axes"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_SPI"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL345_SPI",
+ "functionName": "getSpiPort",
+ "returnType": "wpilib.SPI.Port",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL345_SPI",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_SPI"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL345_SPI",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "ntcore.NTSendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL345_SPI",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL345_SPI"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.ADXL362"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "wpilib.ADXL362.Axes"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL362",
+ "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 ADXL362 in Gs."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL362"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL362"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL362",
+ "functionName": "getSpiPort",
+ "returnType": "wpilib.SPI.Port",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL362"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL362"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL362"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "ntcore.NTSendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL362",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXL362"
+ },
+ {
+ "defaultValue": null,
+ "name": "range",
+ "type": "wpilib.ADXL362.Range"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXL362",
+ "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.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",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.ADXRS450_Gyro",
+ "functionName": "__init__",
+ "returnType": "wpilib.ADXRS450_Gyro",
+ "tooltip": "%Gyro constructor on onboard CS0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "wpilib.SPI.Port"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXRS450_Gyro",
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXRS450_Gyro"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXRS450_Gyro"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXRS450_Gyro"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXRS450_Gyro",
+ "functionName": "getPort",
+ "returnType": "int",
+ "tooltip": "Get the SPI port number.\n\n:returns: The SPI port number."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXRS450_Gyro"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXRS450_Gyro"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXRS450_Gyro"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXRS450_Gyro",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXRS450_Gyro"
+ }
+ ],
+ "declaringClassName": "wpilib.ADXRS450_Gyro",
+ "functionName": "isConnected",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.ADXRS450_Gyro"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "int"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AddressableLED"
+ },
+ {
+ "defaultValue": null,
+ "name": "highTime0",
+ "type": "wpimath.units.nanoseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "lowTime0",
+ "type": "wpimath.units.nanoseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "highTime1",
+ "type": "wpimath.units.nanoseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "lowTime1",
+ "type": "wpimath.units.nanoseconds"
+ }
+ ],
+ "declaringClassName": "wpilib.AddressableLED",
+ "functionName": "setBitTiming",
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AddressableLED"
+ },
+ {
+ "defaultValue": null,
+ "name": "ledData",
+ "type": "List[wpilib.AddressableLED.LEDData]"
+ }
+ ],
+ "declaringClassName": "wpilib.AddressableLED",
+ "functionName": "setData",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AddressableLED"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.AddressableLED",
+ "functionName": "setLength",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AddressableLED"
+ },
+ {
+ "defaultValue": null,
+ "name": "syncTime",
+ "type": "wpimath.units.microseconds"
+ }
+ ],
+ "declaringClassName": "wpilib.AddressableLED",
+ "functionName": "setSyncTime",
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AddressableLED"
+ }
+ ],
+ "declaringClassName": "wpilib.AddressableLED",
+ "functionName": "start",
+ "returnType": "None",
+ "tooltip": "Starts the output.\n\nThe output writes continuously."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AddressableLED"
+ }
+ ],
+ "declaringClassName": "wpilib.AddressableLED",
+ "functionName": "stop",
+ "returnType": "None",
+ "tooltip": "Stops the output."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.AddressableLED.LEDData",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.AddressableLED.LEDData",
+ "functionName": "__init__",
+ "returnType": "wpilib.AddressableLED.LEDData",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "g",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "b",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.AddressableLED.LEDData",
+ "functionName": "__init__",
+ "returnType": "wpilib.AddressableLED.LEDData",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AddressableLED.LEDData"
+ },
+ {
+ "defaultValue": null,
+ "name": "h",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "s",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "v",
+ "type": "int"
+ }
+ ],
+ "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]"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AddressableLED.LEDData"
+ },
+ {
+ "defaultValue": null,
+ "name": "color",
+ "type": "wpilib.Color"
+ }
+ ],
+ "declaringClassName": "wpilib.AddressableLED.LEDData",
+ "functionName": "setLED",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AddressableLED.LEDData"
+ },
+ {
+ "defaultValue": null,
+ "name": "color",
+ "type": "wpilib.Color8Bit"
+ }
+ ],
+ "declaringClassName": "wpilib.AddressableLED.LEDData",
+ "functionName": "setLED",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AddressableLED.LEDData"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "g",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "b",
+ "type": "int"
+ }
+ ],
+ "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
+ },
+ {
+ "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": null,
+ "name": "text",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "group",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "text",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Alert"
+ }
+ ],
+ "declaringClassName": "wpilib.Alert",
+ "functionName": "get",
+ "returnType": "bool",
+ "tooltip": "Gets whether the alert is active.\n\n:returns: whether the alert is active."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Alert"
+ }
+ ],
+ "declaringClassName": "wpilib.Alert",
+ "functionName": "getText",
+ "returnType": "str",
+ "tooltip": "Gets the current alert text.\n\n:returns: the current text."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Alert"
+ },
+ {
+ "defaultValue": null,
+ "name": "active",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Alert"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogAccelerometer"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogAccelerometer"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogAccelerometer",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogAccelerometer"
+ },
+ {
+ "defaultValue": null,
+ "name": "sensitivity",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogAccelerometer",
+ "functionName": "setSensitivity",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogAccelerometer"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "fullRange",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "expectedZero",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "analogInput",
+ "type": "wpilib.AnalogInput"
+ },
+ {
+ "defaultValue": null,
+ "name": "fullRange",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogEncoder"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogEncoder",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": "Get the channel number.\n\n:returns: The channel number."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogEncoder"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogEncoder",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogEncoder"
+ },
+ {
+ "defaultValue": null,
+ "name": "inverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogEncoder",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": "Set if this encoder is inverted.\n\n:param inverted: true to invert the encoder, false otherwise"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogEncoder"
+ },
+ {
+ "defaultValue": null,
+ "name": "min",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "max",
+ "type": "float"
+ }
+ ],
+ "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)"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.AnalogGyro",
+ "classVariables": [
+ {
+ "name": "kAverageBits",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ },
+ {
+ "name": "kCalibrationSampleTime",
+ "tooltip": "",
+ "type": "float",
+ "writable": false
+ },
+ {
+ "name": "kDefaultVoltsPerDegreePerSecond",
+ "tooltip": "",
+ "type": "float",
+ "writable": false
+ },
+ {
+ "name": "kOversampleBits",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ },
+ {
+ "name": "kSamplesPerSecond",
+ "tooltip": "",
+ "type": "float",
+ "writable": false
+ }
+ ],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "wpilib.AnalogInput"
+ },
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogGyro"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogGyro",
+ "functionName": "initGyro",
+ "returnType": "None",
+ "tooltip": "Initialize the gyro.\n\nCalibration is handled by Calibrate()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogGyro"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogGyro",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogGyro"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogGyro"
+ },
+ {
+ "defaultValue": null,
+ "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": "kAccumulatorModuleNumber",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ },
+ {
+ "name": "kAccumulatorNumChannels",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ }
+ ],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogInput"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogInput",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": "Get the channel number.\n\n:returns: The channel number."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogInput"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogInput",
+ "functionName": "initAccumulator",
+ "returnType": "None",
+ "tooltip": "Initialize the accumulator."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogInput"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogInput",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogInput"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogInput",
+ "functionName": "resetAccumulator",
+ "returnType": "None",
+ "tooltip": "Resets the accumulator to the initial value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogInput"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogInput"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadband",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogInput",
+ "functionName": "setAccumulatorDeadband",
+ "returnType": "None",
+ "tooltip": "Set the accumulator's deadband."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogInput"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogInput"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogInput"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogInput"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogOutput"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogOutput",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": "Get the channel of this AnalogOutput."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogOutput"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogOutput",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogOutput"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogPotentiometer"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogPotentiometer",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.AnalogTrigger",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogTrigger"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogTrigger"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogTrigger",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogTrigger"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogTrigger"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogTrigger"
+ },
+ {
+ "defaultValue": null,
+ "name": "lower",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogTrigger"
+ },
+ {
+ "defaultValue": null,
+ "name": "lower",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogTrigger"
+ },
+ {
+ "defaultValue": null,
+ "name": "lower",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "trigger",
+ "type": "wpilib.AnalogTrigger"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.AnalogTriggerOutput"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogTriggerOutput",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ":returns: The channel of the source."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogTriggerOutput"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogTriggerOutput",
+ "functionName": "getPortHandleForRouting",
+ "returnType": "int",
+ "tooltip": ":returns: The HAL Handle to the specified source."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.AnalogTriggerOutput"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.AnalogTriggerOutput",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.BuiltInAccelerometer"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.BuiltInAccelerometer",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.BuiltInAccelerometer"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "deviceId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "deviceManufacturer",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.CAN"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.CAN"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.CAN"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "timeoutMs",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.CAN"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.CAN"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.CAN"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.CAN"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.CAN"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.CAN"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.CAN"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null
+ },
+ {
+ "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": null,
+ "name": "red",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "green",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "r",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "g",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null
+ },
+ {
+ "name": "green",
+ "tooltip": "Green component (0-1).",
+ "type": "float",
+ "writable": null
+ },
+ {
+ "name": "red",
+ "tooltip": "Red component (0-1).",
+ "type": "float",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "h",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "s",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "red",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "green",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null
+ },
+ {
+ "name": "green",
+ "tooltip": "Green component (0-255).",
+ "type": "int",
+ "writable": null
+ },
+ {
+ "name": "red",
+ "tooltip": "Red component (0-255).",
+ "type": "int",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Compressor"
+ }
+ ],
+ "declaringClassName": "wpilib.Compressor",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": "Disable the compressor."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Compressor"
+ },
+ {
+ "defaultValue": null,
+ "name": "minPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Compressor"
+ },
+ {
+ "defaultValue": null,
+ "name": "minPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Compressor"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.Compressor",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "encodingType",
+ "type": "wpilib.interfaces.CounterBase.EncodingType"
+ },
+ {
+ "defaultValue": null,
+ "name": "upSource",
+ "type": "wpilib.DigitalSource"
+ },
+ {
+ "defaultValue": null,
+ "name": "downSource",
+ "type": "wpilib.DigitalSource"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ }
+ ],
+ "declaringClassName": "wpilib.Counter",
+ "functionName": "clearDownSource",
+ "returnType": "None",
+ "tooltip": "Disable the down counting source to the counter."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ }
+ ],
+ "declaringClassName": "wpilib.Counter",
+ "functionName": "clearUpSource",
+ "returnType": "None",
+ "tooltip": "Disable the up counting source to the counter."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ }
+ ],
+ "declaringClassName": "wpilib.Counter",
+ "functionName": "getFPGAIndex",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.Counter",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "name": "analogTrigger",
+ "type": "wpilib.AnalogTrigger"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "name": "source",
+ "type": "wpilib.DigitalSource"
+ }
+ ],
+ "declaringClassName": "wpilib.Counter",
+ "functionName": "setDownSource",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "name": "risingEdge",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "name": "analogTrigger",
+ "type": "wpilib.AnalogTrigger"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "name": "risingEdge",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Counter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": [],
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalGlitchFilter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalGlitchFilter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalGlitchFilter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalGlitchFilter"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalGlitchFilter",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalGlitchFilter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalGlitchFilter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalGlitchFilter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalGlitchFilter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalGlitchFilter"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalInput"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalInput",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ":returns: The GPIO channel number that this object represents."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalInput"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalInput",
+ "functionName": "getPortHandleForRouting",
+ "returnType": "int",
+ "tooltip": ":returns: The HAL Handle to the specified source."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalInput"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalInput",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalInput"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalInput",
+ "functionName": "isAnalogTrigger",
+ "returnType": "bool",
+ "tooltip": "Is source an AnalogTrigger"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalInput"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalOutput",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ":returns: The GPIO channel number that this object represents."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalOutput",
+ "functionName": "getPortHandleForRouting",
+ "returnType": "int",
+ "tooltip": ":returns: The HAL Handle to the specified source."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalOutput",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalOutput",
+ "functionName": "isAnalogTrigger",
+ "returnType": "bool",
+ "tooltip": "Is source an AnalogTrigger"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalOutput"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DigitalSource"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalSource",
+ "functionName": "getAnalogTriggerTypeForRouting",
+ "returnType": "wpilib.AnalogTriggerType",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalSource"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalSource",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalSource"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalSource",
+ "functionName": "getPortHandleForRouting",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.DigitalSource"
+ }
+ ],
+ "declaringClassName": "wpilib.DigitalSource",
+ "functionName": "isAnalogTrigger",
+ "returnType": "bool",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.DoubleSolenoid",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleType",
+ "type": "wpilib.PneumaticsModuleType"
+ },
+ {
+ "defaultValue": null,
+ "name": "forwardChannel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "moduleType",
+ "type": "wpilib.PneumaticsModuleType"
+ },
+ {
+ "defaultValue": null,
+ "name": "forwardChannel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DoubleSolenoid"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.DoubleSolenoid",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DoubleSolenoid"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": [],
+ "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": null,
+ "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": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "fullRange",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "dutyCycle",
+ "type": "wpilib.DutyCycle"
+ },
+ {
+ "defaultValue": null,
+ "name": "fullRange",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "digitalSource",
+ "type": "wpilib.DigitalSource"
+ },
+ {
+ "defaultValue": null,
+ "name": "fullRange",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DutyCycleEncoder"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.DutyCycleEncoder",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DutyCycleEncoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DutyCycleEncoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DutyCycleEncoder"
+ },
+ {
+ "defaultValue": null,
+ "name": "min",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.DutyCycleEncoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "aChannel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "aSource",
+ "type": "wpilib.DigitalSource"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Encoder"
+ }
+ ],
+ "declaringClassName": "wpilib.Encoder",
+ "functionName": "getFPGAIndex",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Encoder"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.Encoder",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Encoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Encoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Encoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Encoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Encoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Encoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Encoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Encoder"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Field2d"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Field2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "ntcore.NTSendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.Field2d",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Field2d"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Field2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.FieldObject2d"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.FieldObject2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.FieldObject2d"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.FieldObject2d"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "port",
+ "type": "wpilib.I2C.Port"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.I2C"
+ },
+ {
+ "defaultValue": null,
+ "name": "registerAddress",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.I2C"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.I2C"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataToSend",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.I2C"
+ },
+ {
+ "defaultValue": null,
+ "name": "registerAddress",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.I2C"
+ },
+ {
+ "defaultValue": null,
+ "name": "registerAddress",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.I2C"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.IterativeRobotBase"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.RobotBase"
+ }
+ ],
+ "declaringClassName": "wpilib.RobotBase",
+ "functionName": "endCompetition",
+ "returnType": "None",
+ "tooltip": "Ends the main loop in StartCompetition()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.IterativeRobotBase"
+ }
+ ],
+ "declaringClassName": "wpilib.IterativeRobotBase",
+ "functionName": "isLiveWindowEnabledInTest",
+ "returnType": "bool",
+ "tooltip": "Whether LiveWindow operation is enabled during test mode."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.IterativeRobotBase"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Joystick"
+ }
+ ],
+ "declaringClassName": "wpilib.Joystick",
+ "functionName": "getDirectionDegrees",
+ "returnType": "wpimath.units.degrees",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Joystick"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Joystick"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Joystick"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Joystick"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Joystick"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Joystick"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Joystick"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "name": "reader",
+ "type": "wpilib.LEDPattern.LEDReader"
+ },
+ {
+ "defaultValue": null,
+ "name": "writer",
+ "type": "Callable[[int, wpilib.Color], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.LEDPattern",
+ "functionName": "applyTo",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "List[wpilib.AddressableLED.LEDData]"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "name": "onTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "type",
+ "type": "wpilib.LEDPattern.GradientType"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "saturation",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "impl",
+ "type": "Callable[[int], wpilib.AddressableLED.LEDData]"
+ },
+ {
+ "defaultValue": null,
+ "name": "size",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.LEDPattern.LEDReader",
+ "functionName": "__init__",
+ "returnType": "wpilib.LEDPattern.LEDReader",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.LEDPattern.LEDReader"
+ }
+ ],
+ "declaringClassName": "wpilib.LEDPattern.LEDReader",
+ "functionName": "size",
+ "returnType": "int",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.LiveWindow",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.LiveWindow",
+ "functionName": "disableAllTelemetry",
+ "returnType": "None",
+ "tooltip": "Disable ALL telemetry."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "width",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Mechanism2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Mechanism2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "ntcore.NTSendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.Mechanism2d",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Mechanism2d"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MechanismObject2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MechanismLigament2d"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MechanismLigament2d"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MechanismLigament2d"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MechanismLigament2d"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MechanismObject2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MechanismRoot2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MechanismRoot2d"
+ }
+ ],
+ "declaringClassName": "wpilib.MechanismRoot2d",
+ "functionName": "getName",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MechanismRoot2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "args",
+ "type": "tuple"
+ }
+ ],
+ "declaringClassName": "wpilib.MotorControllerGroup",
+ "functionName": "__init__",
+ "returnType": "wpilib.MotorControllerGroup",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorControllerGroup"
+ }
+ ],
+ "declaringClassName": "wpilib.MotorControllerGroup",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorControllerGroup"
+ }
+ ],
+ "declaringClassName": "wpilib.MotorControllerGroup",
+ "functionName": "get",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorControllerGroup"
+ }
+ ],
+ "declaringClassName": "wpilib.MotorControllerGroup",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorControllerGroup"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.MotorControllerGroup",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorControllerGroup"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.MotorControllerGroup",
+ "functionName": "set",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorControllerGroup"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.MotorControllerGroup",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorControllerGroup"
+ },
+ {
+ "defaultValue": null,
+ "name": "output",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpilib.MotorControllerGroup",
+ "functionName": "setVoltage",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "pwmChannel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.NidecBrushless"
+ }
+ ],
+ "declaringClassName": "wpilib.NidecBrushless",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.NidecBrushless"
+ }
+ ],
+ "declaringClassName": "wpilib.NidecBrushless",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.NidecBrushless"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.NidecBrushless",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.NidecBrushless"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.NidecBrushless"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.NidecBrushless",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.MotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Notifier"
+ },
+ {
+ "defaultValue": null,
+ "name": "handler",
+ "type": "Callable[[], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.Notifier",
+ "functionName": "setCallback",
+ "returnType": "None",
+ "tooltip": "Change the handler function.\n\n:param handler: Handler"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Notifier"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Notifier"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Notifier"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "realTime",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.PS4Controller",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS4Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.PS5Controller",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PS5Controller"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "name": "max",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadbandMax",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadbandMin",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ }
+ ],
+ "declaringClassName": "wpilib.PWM",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "name": "max",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadbandMax",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadbandMin",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "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": null,
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "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": null,
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "stopMotor",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "stopMotor",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "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.PWMVictorSPX",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "stopMotor",
+ "returnType": "None",
+ "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": [],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "__init__",
+ "returnType": "wpilib.PneumaticHub",
+ "tooltip": "Constructs a PneumaticHub with the default ID (1)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "checkAndReserveSolenoids",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "checkSolenoidChannel",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "clearStickyFaults",
+ "returnType": "None",
+ "tooltip": "Clears the sticky faults."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "minPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "enableCompressorDigital",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "minPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "fireOneShot",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "getCompressor",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "getCompressorConfigType",
+ "returnType": "wpilib.CompressorConfigType",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "getCompressorCurrent",
+ "returnType": "wpimath.units.amperes",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "getModuleNumber",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "getPressureSwitch",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "getSolenoidDisabledList",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "getSolenoids",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "makeCompressor",
+ "returnType": "wpilib.Compressor",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "forwardChannel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverseChannel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "makeDoubleSolenoid",
+ "returnType": "wpilib.DoubleSolenoid",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "makeSolenoid",
+ "returnType": "wpilib.Solenoid",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "reserveCompressor",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "duration",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "setOneShotDuration",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "values",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "setSolenoids",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "unreserveCompressor",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticHub",
+ "functionName": "unreserveSolenoids",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleType",
+ "type": "wpilib.PneumaticsModuleType"
+ }
+ ],
+ "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",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticHub.Faults"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": "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
+ }
+ ],
+ "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
+ },
+ {
+ "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
+ },
+ {
+ "name": "HasReset",
+ "tooltip": "The device has rebooted.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "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
+ },
+ {
+ "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": "UniqueId",
+ "tooltip": "The device's unique ID.",
+ "type": "int",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpilib",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.PneumaticsBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "__init__",
+ "returnType": "wpilib.PneumaticsBase",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "disableCompressor",
+ "returnType": "None",
+ "tooltip": "Disables the compressor."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "minPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "enableCompressorAnalog",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "minPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "enableCompressorHybrid",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "fireOneShot",
+ "returnType": "None",
+ "tooltip": "Fire a single solenoid shot.\n\n:param index: solenoid index"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "getCompressorConfigType",
+ "returnType": "wpilib.CompressorConfigType",
+ "tooltip": "Returns the active compressor configuration.\n\n:returns: The active compressor configuration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "getModuleNumber",
+ "returnType": "int",
+ "tooltip": "Get module number for this module.\n\n:returns: module number"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "makeCompressor",
+ "returnType": "wpilib.Compressor",
+ "tooltip": "Create a compressor object.\n\n:returns: Compressor object"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "forwardChannel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverseChannel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "reserveCompressor",
+ "returnType": "bool",
+ "tooltip": "Reserve the compressor.\n\n:returns: true if successful; false if compressor already reserved"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "duration",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "values",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "unreserveCompressor",
+ "returnType": "None",
+ "tooltip": "Unreserve the compressor."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsBase",
+ "functionName": "unreserveSolenoids",
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ }
+ ]
+ },
+ {
+ "className": "wpilib.PneumaticsControlModule",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "__init__",
+ "returnType": "wpilib.PneumaticsControlModule",
+ "tooltip": "Constructs a PneumaticsControlModule with the default ID (0)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "__init__",
+ "returnType": "wpilib.PneumaticsControlModule",
+ "tooltip": "Constructs a PneumaticsControlModule.\n\n:param module: module number to construct"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "checkAndReserveSolenoids",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "checkSolenoidChannel",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "clearAllStickyFaults",
+ "returnType": "None",
+ "tooltip": "Clears all sticky faults on this device."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "disableCompressor",
+ "returnType": "None",
+ "tooltip": "Disables the compressor. The compressor will not turn on until\nEnableCompressorDigital() is called."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "minPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "enableCompressorDigital",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "minPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPressure",
+ "type": "wpimath.units.pounds_per_square_inch"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "fireOneShot",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "getCompressor",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "getCompressorConfigType",
+ "returnType": "wpilib.CompressorConfigType",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "getCompressorCurrent",
+ "returnType": "wpimath.units.amperes",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "getModuleNumber",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "getPressureSwitch",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "getSolenoidDisabledList",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "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()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "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()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "getSolenoids",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "makeCompressor",
+ "returnType": "wpilib.Compressor",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "forwardChannel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverseChannel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "makeDoubleSolenoid",
+ "returnType": "wpilib.DoubleSolenoid",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "makeSolenoid",
+ "returnType": "wpilib.Solenoid",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "reserveCompressor",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "duration",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "setOneShotDuration",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "values",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "setSolenoids",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "unreserveCompressor",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PneumaticsControlModule"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.PneumaticsControlModule",
+ "functionName": "unreserveSolenoids",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleType",
+ "type": "wpilib.PneumaticsModuleType"
+ }
+ ],
+ "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",
+ "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)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleType",
+ "type": "wpilib.PowerDistribution.ModuleType"
+ }
+ ],
+ "declaringClassName": "wpilib.PowerDistribution",
+ "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"
+ }
+ ],
+ "enums": [
+ {
+ "enumClassName": "wpilib.PowerDistribution.ModuleType",
+ "enumValues": [
+ "kCTRE",
+ "kRev"
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "declaringClassName": "wpilib.PowerDistribution",
+ "functionName": "clearStickyFaults",
+ "returnType": "None",
+ "tooltip": "Remove all of the fault flags on the PDP/PDH."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "declaringClassName": "wpilib.PowerDistribution",
+ "functionName": "getModule",
+ "returnType": "int",
+ "tooltip": "Gets module number (CAN ID)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "declaringClassName": "wpilib.PowerDistribution",
+ "functionName": "getType",
+ "returnType": "wpilib.PowerDistribution.ModuleType",
+ "tooltip": "Gets module type."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "declaringClassName": "wpilib.PowerDistribution",
+ "functionName": "getVersion",
+ "returnType": "wpilib.PowerDistribution.Version",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.PowerDistribution",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution"
+ },
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "bool"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution.Faults"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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."
+ }
+ ],
+ "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
+ },
+ {
+ "name": "Channel9BreakerFault",
+ "tooltip": "Breaker fault on channel 9.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PowerDistribution.StickyFaults"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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
+ },
+ {
+ "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
+ },
+ {
+ "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
+ },
+ {
+ "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
+ },
+ {
+ "name": "FirmwareMajor",
+ "tooltip": "Firmware major version number.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "FirmwareMinor",
+ "tooltip": "Firmware minor version number.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "name": "HardwareMajor",
+ "tooltip": "Hardware major version number.",
+ "type": "int",
+ "writable": true
+ },
+ {
+ "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": [],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": "False",
+ "name": "defaultValue",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "defaultValue",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "defaultValue",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": "0",
+ "name": "defaultValue",
+ "type": "int"
+ }
+ ],
+ "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": [],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": "''",
+ "name": "defaultValue",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.Preferences",
+ "functionName": "initBoolean",
+ "returnType": "None",
+ "tooltip": "Puts the given boolean into the preferences table if it doesn't\nalready exist."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.Preferences",
+ "functionName": "initDouble",
+ "returnType": "None",
+ "tooltip": "Puts the given double into the preferences table if it doesn't\nalready exist."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.Preferences",
+ "functionName": "initFloat",
+ "returnType": "None",
+ "tooltip": "Puts the given float into the preferences table if it doesn't\nalready exist."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.Preferences",
+ "functionName": "initInt",
+ "returnType": "None",
+ "tooltip": "Puts the given int into the preferences table if it doesn't\nalready exist."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.Preferences",
+ "functionName": "initLong",
+ "returnType": "None",
+ "tooltip": "Puts the given long into the preferences table if it doesn't\nalready exist."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.Preferences",
+ "functionName": "initString",
+ "returnType": "None",
+ "tooltip": "Puts the given string into the preferences table if it doesn't\nalready exist."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.Preferences",
+ "functionName": "setString",
+ "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"
+ }
+ ]
+ },
+ {
+ "className": "wpilib.Relay",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": "",
+ "name": "direction",
+ "type": "wpilib.Relay.Direction"
+ }
+ ],
+ "declaringClassName": "wpilib.Relay",
+ "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."
+ }
+ ],
+ "enums": [
+ {
+ "enumClassName": "wpilib.Relay.Direction",
+ "enumValues": [
+ "kBothDirections",
+ "kForwardOnly",
+ "kReverseOnly"
+ ],
+ "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."
+ },
+ {
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Relay"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Relay"
+ }
+ ],
+ "declaringClassName": "wpilib.Relay",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Relay"
+ }
+ ],
+ "declaringClassName": "wpilib.Relay",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Relay"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.Relay",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Relay"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "wpilib.Relay.Value"
+ }
+ ],
+ "declaringClassName": "wpilib.Relay",
+ "functionName": "set",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.RobotBase"
+ }
+ ],
+ "declaringClassName": "wpilib.RobotBase",
+ "functionName": "endCompetition",
+ "returnType": "None",
+ "tooltip": "Ends the main loop in StartCompetition()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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()"
+ }
+ ],
+ "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": null,
+ "name": "robot_cls",
+ "type": "object"
+ }
+ ],
+ "declaringClassName": "wpilib.RobotBase",
+ "functionName": "main",
+ "returnType": "object",
+ "tooltip": "Starting point for the application"
+ }
+ ]
+ },
+ {
+ "className": "wpilib.RobotController",
+ "classVariables": [],
+ "constructors": [],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "brownoutVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "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": null,
+ "name": "enabled",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "enabled",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.RobotController",
+ "functionName": "setEnabled5V",
+ "returnType": "None",
+ "tooltip": "Enables or disables the 5V rail.\n\n:param enabled: whether to enable the 5V rail."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.RobotController",
+ "functionName": "setEnabled6V",
+ "returnType": "None",
+ "tooltip": "Enables or disables the 6V rail.\n\n:param enabled: whether to enable the 6V rail."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "wpilib.RadioLEDState"
+ }
+ ],
+ "declaringClassName": "wpilib.RobotController",
+ "functionName": "setRadioLEDState",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [],
+ "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.SD540",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "wpilib.SPI.Port"
+ }
+ ],
+ "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."
+ },
+ {
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "csToSclkTicks",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "stallTicks",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "pow2BytesPerRead",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "forceAutoRead",
+ "returnType": "None",
+ "tooltip": "Force the engine to make a single transfer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "freeAccumulator",
+ "returnType": "None",
+ "tooltip": "Frees the accumulator."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "freeAuto",
+ "returnType": "None",
+ "tooltip": "Frees the automatic SPI transfer engine."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "getAccumulatorAverage",
+ "returnType": "float",
+ "tooltip": "Read the average of the accumulated value.\n\n:returns: The accumulated average value (value / count)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "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()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "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()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "getAccumulatorLastValue",
+ "returnType": "int",
+ "tooltip": "Read the last value read by the accumulator engine."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "getAccumulatorValue",
+ "returnType": "int",
+ "tooltip": "Read the accumulated value.\n\n:returns: The 64-bit value accumulated since the last Reset()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "getPort",
+ "returnType": "wpilib.SPI.Port",
+ "tooltip": "Returns the SPI port.\n\n:returns: The SPI port."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "cmd",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "xferSize",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "validMask",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "validValue",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataShift",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataSize",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "isSigned",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "bigEndian",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "initAccumulator",
+ "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?"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "bufferSize",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "initiate",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataReceived",
+ "type": "Buffer"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "buffer",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "timeout",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "resetAccumulator",
+ "returnType": "None",
+ "tooltip": "Resets the accumulator to zero."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "setAccumulatorCenter",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadband",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "setAccumulatorDeadband",
+ "returnType": "None",
+ "tooltip": "Set the accumulator's deadband."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "setAccumulatorIntegratedCenter",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataToSend",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "zeroSize",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "setChipSelectActiveHigh",
+ "returnType": "None",
+ "tooltip": "Configure the chip select line to be active high."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "setChipSelectActiveLow",
+ "returnType": "None",
+ "tooltip": "Configure the chip select line to be active low."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "hz",
+ "type": "int"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "mode",
+ "type": "wpilib.SPI.Mode"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "source",
+ "type": "wpilib.DigitalSource"
+ },
+ {
+ "defaultValue": null,
+ "name": "rising",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "falling",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "startAutoTrigger",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.SPI",
+ "functionName": "stopAuto",
+ "returnType": "None",
+ "tooltip": "Stop running the automatic SPI transfer engine."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataToSend",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataReceived",
+ "type": "Buffer"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SPI"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], list[int]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[List[int]], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addBooleanArrayProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], bool]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[bool], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addBooleanProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], list[float]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[List[float]], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addDoubleArrayProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[float], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addDoubleProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], list[float]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[List[float]], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addFloatArrayProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[float], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addFloatProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], list[int]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[List[int]], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addIntegerArrayProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], int]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[int], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addIntegerProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "typeString",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], list[int]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[Buffer], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addRawProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[List[int]], List[int]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[List[int]], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addSmallBooleanArrayProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[List[float]], List[float]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[List[float]], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addSmallDoubleArrayProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[List[float]], List[float]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[List[float]], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addSmallFloatArrayProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[List[int]], List[int]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[List[int]], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addSmallIntegerArrayProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "typeString",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[List[int]], Buffer]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[Buffer], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addSmallRawProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[List[str]], List[str]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[List[str]], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addSmallStringArrayProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[List[str]], str]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[str], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addSmallStringProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], list[str]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[List[str]], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addStringArrayProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "getter",
+ "type": "Callable[[], str]"
+ },
+ {
+ "defaultValue": null,
+ "name": "setter",
+ "type": "Callable[[str], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "addStringProperty",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "clearProperties",
+ "returnType": "None",
+ "tooltip": "Clear properties."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "getTable",
+ "returnType": "ntcore.NetworkTable",
+ "tooltip": "Get the network table.\n\n:returns: The network table"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "getTopic",
+ "returnType": "ntcore.Topic",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstBoolean",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "List[int]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstBooleanArray",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstDouble",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "List[float]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstDoubleArray",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstFloat",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "List[float]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstFloatArray",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstInteger",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "List[int]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstIntegerArray",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "typeString",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "Buffer"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstRaw",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstString",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "List[str]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "publishConstStringArray",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "setActuator",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "setSafeState",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "setSmartDashboardType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "table",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ },
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "setUpdateTable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "startListeners",
+ "returnType": "None",
+ "tooltip": "Hook setters for all properties."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "stopListeners",
+ "returnType": "None",
+ "tooltip": "Unhook setters for all properties."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableBuilderImpl",
+ "functionName": "stopLiveWindowMode",
+ "returnType": "None",
+ "tooltip": "Stop LiveWindow mode by unhooking the setters for all properties. Also\ncalls the SafeState function if one was provided."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableBuilderImpl"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SendableChooser"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "object",
+ "type": "object"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SendableChooser"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.SendableChooser",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SendableChooser"
+ },
+ {
+ "defaultValue": null,
+ "name": "listener",
+ "type": "Callable[[object], None]"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SendableChooser"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "object",
+ "type": "object"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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.SensorUtil",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpilib.SensorUtil",
+ "functionName": "getNumRelayChannels",
+ "returnType": "int",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpilib.SerialPort",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "baudRate",
+ "type": "int"
+ },
+ {
+ "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\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": null,
+ "name": "baudRate",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ ],
+ "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."
+ },
+ {
+ "enumClassName": "wpilib.SerialPort.Port",
+ "enumValues": [
+ "kMXP",
+ "kOnboard",
+ "kUSB",
+ "kUSB1",
+ "kUSB2"
+ ],
+ "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."
+ },
+ {
+ "enumClassName": "wpilib.SerialPort.StopBits",
+ "enumValues": [
+ "kStopBits_One",
+ "kStopBits_OnePointFive",
+ "kStopBits_Two"
+ ],
+ "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."
+ },
+ {
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ }
+ ],
+ "declaringClassName": "wpilib.SerialPort",
+ "functionName": "disableTermination",
+ "returnType": "None",
+ "tooltip": "Disable termination behavior."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ },
+ {
+ "defaultValue": "'\\n'",
+ "name": "terminator",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "buffer",
+ "type": "Buffer"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "flowControl",
+ "type": "wpilib.SerialPort.FlowControl"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "size",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "timeout",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "mode",
+ "type": "wpilib.SerialPort.WriteBufferMode"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "size",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SerialPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "buffer",
+ "type": "Buffer"
+ }
+ ],
+ "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",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.Servo",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Servo"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Servo"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "name": "max",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadbandMax",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadbandMin",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ }
+ ],
+ "declaringClassName": "wpilib.PWM",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Servo"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Servo"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Servo"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.Servo",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Servo"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Servo"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "float"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "name": "max",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadbandMax",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadbandMin",
+ "type": "wpimath.units.microseconds"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Servo"
+ }
+ ],
+ "declaringClassName": "wpilib.Servo",
+ "functionName": "setOffline",
+ "returnType": "None",
+ "tooltip": "Set the servo to offline.\n\nSet the servo raw value to 0 (undriven)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWM"
+ }
+ ],
+ "declaringClassName": "wpilib.PWM",
+ "functionName": "setZeroLatch",
+ "returnType": "None",
+ "tooltip": "Latches PWM to zero."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.SharpIR",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "a",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "b",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "minCM",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxCM",
+ "type": "float"
+ }
+ ],
+ "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 minCM: Minimum distance to report in centimeters\n:param maxCM: Maximum distance to report in centimeters"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SharpIR"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.SharpIR"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.SharpIR",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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"
+ }
+ ]
+ },
+ {
+ "className": "wpilib.SmartDashboard",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "keyName",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "keyName",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "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"
+ }
+ ],
+ "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": null,
+ "name": "keyName",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "object"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "object"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "object"
+ }
+ ],
+ "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": null,
+ "name": "keyName",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "object"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "keyName",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "task",
+ "type": "Callable[[], None]"
+ }
+ ],
+ "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": null,
+ "name": "keyName",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "List[int]"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "wpiutil.Sendable"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "keyName",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "List[float]"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "Buffer"
+ }
+ ],
+ "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": null,
+ "name": "keyName",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "List[str]"
+ }
+ ],
+ "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": null,
+ "name": "keyName",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "ntcore.Value"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "List[int]"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "List[float]"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "Buffer"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "List[str]"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "ntcore.Value"
+ }
+ ],
+ "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": null,
+ "name": "key",
+ "type": "str"
+ }
+ ],
+ "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",
+ "returnType": "None",
+ "tooltip": "Puts all sendable data to the dashboard."
+ }
+ ]
+ },
+ {
+ "className": "wpilib.Solenoid",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleType",
+ "type": "wpilib.PneumaticsModuleType"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "moduleType",
+ "type": "wpilib.PneumaticsModuleType"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.Solenoid",
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Solenoid"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Solenoid"
+ }
+ ],
+ "declaringClassName": "wpilib.Solenoid",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": "Get the channel this solenoid is connected to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Solenoid"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.Solenoid",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Solenoid"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Solenoid"
+ },
+ {
+ "defaultValue": null,
+ "name": "on",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Solenoid"
+ },
+ {
+ "defaultValue": null,
+ "name": "duration",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Solenoid"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Solenoid"
+ }
+ ],
+ "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",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.Spark",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.Spark",
+ "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"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "stopMotor",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "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.StadiaController",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "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": null,
+ "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": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "declaringClassName": "wpilib.StadiaController",
+ "functionName": "getRightY",
+ "returnType": "float",
+ "tooltip": "Get the Y axis value of right side of the controller.\n\n:returns: the axis value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.StadiaController",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.StadiaController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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
+ },
+ {
+ "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",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.SynchronousInterrupt",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SynchronousInterrupt"
+ },
+ {
+ "defaultValue": null,
+ "name": "risingEdge",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.SynchronousInterrupt"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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"
+ }
+ ],
+ "declaringClassName": "wpilib.TimedRobot",
+ "functionName": "__init__",
+ "returnType": "wpilib.TimedRobot",
+ "tooltip": "Constructor for TimedRobot.\n\n:param period: Period."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.TimedRobot"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "offset",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.IterativeRobotBase"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.TimedRobot"
+ }
+ ],
+ "declaringClassName": "wpilib.TimedRobot",
+ "functionName": "endCompetition",
+ "returnType": "None",
+ "tooltip": "Ends the main loop in StartCompetition()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.TimedRobot"
+ }
+ ],
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.IterativeRobotBase"
+ }
+ ],
+ "declaringClassName": "wpilib.IterativeRobotBase",
+ "functionName": "isLiveWindowEnabledInTest",
+ "returnType": "bool",
+ "tooltip": "Whether LiveWindow operation is enabled during test mode."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.IterativeRobotBase"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.TimedRobot"
+ }
+ ],
+ "declaringClassName": "wpilib.TimedRobot",
+ "functionName": "startCompetition",
+ "returnType": "None",
+ "tooltip": "Provide an alternate \"main loop\" via StartCompetition()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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.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",
+ "returnType": "bool",
+ "tooltip": "Get if the robot is a simulation.\n\n:returns: If the robot is running in simulation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "robot_cls",
+ "type": "object"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Timer"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Timer"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Timer"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Timer"
+ }
+ ],
+ "declaringClassName": "wpilib.Timer",
+ "functionName": "isRunning",
+ "returnType": "bool",
+ "tooltip": "Whether the timer is currently running.\n\n:returns: true if running."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Timer"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Timer"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Timer"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Timer"
+ }
+ ],
+ "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)"
+ },
+ {
+ "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": null,
+ "name": "robotPeriodicAllocation",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "controllerPeriod",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.TimedRobot"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "offset",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.IterativeRobotBase"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.TimedRobot"
+ }
+ ],
+ "declaringClassName": "wpilib.TimedRobot",
+ "functionName": "endCompetition",
+ "returnType": "None",
+ "tooltip": "Ends the main loop in StartCompetition()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.TimedRobot"
+ }
+ ],
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.IterativeRobotBase"
+ }
+ ],
+ "declaringClassName": "wpilib.IterativeRobotBase",
+ "functionName": "isLiveWindowEnabledInTest",
+ "returnType": "bool",
+ "tooltip": "Whether LiveWindow operation is enabled during test mode."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.TimesliceRobot"
+ },
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "allocation",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.IterativeRobotBase"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.TimedRobot"
+ }
+ ],
+ "declaringClassName": "wpilib.TimedRobot",
+ "functionName": "startCompetition",
+ "returnType": "None",
+ "tooltip": "Provide an alternate \"main loop\" via StartCompetition()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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.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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Tracer"
+ },
+ {
+ "defaultValue": null,
+ "name": "epochName",
+ "type": "str"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Tracer"
+ }
+ ],
+ "declaringClassName": "wpilib.Tracer",
+ "functionName": "clearEpochs",
+ "returnType": "None",
+ "tooltip": "Clears all epochs."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Tracer"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Tracer"
+ }
+ ],
+ "declaringClassName": "wpilib.Tracer",
+ "functionName": "resetTimer",
+ "returnType": "None",
+ "tooltip": "Restarts the epoch timer."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.Ultrasonic",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pingChannel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "echoChannel",
+ "type": "int"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pingChannel",
+ "type": "wpilib.DigitalOutput"
+ },
+ {
+ "defaultValue": null,
+ "name": "echoChannel",
+ "type": "wpilib.DigitalInput"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Ultrasonic"
+ }
+ ],
+ "declaringClassName": "wpilib.Ultrasonic",
+ "functionName": "getEchoChannel",
+ "returnType": "int",
+ "tooltip": "Returns the echo channel.\n\n:returns: The echo channel."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Ultrasonic"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Ultrasonic"
+ }
+ ],
+ "declaringClassName": "wpilib.Ultrasonic",
+ "functionName": "getRangeInches",
+ "returnType": "wpimath.units.inches",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Ultrasonic"
+ }
+ ],
+ "declaringClassName": "wpilib.Ultrasonic",
+ "functionName": "getRangeMM",
+ "returnType": "wpimath.units.millimeters",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Ultrasonic"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.Ultrasonic",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Ultrasonic"
+ }
+ ],
+ "declaringClassName": "wpilib.Ultrasonic",
+ "functionName": "isEnabled",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Ultrasonic"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Ultrasonic"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Ultrasonic"
+ },
+ {
+ "defaultValue": null,
+ "name": "enable",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.Ultrasonic",
+ "functionName": "setEnabled",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ }
+ ]
+ },
+ {
+ "className": "wpilib.Victor",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.Victor",
+ "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"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "stopMotor",
+ "returnType": "None",
+ "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": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "getInverted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.PWMMotorController",
+ "functionName": "setInverted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.PWMMotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "timeout",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Watchdog"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Watchdog"
+ }
+ ],
+ "declaringClassName": "wpilib.Watchdog",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": "Disables the watchdog timer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Watchdog"
+ }
+ ],
+ "declaringClassName": "wpilib.Watchdog",
+ "functionName": "enable",
+ "returnType": "None",
+ "tooltip": "Enables the watchdog timer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Watchdog"
+ }
+ ],
+ "declaringClassName": "wpilib.Watchdog",
+ "functionName": "getTimeout",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": "Returns the watchdog's timeout."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Watchdog"
+ }
+ ],
+ "declaringClassName": "wpilib.Watchdog",
+ "functionName": "isExpired",
+ "returnType": "bool",
+ "tooltip": "Returns true if the watchdog timer has expired."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Watchdog"
+ }
+ ],
+ "declaringClassName": "wpilib.Watchdog",
+ "functionName": "printEpochs",
+ "returnType": "None",
+ "tooltip": "Prints list of epochs added so far and their times."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.Watchdog"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Watchdog"
+ },
+ {
+ "defaultValue": null,
+ "name": "timeout",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.Watchdog"
+ },
+ {
+ "defaultValue": null,
+ "name": "suppress",
+ "type": "bool"
+ }
+ ],
+ "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",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.XboxController",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.XboxController",
+ "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)."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.XboxController",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.XboxController"
+ },
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "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",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.cameraserver.CameraServer",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib.cameraserver",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.counter.ExternalDirectionCounter",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "countSource",
+ "type": "wpilib.DigitalSource"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "countSource",
+ "type": "wpilib.DigitalSource"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.ExternalDirectionCounter"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.ExternalDirectionCounter",
+ "functionName": "getCount",
+ "returnType": "int",
+ "tooltip": "Gets the current count.\n\n:returns: The current count."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.counter.ExternalDirectionCounter"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.ExternalDirectionCounter",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the current count."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.ExternalDirectionCounter"
+ },
+ {
+ "defaultValue": null,
+ "name": "configuration",
+ "type": "wpilib.counter.EdgeConfiguration"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.ExternalDirectionCounter",
+ "functionName": "setEdgeConfiguration",
+ "returnType": "None",
+ "tooltip": "Sets the edge configuration for counting.\n\n:param configuration: The counting edge configuration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.ExternalDirectionCounter"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverseDirection",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.ExternalDirectionCounter",
+ "functionName": "setReverseDirection",
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "source",
+ "type": "wpilib.DigitalSource"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.Tachometer",
+ "functionName": "__init__",
+ "returnType": "wpilib.counter.Tachometer",
+ "tooltip": "Constructs a new tachometer.\n\n:param source: The source."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "source",
+ "type": "wpilib.DigitalSource"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.Tachometer",
+ "functionName": "__init__",
+ "returnType": "wpilib.counter.Tachometer",
+ "tooltip": "Constructs a new tachometer.\n\n:param source: The source."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.Tachometer",
+ "functionName": "getEdgesPerRevolution",
+ "returnType": "int",
+ "tooltip": "Gets the number of edges per revolution.\n\n:returns: Edges per revolution."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.Tachometer",
+ "functionName": "getFrequency",
+ "returnType": "wpimath.units.hertz",
+ "tooltip": "Gets the tachometer frequency.\n\n:returns: Current frequency."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.Tachometer",
+ "functionName": "getPeriod",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": "Gets the tachometer period.\n\n:returns: Current period."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.Tachometer",
+ "functionName": "getSamplesToAverage",
+ "returnType": "int",
+ "tooltip": "Gets the number of sample to average.\n\n:returns: Samples to average."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ },
+ {
+ "defaultValue": null,
+ "name": "edges",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPeriod",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ },
+ {
+ "defaultValue": null,
+ "name": "samples",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.Tachometer",
+ "functionName": "setSamplesToAverage",
+ "returnType": "None",
+ "tooltip": "Sets the number of samples to average.\n\n:param samples: Samples to average."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.Tachometer"
+ },
+ {
+ "defaultValue": null,
+ "name": "updateWhenEmpty",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.Tachometer",
+ "functionName": "setUpdateWhenEmpty",
+ "returnType": "None",
+ "tooltip": "Sets if to update when empty.\n\n:param updateWhenEmpty: True to update when empty."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.counter",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.counter.UpDownCounter",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "upSource",
+ "type": "wpilib.DigitalSource"
+ },
+ {
+ "defaultValue": null,
+ "name": "downSource",
+ "type": "wpilib.DigitalSource"
+ }
+ ],
+ "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)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "upSource",
+ "type": "wpilib.DigitalSource"
+ },
+ {
+ "defaultValue": null,
+ "name": "downSource",
+ "type": "wpilib.DigitalSource"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.UpDownCounter"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.UpDownCounter",
+ "functionName": "getCount",
+ "returnType": "int",
+ "tooltip": "Gets the current count.\n\n:returns: The current count."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpiutil.Sendable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.counter.UpDownCounter"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.UpDownCounter",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the current count."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.UpDownCounter"
+ },
+ {
+ "defaultValue": null,
+ "name": "configuration",
+ "type": "wpilib.counter.EdgeConfiguration"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.UpDownCounter",
+ "functionName": "setDownEdgeConfiguration",
+ "returnType": "None",
+ "tooltip": "Sets the configuration for the down source.\n\n:param configuration: The down source configuration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.UpDownCounter"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverseDirection",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.counter.UpDownCounter",
+ "functionName": "setReverseDirection",
+ "returnType": "None",
+ "tooltip": "Sets to revert the counter direction.\n\n:param reverseDirection: True to reverse counting direction."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.counter.UpDownCounter"
+ },
+ {
+ "defaultValue": null,
+ "name": "configuration",
+ "type": "wpilib.counter.EdgeConfiguration"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "leftMotor",
+ "type": "wpilib.interfaces.MotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightMotor",
+ "type": "wpilib.interfaces.MotorController"
+ }
+ ],
+ "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": null,
+ "name": "leftMotor",
+ "type": "Callable[[float], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightMotor",
+ "type": "Callable[[float], None]"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.DifferentialDrive"
+ },
+ {
+ "defaultValue": null,
+ "name": "xSpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "zRotation",
+ "type": "float"
+ },
+ {
+ "defaultValue": "True",
+ "name": "squareInputs",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.DifferentialDrive"
+ },
+ {
+ "defaultValue": null,
+ "name": "xSpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "zRotation",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "allowTurnInPlace",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "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": null,
+ "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()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.drive.DifferentialDrive"
+ }
+ ],
+ "declaringClassName": "wpilib.drive.DifferentialDrive",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.DifferentialDrive"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.drive.DifferentialDrive",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.RobotDriveBase"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.RobotDriveBase"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.DifferentialDrive"
+ }
+ ],
+ "declaringClassName": "wpilib.drive.DifferentialDrive",
+ "functionName": "stopMotor",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.drive.DifferentialDrive"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftSpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightSpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": "True",
+ "name": "squareInputs",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "xSpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "zRotation",
+ "type": "float"
+ },
+ {
+ "defaultValue": "True",
+ "name": "squareInputs",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "xSpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "zRotation",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "allowTurnInPlace",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "leftSpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightSpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": "True",
+ "name": "squareInputs",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "frontLeftMotor",
+ "type": "wpilib.interfaces.MotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "rearLeftMotor",
+ "type": "wpilib.interfaces.MotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "frontRightMotor",
+ "type": "wpilib.interfaces.MotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "rearRightMotor",
+ "type": "wpilib.interfaces.MotorController"
+ }
+ ],
+ "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": null,
+ "name": "frontLeftMotor",
+ "type": "Callable[[float], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "rearLeftMotor",
+ "type": "Callable[[float], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "frontRightMotor",
+ "type": "Callable[[float], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "rearRightMotor",
+ "type": "Callable[[float], None]"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.MecanumDrive"
+ },
+ {
+ "defaultValue": null,
+ "name": "xSpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "ySpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "zRotation",
+ "type": "float"
+ },
+ {
+ "defaultValue": "Rotation2d(0.000000)",
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.drive.MecanumDrive"
+ },
+ {
+ "defaultValue": null,
+ "name": "magnitude",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "zRotation",
+ "type": "float"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.drive.MecanumDrive"
+ }
+ ],
+ "declaringClassName": "wpilib.drive.MecanumDrive",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.MecanumDrive"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpilib.drive.MecanumDrive",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.RobotDriveBase"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.RobotDriveBase"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.MecanumDrive"
+ }
+ ],
+ "declaringClassName": "wpilib.drive.MecanumDrive",
+ "functionName": "stopMotor",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "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": null,
+ "name": "xSpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "ySpeed",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "zRotation",
+ "type": "float"
+ },
+ {
+ "defaultValue": "Rotation2d(0.000000)",
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "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.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": [
+ {
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.drive.RobotDriveBase"
+ }
+ ],
+ "declaringClassName": "wpilib.drive.RobotDriveBase",
+ "functionName": "getDescription",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.RobotDriveBase"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.RobotDriveBase"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.MotorSafety"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.drive.RobotDriveBase"
+ }
+ ],
+ "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.event.BooleanEvent",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ },
+ {
+ "defaultValue": null,
+ "name": "signal",
+ "type": "Callable[[], bool]"
+ }
+ ],
+ "declaringClassName": "wpilib.event.BooleanEvent",
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.event.BooleanEvent"
+ },
+ {
+ "defaultValue": null,
+ "name": "ctor",
+ "type": "Callable"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.event.BooleanEvent"
+ },
+ {
+ "defaultValue": null,
+ "name": "debounceTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": "",
+ "name": "type",
+ "type": "wpimath.filter.Debouncer.DebounceType"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.event.BooleanEvent"
+ }
+ ],
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.event.BooleanEvent"
+ },
+ {
+ "defaultValue": null,
+ "name": "action",
+ "type": "Callable[[], None]"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.event.BooleanEvent"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.event.EventLoop"
+ },
+ {
+ "defaultValue": null,
+ "name": "action",
+ "type": "Callable[[], None]"
+ }
+ ],
+ "declaringClassName": "wpilib.event.EventLoop",
+ "functionName": "bind",
+ "returnType": "None",
+ "tooltip": "Bind a new action to run when the loop is polled.\n\n:param action: the action to run."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "declaringClassName": "wpilib.event.EventLoop",
+ "functionName": "clear",
+ "returnType": "None",
+ "tooltip": "Clear all bindings."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.event.EventLoop"
+ }
+ ],
+ "declaringClassName": "wpilib.event.EventLoop",
+ "functionName": "poll",
+ "returnType": "None",
+ "tooltip": "Poll all bindings."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.event",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.event.NetworkBooleanEvent",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ },
+ {
+ "defaultValue": null,
+ "name": "topic",
+ "type": "ntcore.BooleanTopic"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ },
+ {
+ "defaultValue": null,
+ "name": "table",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "topicName",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ },
+ {
+ "defaultValue": null,
+ "name": "tableName",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "topicName",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "loop",
+ "type": "wpilib.event.EventLoop"
+ },
+ {
+ "defaultValue": null,
+ "name": "inst",
+ "type": "ntcore.NetworkTableInstance"
+ },
+ {
+ "defaultValue": null,
+ "name": "tableName",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "topicName",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.event.BooleanEvent"
+ },
+ {
+ "defaultValue": null,
+ "name": "ctor",
+ "type": "Callable"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.event.BooleanEvent"
+ },
+ {
+ "defaultValue": null,
+ "name": "debounceTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": "",
+ "name": "type",
+ "type": "wpimath.filter.Debouncer.DebounceType"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.event.BooleanEvent"
+ }
+ ],
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.event.BooleanEvent"
+ },
+ {
+ "defaultValue": null,
+ "name": "action",
+ "type": "Callable[[], None]"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.event.BooleanEvent"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.interfaces.CounterBase"
+ }
+ ],
+ "declaringClassName": "wpilib.interfaces.CounterBase",
+ "functionName": "get",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.interfaces.CounterBase"
+ }
+ ],
+ "declaringClassName": "wpilib.interfaces.CounterBase",
+ "functionName": "getDirection",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.interfaces.CounterBase"
+ }
+ ],
+ "declaringClassName": "wpilib.interfaces.CounterBase",
+ "functionName": "getPeriod",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.interfaces.CounterBase"
+ }
+ ],
+ "declaringClassName": "wpilib.interfaces.CounterBase",
+ "functionName": "getStopped",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.interfaces.CounterBase"
+ }
+ ],
+ "declaringClassName": "wpilib.interfaces.CounterBase",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.interfaces.CounterBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPeriod",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.interfaces.CounterBase",
+ "functionName": "setMaxPeriod",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.interfaces",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.interfaces.GenericHID",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.GenericHID"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.MotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.interfaces.MotorController",
+ "functionName": "disable",
+ "returnType": "None",
+ "tooltip": "Common interface for disabling a motor."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.interfaces.MotorController"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.MotorController"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.interfaces.MotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.MotorController"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInverted",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.MotorController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.interfaces.MotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.interfaces.MotorController",
+ "functionName": "stopMotor",
+ "returnType": "None",
+ "tooltip": "Common interface to stop the motor until Set is called again."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.interfaces",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard.ComplexWidget",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "parent",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "sendable",
+ "type": "wpiutil.Sendable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ComplexWidget",
+ "functionName": "__init__",
+ "returnType": "wpilib.shuffleboard.ComplexWidget",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ComplexWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ComplexWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ComplexWidget"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ComplexWidget",
+ "functionName": "disableIfActuator",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ComplexWidget"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ComplexWidget",
+ "functionName": "enableIfActuator",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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.LayoutType",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "layoutName",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.LayoutType",
+ "functionName": "__init__",
+ "returnType": "wpilib.shuffleboard.LayoutType",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "description",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "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)"
+ },
+ {
+ "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."
+ },
+ {
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "format",
+ "type": "str"
+ }
+ ],
+ "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."
+ },
+ {
+ "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."
+ },
+ {
+ "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."
+ }
+ ]
+ },
+ {
+ "className": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard.ShuffleboardContainer",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], list[float]]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], list[float]]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], int]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], float]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "ntcore.Value"
+ }
+ ],
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "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::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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "List[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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "List[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\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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "typeString",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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 typeString: the NT type string\n:param supplier: the supplier for values\n\n:returns: a widget to display data"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], str]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer",
+ "functionName": "disableIfActuator",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer",
+ "functionName": "enableIfActuator",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.shuffleboard.LayoutType"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "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&)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "parent",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardLayout",
+ "functionName": "__init__",
+ "returnType": "wpilib.shuffleboard.ShuffleboardLayout",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], list[float]]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], list[float]]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], int]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], float]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "ntcore.Value"
+ }
+ ],
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "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::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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "List[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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "List[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\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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "typeString",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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 typeString: the NT type string\n:param supplier: the supplier for values\n\n:returns: a widget to display data"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], str]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardLayout"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardLayout",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer",
+ "functionName": "disableIfActuator",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer",
+ "functionName": "enableIfActuator",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.shuffleboard.LayoutType"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "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&)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._LayoutComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._LayoutComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._LayoutComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "root",
+ "type": "wpilib.shuffleboard._ShuffleboardRoot"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardTab",
+ "functionName": "__init__",
+ "returnType": "wpilib.shuffleboard.ShuffleboardTab",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], list[float]]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], list[float]]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], int]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], float]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "ntcore.Value"
+ }
+ ],
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "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, 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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "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::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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "List[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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "defaultValue",
+ "type": "List[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\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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "typeString",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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 typeString: the NT type string\n:param supplier: the supplier for values\n\n:returns: a widget to display data"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "supplier",
+ "type": "Callable[[], str]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardTab"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardTab",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer",
+ "functionName": "disableIfActuator",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardContainer",
+ "functionName": "enableIfActuator",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.shuffleboard.LayoutType"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "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&)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardTab"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardTab",
+ "functionName": "getRoot",
+ "returnType": "wpilib.shuffleboard._ShuffleboardRoot",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard.ShuffleboardValue",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard.SimpleWidget",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "parent",
+ "type": "wpilib.shuffleboard.ShuffleboardContainer"
+ },
+ {
+ "defaultValue": null,
+ "name": "title",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SimpleWidget",
+ "functionName": "__init__",
+ "returnType": "wpilib.shuffleboard.SimpleWidget",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SimpleWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SimpleWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SimpleWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "typeString",
+ "type": "str"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard.SuppliedBoolListValueWidget",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedBoolListValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedBoolListValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard.SuppliedBoolValueWidget",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedBoolValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedBoolValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedDoubleListValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedDoubleListValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, 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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedDoubleValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedDoubleValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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.SuppliedFloatListValueWidget",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedFloatListValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedFloatListValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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.SuppliedFloatValueWidget",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedFloatValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedFloatValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_float"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedIntListValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedIntListValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "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.SuppliedIntegerValueWidget",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedIntegerValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedIntegerValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_integer"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_integer"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_integer"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_integer"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_integer"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_integer"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedRawValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedRawValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedStringListValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedStringListValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.SuppliedStringValueWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.SuppliedStringValueWidget",
+ "functionName": "buildInto",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "widgetName",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.WidgetType",
+ "functionName": "__init__",
+ "returnType": "wpilib.shuffleboard.WidgetType",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._ComplexWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._LayoutComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._LayoutComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._LayoutComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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._SimpleComponent",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleComponent"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SimpleWidget"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard._SuppliedValueComponent_bool",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_float"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard._SuppliedValueComponent_integer",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_integer"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_integer"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_integer"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard._SuppliedValueComponent_string",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, 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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard._SuppliedValueComponent_vector_float",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard._SuppliedValueComponent_vector_string",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard._SuppliedValueWidget_bool",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "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._SuppliedValueWidget_double",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_float"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_integer"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_integer"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_integer"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_integer"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_integer"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_integer"
+ },
+ {
+ "defaultValue": null,
+ "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._SuppliedValueWidget_string",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.shuffleboard",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.shuffleboard._SuppliedValueWidget_vector_double",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, 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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_double"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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._SuppliedValueWidget_vector_float",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_float"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_int"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.WidgetType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_raw"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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._SuppliedValueWidget_vector_string",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "parentTable",
+ "type": "ntcore.NetworkTable"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "metaTable",
+ "type": "ntcore.NetworkTable"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "buildMetadata",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getParent",
+ "returnType": "wpilib.shuffleboard.ShuffleboardContainer",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardValue"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardValue",
+ "functionName": "getTitle",
+ "returnType": "str",
+ "tooltip": "Gets the title of this Shuffleboard value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "getType",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard.ShuffleboardComponentBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "columnIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rowIndex",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "properties",
+ "type": "dict[str, ntcore.Value]"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueComponent_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "width",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "height",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "wpilib.shuffleboard.BuiltInWidgets"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.shuffleboard._SuppliedValueWidget_vector_string"
+ },
+ {
+ "defaultValue": null,
+ "name": "widgetType",
+ "type": "str"
+ }
+ ],
+ "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.simulation.ADIS16448_IMUSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "imu",
+ "type": "wpilib.ADIS16448_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.ADIS16448_IMUSim",
+ "tooltip": "Constructs from a ADIS16448_IMU object.\n\n:param imu: ADIS16448_IMU to simulate"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16448_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim",
+ "functionName": "setAccelX",
+ "returnType": "None",
+ "tooltip": "Sets the X axis acceleration.\n\n:param accel: The acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16448_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim",
+ "functionName": "setAccelY",
+ "returnType": "None",
+ "tooltip": "Sets the Y axis acceleration.\n\n:param accel: The acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16448_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim",
+ "functionName": "setAccelZ",
+ "returnType": "None",
+ "tooltip": "Sets the Z axis acceleration.\n\n:param accel: The acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16448_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim",
+ "functionName": "setGyroAngleX",
+ "returnType": "None",
+ "tooltip": "Sets the X axis angle (CCW positive).\n\n:param angle: The angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16448_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim",
+ "functionName": "setGyroAngleY",
+ "returnType": "None",
+ "tooltip": "Sets the Y axis angle (CCW positive).\n\n:param angle: The angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16448_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim",
+ "functionName": "setGyroAngleZ",
+ "returnType": "None",
+ "tooltip": "Sets the Z axis angle (CCW positive).\n\n:param angle: The angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16448_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularRate",
+ "type": "wpimath.units.degrees_per_second"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim",
+ "functionName": "setGyroRateX",
+ "returnType": "None",
+ "tooltip": "Sets the X axis angular rate (CCW positive).\n\n:param angularRate: The angular rate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16448_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularRate",
+ "type": "wpimath.units.degrees_per_second"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim",
+ "functionName": "setGyroRateY",
+ "returnType": "None",
+ "tooltip": "Sets the Y axis angular rate (CCW positive).\n\n:param angularRate: The angular rate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16448_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularRate",
+ "type": "wpimath.units.degrees_per_second"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16448_IMUSim",
+ "functionName": "setGyroRateZ",
+ "returnType": "None",
+ "tooltip": "Sets the Z axis angular rate (CCW positive).\n\n:param angularRate: The angular rate."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.ADIS16470_IMUSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "imu",
+ "type": "wpilib.ADIS16470_IMU"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.ADIS16470_IMUSim",
+ "tooltip": "Constructs from a ADIS16470_IMU object.\n\n:param imu: ADIS16470_IMU to simulate"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16470_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim",
+ "functionName": "setAccelX",
+ "returnType": "None",
+ "tooltip": "Sets the X axis acceleration.\n\n:param accel: The acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16470_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim",
+ "functionName": "setAccelY",
+ "returnType": "None",
+ "tooltip": "Sets the Y axis acceleration.\n\n:param accel: The acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16470_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim",
+ "functionName": "setAccelZ",
+ "returnType": "None",
+ "tooltip": "Sets the Z axis acceleration.\n\n:param accel: The acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16470_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim",
+ "functionName": "setGyroAngleX",
+ "returnType": "None",
+ "tooltip": "Sets the X axis angle (CCW positive).\n\n:param angle: The angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16470_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim",
+ "functionName": "setGyroAngleY",
+ "returnType": "None",
+ "tooltip": "Sets the Y axis angle (CCW positive).\n\n:param angle: The angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16470_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim",
+ "functionName": "setGyroAngleZ",
+ "returnType": "None",
+ "tooltip": "Sets the Z axis angle (CCW positive).\n\n:param angle: The angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16470_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularRate",
+ "type": "wpimath.units.degrees_per_second"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16470_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularRate",
+ "type": "wpimath.units.degrees_per_second"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADIS16470_IMUSim",
+ "functionName": "setGyroRateY",
+ "returnType": "None",
+ "tooltip": "Sets the Y axis angular rate (CCW positive).\n\n:param angularRate: The angular rate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADIS16470_IMUSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularRate",
+ "type": "wpimath.units.degrees_per_second"
+ }
+ ],
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.ADXL345Sim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "accel",
+ "type": "wpilib.ADXL345_SPI"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADXL345Sim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.ADXL345Sim",
+ "tooltip": "Constructs from a ADXL345_SPI object.\n\n:param accel: ADXL345 accel to simulate"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADXL345Sim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADXL345Sim",
+ "functionName": "setX",
+ "returnType": "None",
+ "tooltip": "Sets the X acceleration.\n\n:param accel: The X acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADXL345Sim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADXL345Sim",
+ "functionName": "setY",
+ "returnType": "None",
+ "tooltip": "Sets the Y acceleration.\n\n:param accel: The Y acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADXL345Sim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "accel",
+ "type": "wpilib.ADXL362"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADXL362Sim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADXL362Sim",
+ "functionName": "setX",
+ "returnType": "None",
+ "tooltip": "Sets the X acceleration.\n\n:param accel: The X acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADXL362Sim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADXL362Sim",
+ "functionName": "setY",
+ "returnType": "None",
+ "tooltip": "Sets the Y acceleration.\n\n:param accel: The Y acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADXL362Sim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accel",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADXL362Sim",
+ "functionName": "setZ",
+ "returnType": "None",
+ "tooltip": "Sets the Z acceleration.\n\n:param accel: The Z acceleration."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.ADXRS450_GyroSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "gyro",
+ "type": "wpilib.ADXRS450_Gyro"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ADXRS450_GyroSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.ADXRS450_GyroSim",
+ "tooltip": "Constructs from a ADXRS450_Gyro object.\n\n:param gyro: ADXRS450_Gyro to simulate"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADXRS450_GyroSim"
+ },
+ {
+ "defaultValue": null,
+ "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)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ADXRS450_GyroSim"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.AddressableLEDSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.AddressableLEDSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.AddressableLEDSim",
+ "tooltip": "Constructs for the first addressable LED."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "hal.AddressableLEDData"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AddressableLEDSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": "Check if initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AddressableLEDSim",
+ "functionName": "getOutputPort",
+ "returnType": "int",
+ "tooltip": "Get the output port.\n\n:returns: the output port"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AddressableLEDSim",
+ "functionName": "getRunning",
+ "returnType": "int",
+ "tooltip": "Check if the LEDs are running.\n\n:returns: true if they are"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, int, int], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "hal.AddressableLEDData"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AddressableLEDSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": "Change the Initialized value of the LED strip.\n\n:param initialized: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputPort",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AddressableLEDSim",
+ "functionName": "setOutputPort",
+ "returnType": "None",
+ "tooltip": "Change the output port.\n\n:param outputPort: the new output port"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AddressableLEDSim"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "pwmChannel",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogEncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogEncoderSim",
+ "functionName": "get",
+ "returnType": "float",
+ "tooltip": "Get the simulated position."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogEncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "gyro",
+ "type": "wpilib.AnalogGyro"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogGyroSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.AnalogGyroSim",
+ "tooltip": "Constructs from an AnalogGyro object.\n\n:param gyro: AnalogGyro to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogGyroSim"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogGyroSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogGyroSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": "Check if the gyro is initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogGyroSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogGyroSim",
+ "functionName": "getRate",
+ "returnType": "float",
+ "tooltip": "Get the rate of angle change on this gyro.\n\n:returns: the rate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogGyroSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogGyroSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogGyroSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogGyroSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogGyroSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data for this object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogGyroSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogGyroSim",
+ "functionName": "setAngle",
+ "returnType": "None",
+ "tooltip": "Change the angle measured by the gyro.\n\n:param angle: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogGyroSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogGyroSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": "Set whether this gyro is initialized.\n\n:param initialized: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogGyroSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "rate",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogGyroSim",
+ "functionName": "setRate",
+ "returnType": "None",
+ "tooltip": "Change the rate of the gyro.\n\n:param rate: the new rate"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.AnalogInputSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogInput",
+ "type": "wpilib.AnalogInput"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.AnalogInputSim",
+ "tooltip": "Constructs from an AnalogInput object.\n\n:param analogInput: AnalogInput to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.AnalogInputSim",
+ "tooltip": "Constructs from an analog input channel number.\n\n:param channel: Channel number"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "getAccumulatorCount",
+ "returnType": "int",
+ "tooltip": "Get the accumulator count.\n\n:returns: the accumulator count."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "getAccumulatorDeadband",
+ "returnType": "int",
+ "tooltip": "Get the accumulator deadband.\n\n:returns: the accumulator deadband"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "getAccumulatorInitialized",
+ "returnType": "bool",
+ "tooltip": "Check if the accumulator has been initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "getAccumulatorValue",
+ "returnType": "int",
+ "tooltip": "Get the accumulator value.\n\n:returns: the accumulator value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "getVoltage",
+ "returnType": "float",
+ "tooltip": "Get the voltage.\n\n:returns: the voltage"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "registerOversampleBitsCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "registerVoltageCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data for this object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accumulatorCenter",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "setAccumulatorCenter",
+ "returnType": "None",
+ "tooltip": "Change the accumulator center.\n\n:param accumulatorCenter: the new center"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accumulatorCount",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "setAccumulatorCount",
+ "returnType": "None",
+ "tooltip": "Change the accumulator count.\n\n:param accumulatorCount: the new count."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accumulatorDeadband",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "setAccumulatorDeadband",
+ "returnType": "None",
+ "tooltip": "Change the accumulator deadband.\n\n:param accumulatorDeadband: the new deadband"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accumulatorInitialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "setAccumulatorInitialized",
+ "returnType": "None",
+ "tooltip": "Change whether the accumulator has been initialized.\n\n:param accumulatorInitialized: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "accumulatorValue",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "setAccumulatorValue",
+ "returnType": "None",
+ "tooltip": "Change the accumulator value.\n\n:param accumulatorValue: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "averageBits",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "setAverageBits",
+ "returnType": "None",
+ "tooltip": "Change the number of average bits.\n\n:param averageBits: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": "Change whether this analog input has been initialized.\n\n:param initialized: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "oversampleBits",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogInputSim",
+ "functionName": "setOversampleBits",
+ "returnType": "None",
+ "tooltip": "Change the amount of oversampling bits.\n\n:param oversampleBits: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogInputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "float"
+ }
+ ],
+ "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.AnalogOutputSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogOutput",
+ "type": "wpilib.AnalogOutput"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogOutputSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.AnalogOutputSim",
+ "tooltip": "Constructs from an AnalogOutput object.\n\n:param analogOutput: AnalogOutput to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogOutputSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.AnalogOutputSim",
+ "tooltip": "Constructs from an analog output channel number.\n\n:param channel: Channel number"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogOutputSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogOutputSim",
+ "functionName": "getVoltage",
+ "returnType": "float",
+ "tooltip": "Read the analog output voltage.\n\n:returns: the voltage on this analog output"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogOutputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogOutputSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogOutputSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogOutputSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data on this object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogOutputSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogOutputSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogTriggerSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogTriggerSim",
+ "functionName": "getTriggerUpperBound",
+ "returnType": "float",
+ "tooltip": "Get the upper bound.\n\n:returns: the upper bound"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogTriggerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogTriggerSim",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogTriggerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogTriggerSim",
+ "functionName": "registerTriggerLowerBoundCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogTriggerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogTriggerSim",
+ "functionName": "registerTriggerUpperBoundCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogTriggerSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogTriggerSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data for this object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogTriggerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogTriggerSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": "Change whether this analog trigger has been initialized.\n\n:param initialized: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogTriggerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "triggerLowerBound",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogTriggerSim",
+ "functionName": "setTriggerLowerBound",
+ "returnType": "None",
+ "tooltip": "Change the lower bound.\n\n:param triggerLowerBound: the new lower bound"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.AnalogTriggerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "triggerUpperBound",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.AnalogTriggerSim",
+ "functionName": "setTriggerUpperBound",
+ "returnType": "None",
+ "tooltip": "Change the upper bound.\n\n:param triggerUpperBound: the new upper bound"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "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"
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.BatterySim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.BatterySim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.BatterySim",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "nominalVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "resistance",
+ "type": "wpimath.units.ohms"
+ },
+ {
+ "defaultValue": null,
+ "name": "currents",
+ "type": "List[wpimath.units.amperes]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.BatterySim",
+ "functionName": "calculate",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Calculate the loaded battery voltage. Use this with\nRoboRioSim::SetVInVoltage(double) to set the simulated battery voltage,\nwhich can then be retrieved with the RobotController::GetBatteryVoltage()\nmethod.\n\n:param nominalVoltage: The nominal battery voltage. Usually 12v.\n:param resistance: The forward resistance of the battery. Most batteries\n are at or below 20 milliohms.\n:param currents: The currents drawn from the battery.\n\n:returns: The battery's voltage under load."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "currents",
+ "type": "List[wpimath.units.amperes]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.BatterySim",
+ "functionName": "calculate",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Calculate the loaded battery voltage. Use this with\nRoboRioSimSetVInVoltage(double) to set the simulated battery voltage, which\ncan then be retrieved with the RobotController::GetBatteryVoltage() method.\nThis function assumes a nominal voltage of 12V and a resistance of 20\nmilliohms (0.020 ohms).\n\n:param currents: The currents drawn from the battery.\n\n:returns: The battery's voltage under load."
+ }
+ ]
+ },
+ {
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.BuiltInAccelerometerSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data of this object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.BuiltInAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.CTREPCMSim",
+ "tooltip": "Constructs with the default PCM module number (CAN ID)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.CTREPCMSim",
+ "tooltip": "Constructs from a PCM module number (CAN ID).\n\n:param module: module number"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pneumatics",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.CTREPCMSim",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "getAllSolenoidOutputs",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "getClosedLoopEnabled",
+ "returnType": "bool",
+ "tooltip": "Check whether the closed loop compressor control is active.\n\n:returns: true if active"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "getCompressorCurrent",
+ "returnType": "float",
+ "tooltip": "Read the compressor current.\n\n:returns: the current of the compressor connected to this module"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "getCompressorOn",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "getPressureSwitch",
+ "returnType": "bool",
+ "tooltip": "Check the value of the pressure switch.\n\n:returns: the pressure switch value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "getSolenoidOutput",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "registerClosedLoopEnabledCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "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 CallbackStore object associated with this callback"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "registerCompressorOnCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "registerInitializedCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "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\n initial value\n\n:returns: the CallbackStore object associated with this callback"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "registerSolenoidOutputCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputs",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "setAllSolenoidOutputs",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "closedLoopEnabled",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "setClosedLoopEnabled",
+ "returnType": "None",
+ "tooltip": "Turn on/off the closed loop control of the compressor.\n\n:param closedLoopEnabled: whether the control loop is active"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "compressorCurrent",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "setCompressorCurrent",
+ "returnType": "None",
+ "tooltip": "Set the compressor current.\n\n:param compressorCurrent: the new compressor current"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "compressorOn",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "setCompressorOn",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pressureSwitch",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "setPressureSwitch",
+ "returnType": "None",
+ "tooltip": "Set the value of the pressure switch.\n\n:param pressureSwitch: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CTREPCMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "solenoidOutput",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "setSolenoidOutput",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.PneumaticsModuleType"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CTREPCMSim",
+ "functionName": "getForType",
+ "returnType": "wpilib.simulation.PneumaticsBaseSim",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.CallbackStore",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.CallbackStore"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.CallbackStore",
+ "functionName": "setUid",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.DCMotorSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearbox",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": "[0.0, 0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], FixedSize(2)]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DCMotorSim",
+ "tooltip": "Creates a simulated DC motor mechanism.\n\n:param plant: The linear system representing the DC motor. This\n system can be created with LinearSystemId::DCMotorSystem(). If\n LinearSystemId::DCMotorSystem(kV, kA) is used, the distance unit must be\n radians.\n:param gearbox: The type of and number of motors in the DC motor\n gearbox.\n:param measurementStdDevs: The standard deviation of the measurement noise."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "getAngularAcceleration",
+ "returnType": "wpimath.units.radians_per_second_squared",
+ "tooltip": "Returns the DC motor acceleration.\n\n:returns: The DC motor acceleration"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "getAngularPosition",
+ "returnType": "wpimath.units.radians",
+ "tooltip": "Returns the DC motor position.\n\n:returns: The DC motor position."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "getAngularVelocity",
+ "returnType": "wpimath.units.radians_per_second",
+ "tooltip": "Returns the DC motor velocity.\n\n:returns: The DC motor velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "getCurrentDraw",
+ "returnType": "wpimath.units.amperes",
+ "tooltip": "Returns the DC motor current draw.\n\n:returns: The DC motor current draw."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "getGearbox",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns the gearbox."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "getGearing",
+ "returnType": "float",
+ "tooltip": "Returns the gearing;"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "getInputVoltage",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Gets the input voltage for the DC motor.\n\n:returns: The DC motor input voltage."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "getJ",
+ "returnType": "wpimath.units.kilogram_square_meters",
+ "tooltip": "Returns the moment of inertia"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "getTorque",
+ "returnType": "wpimath.units.newton_meters",
+ "tooltip": "Returns the DC motor torque.\n\n:returns: The DC motor torque"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularPosition",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "setAngle",
+ "returnType": "None",
+ "tooltip": "Sets the DC motor's angular position.\n\n:param angularPosition: The new position in radians."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularVelocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "setAngularVelocity",
+ "returnType": "None",
+ "tooltip": "Sets the DC motor's angular velocity.\n\n:param angularVelocity: The new velocity in radians per second."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2",
+ "functionName": "setInput",
+ "returnType": "None",
+ "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "setInputVoltage",
+ "returnType": "None",
+ "tooltip": "Sets the input voltage for the DC motor.\n\n:param voltage: The input voltage."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DCMotorSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularPosition",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularVelocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DCMotorSim",
+ "functionName": "setState",
+ "returnType": "None",
+ "tooltip": "Sets the state of the DC motor.\n\n:param angularPosition: The new position\n:param angularVelocity: The new velocity"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2",
+ "functionName": "update",
+ "returnType": "None",
+ "tooltip": "Updates the simulation.\n\n:param dt: The time between updates."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.DIOSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "input",
+ "type": "wpilib.DigitalInput"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DIOSim",
+ "tooltip": "Constructs from a DigitalInput object.\n\n:param input: DigitalInput to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "output",
+ "type": "wpilib.DigitalOutput"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DIOSim",
+ "tooltip": "Constructs from a DigitalOutput object.\n\n:param output: DigitalOutput to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DIOSim",
+ "tooltip": "Constructs from an digital I/O channel number.\n\n:param channel: Channel number"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "getFilterIndex",
+ "returnType": "int",
+ "tooltip": "Read the filter index.\n\n:returns: the filter index of this DIO port"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": "Check whether this DIO has been initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "getIsInput",
+ "returnType": "bool",
+ "tooltip": "Check whether this DIO port is currently an Input.\n\n:returns: true if Input"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "getPulseLength",
+ "returnType": "float",
+ "tooltip": "Read the pulse length.\n\n:returns: the pulse length of this DIO port"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "getValue",
+ "returnType": "bool",
+ "tooltip": "Read the value of the DIO port.\n\n:returns: the DIO value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "registerFilterIndexCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run whenever the filter index 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "registerInitializedCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run when this DIO 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "registerIsInputCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run whenever this DIO changes to be an input.\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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "registerPulseLengthCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run whenever the pulse length 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "registerValueCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run whenever the DIO value 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data of this object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "filterIndex",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "setFilterIndex",
+ "returnType": "None",
+ "tooltip": "Change the filter index of this DIO port.\n\n:param filterIndex: the new filter index"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": "Define whether this DIO has been initialized.\n\n:param initialized: whether this object is initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInput",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "setIsInput",
+ "returnType": "None",
+ "tooltip": "Define whether this DIO port is an Input.\n\n:param isInput: whether this DIO should be an Input"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pulseLength",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "setPulseLength",
+ "returnType": "None",
+ "tooltip": "Change the pulse length of this DIO port.\n\n:param pulseLength: the new pulse length"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DIOSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DIOSim",
+ "functionName": "setValue",
+ "returnType": "None",
+ "tooltip": "Change the DIO value.\n\n:param value: the new value"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.DifferentialDrivetrainSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "trackWidth",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "driveMotor",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearingRatio",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelRadius",
+ "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)]"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "driveMotor",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "J",
+ "type": "wpimath.units.kilogram_square_meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "mass",
+ "type": "wpimath.units.kilograms"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelRadius",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "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)]"
+ }
+ ],
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "clampInput",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[7, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "dynamics",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getCurrentDraw",
+ "returnType": "wpimath.units.amperes",
+ "tooltip": "Returns the currently drawn current."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getGearing",
+ "returnType": "float",
+ "tooltip": "Returns the current gearing reduction of the drivetrain, as output over\ninput."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getHeading",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Returns the direction the robot is pointing.\n\nNote that this angle is counterclockwise-positive, while most gyros are\nclockwise positive."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getLeftCurrentDraw",
+ "returnType": "wpimath.units.amperes",
+ "tooltip": "Returns the currently drawn current for the left side."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getLeftPosition",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Get the left encoder position in meters.\n\n:returns: The encoder position."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getLeftPositionFeet",
+ "returnType": "wpimath.units.feet",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getLeftPositionInches",
+ "returnType": "wpimath.units.inches",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getLeftVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": "Get the left encoder velocity in meters per second.\n\n:returns: The encoder velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getLeftVelocityFps",
+ "returnType": "wpimath.units.feet_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the current pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getRightCurrentDraw",
+ "returnType": "wpimath.units.amperes",
+ "tooltip": "Returns the currently drawn current for the right side."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getRightPosition",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Get the right encoder position in meters.\n\n:returns: The encoder position."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getRightPositionFeet",
+ "returnType": "wpimath.units.feet",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getRightPositionInches",
+ "returnType": "wpimath.units.inches",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getRightVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": "Get the right encoder velocity in meters per second.\n\n:returns: The encoder velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "getRightVelocityFps",
+ "returnType": "wpimath.units.feet_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "newGearing",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "setGearing",
+ "returnType": "None",
+ "tooltip": "Sets the gearing reduction on the drivetrain. This is commonly used for\nshifting drivetrains.\n\n:param newGearing: The new gear ratio, as output over input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "setInputs",
+ "returnType": "None",
+ "tooltip": "Sets the applied voltage to the drivetrain. Note that positive voltage must\nmake that side of the drivetrain travel forward (+X).\n\n:param leftVoltage: The left voltage.\n:param rightVoltage: The right voltage."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "setPose",
+ "returnType": "None",
+ "tooltip": "Sets the system pose.\n\n:param pose: The pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "numpy.ndarray[numpy.float64[7, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "setState",
+ "returnType": "None",
+ "tooltip": "Sets the system state.\n\n:param state: The state."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DifferentialDrivetrainSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "update",
+ "returnType": "None",
+ "tooltip": "Updates the simulation.\n\n:param dt: The time that's passed since the last Update(units::second_t)\n call."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "motor",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelSize",
+ "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)]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "createKitbotSim",
+ "returnType": "wpilib.simulation.DifferentialDrivetrainSim",
+ "tooltip": "Create a sim for the standard FRC kitbot.\n\n:param motor: The motors installed in the bot.\n:param gearing: The gearing reduction used.\n:param wheelSize: The wheel size.\n:param measurementStdDevs: Standard deviations for measurements, in the form\n [x, y, heading, left velocity, right velocity, left distance, right\n distance]\u1d40. Can be omitted if no noise is desired. Gyro standard\n deviations of 0.0001 radians, velocity standard deviations of 0.05 m/s, and\n position measurement standard deviations of 0.005 meters are a reasonable\n starting point."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "motor",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelSize",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "J",
+ "type": "wpimath.units.kilogram_square_meters"
+ },
+ {
+ "defaultValue": "[0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], FixedSize(7)]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim",
+ "functionName": "createKitbotSim",
+ "returnType": "wpilib.simulation.DifferentialDrivetrainSim",
+ "tooltip": "Create a sim for the standard FRC kitbot.\n\n:param motor: The motors installed in the bot.\n:param gearing: The gearing reduction used.\n:param wheelSize: The wheel size.\n:param J: The moment of inertia of the drivebase. This can be\n calculated using SysId.\n:param measurementStdDevs: Standard deviations for measurements, in the form\n [x, y, heading, left velocity, right velocity, left distance, right\n distance]\u1d40. Can be omitted if no noise is desired. Gyro standard\n deviations of 0.0001 radians, velocity standard deviations of 0.05 m/s, and\n position measurement standard deviations of 0.005 meters are a reasonable\n starting point."
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.DifferentialDrivetrainSim.KitbotGearing",
+ "classVariables": [
+ {
+ "name": "k10p71",
+ "tooltip": "",
+ "type": "float",
+ "writable": true
+ },
+ {
+ "name": "k12p75",
+ "tooltip": "",
+ "type": "float",
+ "writable": true
+ },
+ {
+ "name": "k5p95",
+ "tooltip": "",
+ "type": "float",
+ "writable": true
+ },
+ {
+ "name": "k7p31",
+ "tooltip": "",
+ "type": "float",
+ "writable": true
+ },
+ {
+ "name": "k8p45",
+ "tooltip": "",
+ "type": "float",
+ "writable": true
+ }
+ ],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim.KitbotGearing",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DifferentialDrivetrainSim.KitbotGearing",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.DifferentialDrivetrainSim.KitbotMotor",
+ "classVariables": [
+ {
+ "name": "DualCIMPerSide",
+ "tooltip": "",
+ "type": "wpimath.system.plant.DCMotor",
+ "writable": true
+ },
+ {
+ "name": "DualFalcon500PerSide",
+ "tooltip": "",
+ "type": "wpimath.system.plant.DCMotor",
+ "writable": true
+ },
+ {
+ "name": "DualMiniCIMPerSide",
+ "tooltip": "",
+ "type": "wpimath.system.plant.DCMotor",
+ "writable": true
+ },
+ {
+ "name": "DualNEOPerSide",
+ "tooltip": "",
+ "type": "wpimath.system.plant.DCMotor",
+ "writable": true
+ },
+ {
+ "name": "SingleCIMPerSide",
+ "tooltip": "",
+ "type": "wpimath.system.plant.DCMotor",
+ "writable": true
+ },
+ {
+ "name": "SingleFalcon500PerSide",
+ "tooltip": "",
+ "type": "wpimath.system.plant.DCMotor",
+ "writable": true
+ },
+ {
+ "name": "SingleMiniCIMPerSide",
+ "tooltip": "",
+ "type": "wpimath.system.plant.DCMotor",
+ "writable": true
+ },
+ {
+ "name": "SingleNEOPerSide",
+ "tooltip": "",
+ "type": "wpimath.system.plant.DCMotor",
+ "writable": true
+ }
+ ],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim.KitbotMotor",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DifferentialDrivetrainSim.KitbotMotor",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.DifferentialDrivetrainSim.KitbotWheelSize",
+ "classVariables": [
+ {
+ "name": "kEightInch",
+ "tooltip": "",
+ "type": "float",
+ "writable": false
+ },
+ {
+ "name": "kSixInch",
+ "tooltip": "",
+ "type": "float",
+ "writable": false
+ },
+ {
+ "name": "kTenInch",
+ "tooltip": "",
+ "type": "float",
+ "writable": false
+ }
+ ],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim.KitbotWheelSize",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DifferentialDrivetrainSim.KitbotWheelSize",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.DifferentialDrivetrainSim.State",
+ "classVariables": [
+ {
+ "name": "kHeading",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ },
+ {
+ "name": "kLeftPosition",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ },
+ {
+ "name": "kLeftVelocity",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ },
+ {
+ "name": "kRightPosition",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ },
+ {
+ "name": "kRightVelocity",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ },
+ {
+ "name": "kX",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ },
+ {
+ "name": "kY",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ }
+ ],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DifferentialDrivetrainSim.State",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DifferentialDrivetrainSim.State",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.DigitalPWMSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "digitalOutput",
+ "type": "wpilib.DigitalOutput"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DigitalPWMSim",
+ "tooltip": "Constructs from a DigitalOutput object.\n\n:param digitalOutput: DigitalOutput to simulate"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DigitalPWMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "getDutyCycle",
+ "returnType": "float",
+ "tooltip": "Read the duty cycle value.\n\n:returns: the duty cycle value of this PWM output"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DigitalPWMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": "Check whether this PWM output has been initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DigitalPWMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "getPin",
+ "returnType": "int",
+ "tooltip": "Check the pin number.\n\n:returns: the pin number"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DigitalPWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "registerDutyCycleCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run whenever the duty cycle 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DigitalPWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "registerInitializedCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run when this PWM 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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DigitalPWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "registerPinCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run whenever the pin 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DigitalPWMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DigitalPWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "dutyCycle",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "setDutyCycle",
+ "returnType": "None",
+ "tooltip": "Set the duty cycle value of this PWM output.\n\n:param dutyCycle: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DigitalPWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": "Define whether this PWM output has been initialized.\n\n:param initialized: whether this object is initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DigitalPWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pin",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "setPin",
+ "returnType": "None",
+ "tooltip": "Change the pin number.\n\n:param pin: the new pin number"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "createForChannel",
+ "returnType": "wpilib.simulation.DigitalPWMSim",
+ "tooltip": "Creates an DigitalPWMSim for a digital I/O channel.\n\n:param channel: DIO channel\n\n:returns: Simulated object\n @throws std::out_of_range if no Digital PWM is configured for that channel"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DigitalPWMSim",
+ "functionName": "createForIndex",
+ "returnType": "wpilib.simulation.DigitalPWMSim",
+ "tooltip": "Creates an DigitalPWMSim for a simulated index.\nThe index is incremented for each simulated DigitalPWM.\n\n:param index: simulator index\n\n:returns: Simulated object"
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.DoubleSolenoidSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleSim",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "fwd",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rev",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DoubleSolenoidSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DoubleSolenoidSim",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.PneumaticsModuleType"
+ },
+ {
+ "defaultValue": null,
+ "name": "fwd",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rev",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DoubleSolenoidSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DoubleSolenoidSim",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.PneumaticsModuleType"
+ },
+ {
+ "defaultValue": null,
+ "name": "fwd",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rev",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DoubleSolenoidSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DoubleSolenoidSim",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DoubleSolenoidSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DoubleSolenoidSim",
+ "functionName": "get",
+ "returnType": "wpilib.DoubleSolenoid.Value",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DoubleSolenoidSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DoubleSolenoidSim",
+ "functionName": "getModuleSim",
+ "returnType": "wpilib.simulation.PneumaticsBaseSim",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DoubleSolenoidSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "output",
+ "type": "wpilib.DoubleSolenoid.Value"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DoubleSolenoidSim",
+ "functionName": "set",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.DriverStationSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DriverStationSim",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "getAllianceStationId",
+ "returnType": "hal.AllianceStationID",
+ "tooltip": "Get the alliance station ID (color + number).\n\n:returns: the alliance station color and number"
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "getAutonomous",
+ "returnType": "bool",
+ "tooltip": "Check if the DS is in autonomous.\n\n:returns: true if autonomous"
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "getDsAttached",
+ "returnType": "bool",
+ "tooltip": "Check if the DS is attached.\n\n:returns: true if attached"
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "getEStop",
+ "returnType": "bool",
+ "tooltip": "Check if eStop has been activated.\n\n:returns: true if eStopped"
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "getEnabled",
+ "returnType": "bool",
+ "tooltip": "Check if the DS is enabled.\n\n:returns: true if enabled"
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "getFmsAttached",
+ "returnType": "bool",
+ "tooltip": "Check if the FMS is connected.\n\n:returns: true if FMS is connected"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "getJoystickOutputs",
+ "returnType": "int",
+ "tooltip": "Gets the joystick outputs.\n\n:param stick: The joystick number\n\n:returns: The joystick outputs"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rumbleNum",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "getJoystickRumble",
+ "returnType": "int",
+ "tooltip": "Gets the joystick rumble.\n\n:param stick: The joystick number\n:param rumbleNum: Rumble to get (0=left, 1=right)\n\n:returns: The joystick rumble value"
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "getMatchTime",
+ "returnType": "float",
+ "tooltip": "Get the current value of the match timer.\n\n:returns: the current match time"
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "getTest",
+ "returnType": "bool",
+ "tooltip": "Check if the DS is in test.\n\n:returns: true if test"
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "notifyNewData",
+ "returnType": "None",
+ "tooltip": "Updates DriverStation data so that new values are visible to the user\nprogram."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "registerAllianceStationIdCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on the alliance station ID.\n\n:param callback: the callback that will be called whenever the alliance\n station 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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "registerAutonomousCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on whether the DS is in autonomous mode.\n\n:param callback: the callback that will be called on autonomous mode\n entrance/exit\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": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "registerDsAttachedCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on whether the DS is connected.\n\n:param callback: the callback that will be called whenever the DS\n connection 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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "registerEStopCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on the eStop state.\n\n:param callback: the callback that will be called whenever the eStop state\n 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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "registerEnabledCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on whether the DS is enabled.\n\n:param callback: the callback that will be called whenever the enabled\n state 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": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "registerFmsAttachedCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on whether the FMS is connected.\n\n:param callback: the callback that will be called whenever the FMS\n connection 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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "registerMatchTimeCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on match time.\n\n:param callback: the callback that will be called whenever match time\n 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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "registerTestCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on whether the DS is in test mode.\n\n:param callback: the callback that will be called whenever the test mode\n is entered or left\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": [],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data for the Driver Station."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "allianceStationId",
+ "type": "hal.AllianceStationID"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setAllianceStationId",
+ "returnType": "None",
+ "tooltip": "Change the alliance station.\n\n:param allianceStationId: the new alliance station"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "autonomous",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setAutonomous",
+ "returnType": "None",
+ "tooltip": "Change whether the DS is in autonomous.\n\n:param autonomous: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dsAttached",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setDsAttached",
+ "returnType": "None",
+ "tooltip": "Change whether the DS is attached.\n\n:param dsAttached: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "eStop",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setEStop",
+ "returnType": "None",
+ "tooltip": "Set whether eStop is active.\n\n:param eStop: true to activate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setEnabled",
+ "returnType": "None",
+ "tooltip": "Change whether the DS is enabled.\n\n:param enabled: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setEventName",
+ "returnType": "None",
+ "tooltip": "Sets the event name.\n\n:param name: the event name"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "fmsAttached",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setFmsAttached",
+ "returnType": "None",
+ "tooltip": "Change whether the FMS is connected.\n\n:param fmsAttached: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "message",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setGameSpecificMessage",
+ "returnType": "None",
+ "tooltip": "Sets the game specific message.\n\n:param message: the game specific message"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setJoystickAxis",
+ "returnType": "None",
+ "tooltip": "Gets the value of the axis on a joystick.\n\n:param stick: The joystick number\n:param axis: The analog axis number\n:param value: The value of the axis on the joystick"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setJoystickAxisCount",
+ "returnType": "None",
+ "tooltip": "Sets the number of axes for a joystick.\n\n:param stick: The joystick number\n:param count: The number of axes on the indicated joystick"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setJoystickAxisType",
+ "returnType": "None",
+ "tooltip": "Sets the types of Axes for a joystick.\n\n:param stick: The joystick number\n:param axis: The target axis\n:param type: The type of axis"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setJoystickButton",
+ "returnType": "None",
+ "tooltip": "Sets the state of one joystick button. %Button indexes begin at 1.\n\n:param stick: The joystick number\n:param button: The button index, beginning at 1\n:param state: The state of the joystick button"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setJoystickButtonCount",
+ "returnType": "None",
+ "tooltip": "Sets the number of buttons for a joystick.\n\n:param stick: The joystick number\n:param count: The number of buttons on the indicated joystick"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "buttons",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setJoystickButtons",
+ "returnType": "None",
+ "tooltip": "Sets the state of all the buttons on a joystick.\n\n:param stick: The joystick number\n:param buttons: The bitmap state of the buttons on the joystick"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "isXbox",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setJoystickIsXbox",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setJoystickName",
+ "returnType": "None",
+ "tooltip": "Sets the name of a joystick.\n\n:param stick: The joystick number\n:param name: The value of name"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setJoystickPOVCount",
+ "returnType": "None",
+ "tooltip": "Sets the number of POVs for a joystick.\n\n:param stick: The joystick number\n:param count: The number of POVs on the indicated joystick"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setJoystickType",
+ "returnType": "None",
+ "tooltip": "Sets the value of type for a joystick.\n\n:param stick: The joystick number\n:param type: The value of type"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "matchNumber",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setMatchNumber",
+ "returnType": "None",
+ "tooltip": "Sets the match number.\n\n:param matchNumber: the match number"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "matchTime",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setMatchTime",
+ "returnType": "None",
+ "tooltip": "Sets the match timer.\n\n:param matchTime: the new match time"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.DriverStation.MatchType"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setMatchType",
+ "returnType": "None",
+ "tooltip": "Sets the match type.\n\n:param type: the match type"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "replayNumber",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setReplayNumber",
+ "returnType": "None",
+ "tooltip": "Sets the replay number.\n\n:param replayNumber: the replay number"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "shouldSend",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setSendConsoleLine",
+ "returnType": "None",
+ "tooltip": "Sets suppression of DriverStation::SendConsoleLine messages.\n\n:param shouldSend: If false then messages will be suppressed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "shouldSend",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setSendError",
+ "returnType": "None",
+ "tooltip": "Sets suppression of DriverStation::ReportError and ReportWarning messages.\n\n:param shouldSend: If false then messages will be suppressed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "test",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DriverStationSim",
+ "functionName": "setTest",
+ "returnType": "None",
+ "tooltip": "Change whether the DS is in test.\n\n:param test: the new value"
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.DutyCycleEncoderSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoder",
+ "type": "wpilib.DutyCycleEncoder"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleEncoderSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DutyCycleEncoderSim",
+ "tooltip": "Constructs from a DutyCycleEncoder object.\n\n:param encoder: DutyCycleEncoder to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleEncoderSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DutyCycleEncoderSim",
+ "tooltip": "Constructs from a digital input channel.\n\n:param channel: digital input channel"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleEncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleEncoderSim",
+ "functionName": "get",
+ "returnType": "float",
+ "tooltip": "Get the position.\n\n:returns: The position."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleEncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleEncoderSim",
+ "functionName": "isConnected",
+ "returnType": "bool",
+ "tooltip": "Get if the encoder is connected.\n\n:returns: true if the encoder is connected."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleEncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleEncoderSim",
+ "functionName": "set",
+ "returnType": "None",
+ "tooltip": "Set the position.\n\n:param value: The position."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleEncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "isConnected",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleEncoderSim",
+ "functionName": "setConnected",
+ "returnType": "None",
+ "tooltip": "Set if the encoder is connected.\n\n:param isConnected: Whether or not the sensor is connected."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.DutyCycleSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dutyCycle",
+ "type": "wpilib.DutyCycle"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.DutyCycleSim",
+ "tooltip": "Constructs from a DutyCycle object.\n\n:param dutyCycle: DutyCycle to simulate"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "getFrequency",
+ "returnType": "int",
+ "tooltip": "Measure the frequency.\n\n:returns: the duty cycle frequency"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": "Check whether this duty cycle input has been initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "getOutput",
+ "returnType": "float",
+ "tooltip": "Measure the output from this duty cycle port.\n\n:returns: the output value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "registerFrequencyCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run whenever the frequency 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "registerInitializedCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run when this duty cycle input 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "registerOutputCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run whenever the output 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data for the duty cycle output."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "frequency",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "setFrequency",
+ "returnType": "None",
+ "tooltip": "Change the duty cycle frequency.\n\n:param frequency: the new frequency"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": "Define whether this duty cycle input has been initialized.\n\n:param initialized: whether this object is initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.DutyCycleSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "output",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.DutyCycleSim",
+ "functionName": "setOutput",
+ "returnType": "None",
+ "tooltip": "Change the duty cycle output.\n\n:param output: the new output value"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "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"
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.ElevatorSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearbox",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "minHeight",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxHeight",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "simulateGravity",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "startingHeight",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": "[0.0, 0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], FixedSize(2)]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.ElevatorSim",
+ "tooltip": "Constructs a simulated elevator mechanism.\n\n:param plant: The linear system that represents the elevator.\n This system can be created with\n LinearSystemId::ElevatorSystem().\n:param gearbox: The type of and number of motors in your\n elevator gearbox.\n:param minHeight: The minimum allowed height of the elevator.\n:param maxHeight: The maximum allowed height of the elevator.\n:param simulateGravity: Whether gravity should be simulated or not.\n:param startingHeight: The starting height of the elevator.\n:param measurementStdDevs: The standard deviation of the measurements."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "gearbox",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "carriageMass",
+ "type": "wpimath.units.kilograms"
+ },
+ {
+ "defaultValue": null,
+ "name": "drumRadius",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "minHeight",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxHeight",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "simulateGravity",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "startingHeight",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": "[0.0, 0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], FixedSize(2)]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.ElevatorSim",
+ "tooltip": "Constructs a simulated elevator mechanism.\n\n:param gearbox: The type of and number of motors in your\n elevator gearbox.\n:param gearing: The gearing of the elevator (numbers greater\n than 1 represent reductions).\n:param carriageMass: The mass of the elevator carriage.\n:param drumRadius: The radius of the drum that your cable is\n wrapped around.\n:param minHeight: The minimum allowed height of the elevator.\n:param maxHeight: The maximum allowed height of the elevator.\n:param simulateGravity: Whether gravity should be simulated or not.\n:param startingHeight: The starting height of the elevator.\n:param measurementStdDevs: The standard deviation of the measurements."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "getCurrentDraw",
+ "returnType": "wpimath.units.amperes",
+ "tooltip": "Returns the elevator current draw.\n\n:returns: The elevator current draw."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "getPosition",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the position of the elevator.\n\n:returns: The position of the elevator."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "getPositionFeet",
+ "returnType": "wpimath.units.feet",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "getPositionInches",
+ "returnType": "wpimath.units.inches",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "getVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": "Returns the velocity of the elevator.\n\n:returns: The velocity of the elevator."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "getVelocityFps",
+ "returnType": "wpimath.units.feet_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "hasHitLowerLimit",
+ "returnType": "bool",
+ "tooltip": "Returns whether the elevator has hit the lower limit.\n\n:returns: Whether the elevator has hit the lower limit."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "hasHitUpperLimit",
+ "returnType": "bool",
+ "tooltip": "Returns whether the elevator has hit the upper limit.\n\n:returns: Whether the elevator has hit the upper limit."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2",
+ "functionName": "setInput",
+ "returnType": "None",
+ "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "setInputVoltage",
+ "returnType": "None",
+ "tooltip": "Sets the input voltage for the elevator.\n\n:param voltage: The input voltage."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "position",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "setState",
+ "returnType": "None",
+ "tooltip": "Sets the elevator's state. The new position will be limited between the\nminimum and maximum allowed heights.\n\n:param position: The new position\n:param velocity: The new velocity"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2",
+ "functionName": "update",
+ "returnType": "None",
+ "tooltip": "Updates the simulation.\n\n:param dt: The time between updates."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "elevatorHeight",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "wouldHitLowerLimit",
+ "returnType": "bool",
+ "tooltip": "Returns whether the elevator would hit the lower limit.\n\n:param elevatorHeight: The elevator height.\n\n:returns: Whether the elevator would hit the lower limit."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.ElevatorSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "elevatorHeight",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.ElevatorSim",
+ "functionName": "wouldHitUpperLimit",
+ "returnType": "bool",
+ "tooltip": "Returns whether the elevator would hit the upper limit.\n\n:param elevatorHeight: The elevator height.\n\n:returns: Whether the elevator would hit the upper limit."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.EncoderSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoder",
+ "type": "wpilib.Encoder"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.EncoderSim",
+ "tooltip": "Constructs from an Encoder object.\n\n:param encoder: Encoder to simulate"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getCount",
+ "returnType": "int",
+ "tooltip": "Read the count of the encoder.\n\n:returns: the count"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getDirection",
+ "returnType": "bool",
+ "tooltip": "Get the direction of the encoder.\n\n:returns: the direction of the encoder"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getDistance",
+ "returnType": "float",
+ "tooltip": "Read the distance of the encoder.\n\n:returns: the encoder distance"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getDistancePerPulse",
+ "returnType": "float",
+ "tooltip": "Read the distance per pulse of the encoder.\n\n:returns: the encoder distance per pulse"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": "Read the Initialized value of the encoder.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getMaxPeriod",
+ "returnType": "float",
+ "tooltip": "Get the max period of the encoder.\n\n:returns: the max period of the encoder"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getPeriod",
+ "returnType": "float",
+ "tooltip": "Read the period of the encoder.\n\n:returns: the encoder period"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getRate",
+ "returnType": "float",
+ "tooltip": "Get the rate of the encoder.\n\n:returns: the rate of change"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getReset",
+ "returnType": "bool",
+ "tooltip": "Check if the encoder has been reset.\n\n:returns: true if reset"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getReverseDirection",
+ "returnType": "bool",
+ "tooltip": "Get the reverse direction of the encoder.\n\n:returns: the reverse direction of the encoder"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "getSamplesToAverage",
+ "returnType": "int",
+ "tooltip": "Get the samples-to-average value.\n\n:returns: the samples-to-average value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "registerCountCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on the count property of the encoder.\n\n:param callback: the callback that will be called whenever the count\n property 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "registerDirectionCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on the direction of the encoder.\n\n:param callback: the callback that will be called whenever the direction\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": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "registerDistancePerPulseCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on the distance per pulse value of this encoder.\n\n:param callback: the callback that will be called whenever the\n distance per pulse 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "registerInitializedCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on the Initialized property of the encoder.\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 associated with this callback"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "registerMaxPeriodCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run whenever the max period of the encoder is\nchanged.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback on the initial value\n\n:returns: the CallbackStore object associated with this callback"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "registerPeriodCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on the period of the encoder.\n\n:param callback: the callback that will be called whenever the period 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "registerResetCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be called whenever the encoder is reset.\n\n:param callback: the callback\n:param initialNotify: whether to run the callback on the initial value\n\n:returns: the CallbackStore object associated with this callback"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "registerReverseDirectionCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on the reverse direction.\n\n:param callback: the callback that will be called whenever the reverse\n direction 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "registerSamplesToAverageCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback on the samples-to-average value of this encoder.\n\n:param callback: the callback that will be called whenever the\n samples-to-average 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Resets all simulation data for this encoder."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setCount",
+ "returnType": "None",
+ "tooltip": "Change the count of the encoder.\n\n:param count: the new count"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "direction",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setDirection",
+ "returnType": "None",
+ "tooltip": "Set the direction of the encoder.\n\n:param direction: the new direction"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "distance",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setDistance",
+ "returnType": "None",
+ "tooltip": "Change the encoder distance.\n\n:param distance: the new distance"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "distancePerPulse",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setDistancePerPulse",
+ "returnType": "None",
+ "tooltip": "Change the encoder distance per pulse.\n\n:param distancePerPulse: the new distance per pulse"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": "Change the Initialized value of the encoder.\n\n:param initialized: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPeriod",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setMaxPeriod",
+ "returnType": "None",
+ "tooltip": "Change the max period of the encoder.\n\n:param maxPeriod: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setPeriod",
+ "returnType": "None",
+ "tooltip": "Change the encoder period.\n\n:param period: the new period"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "rate",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setRate",
+ "returnType": "None",
+ "tooltip": "Change the rate of the encoder.\n\n:param rate: the new rate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "reset",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setReset",
+ "returnType": "None",
+ "tooltip": "Change the reset property of the encoder.\n\n:param reset: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverseDirection",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setReverseDirection",
+ "returnType": "None",
+ "tooltip": "Set the reverse direction.\n\n:param reverseDirection: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.EncoderSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "samplesToAverage",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "setSamplesToAverage",
+ "returnType": "None",
+ "tooltip": "Set the samples-to-average value.\n\n:param samplesToAverage: the new value"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "createForChannel",
+ "returnType": "wpilib.simulation.EncoderSim",
+ "tooltip": "Creates an EncoderSim for a digital input channel. Encoders take two\nchannels, so either one may be specified.\n\n:param channel: digital input channel\n\n:returns: Simulated object\n @throws NoSuchElementException if no Encoder is configured for that channel"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.EncoderSim",
+ "functionName": "createForIndex",
+ "returnType": "wpilib.simulation.EncoderSim",
+ "tooltip": "Creates an EncoderSim for a simulated index.\nThe index is incremented for each simulated Encoder.\n\n:param index: simulator index\n\n:returns: Simulated object"
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.FlywheelSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearbox",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": "[0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], FixedSize(1)]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.FlywheelSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.FlywheelSim",
+ "tooltip": "Creates a simulated flywheel mechanism.\n\n:param plant: The linear system representing the flywheel. This\n system can be created with\n LinearSystemId::FlywheelSystem() or\n LinearSystemId::IdentifyVelocitySystem().\n:param gearbox: The type of and number of motors in the flywheel\n gearbox.\n:param measurementStdDevs: The standard deviation of the measurement noise."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.FlywheelSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.FlywheelSim",
+ "functionName": "J",
+ "returnType": "wpimath.units.kilogram_square_meters",
+ "tooltip": "Returns the moment of inertia"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.FlywheelSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.FlywheelSim",
+ "functionName": "gearbox",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns the gearbox."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.FlywheelSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.FlywheelSim",
+ "functionName": "gearing",
+ "returnType": "float",
+ "tooltip": "Returns the gearing;"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.FlywheelSim"
+ }
+ ],
+ "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": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.FlywheelSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.FlywheelSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "int"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "notifyNewData",
+ "returnType": "None",
+ "tooltip": "Updates joystick data so that new values are visible to the user program."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.HIDType"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": "Set the type of this device.\n\n:param type: the new device type"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.JoystickSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystick",
+ "type": "wpilib.Joystick"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.JoystickSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.JoystickSim",
+ "tooltip": "Constructs from a Joystick object.\n\n:param joystick: joystick to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.JoystickSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.JoystickSim",
+ "tooltip": "Constructs from a joystick port number.\n\n:param port: port number"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "notifyNewData",
+ "returnType": "None",
+ "tooltip": "Updates joystick data so that new values are visible to the user program."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.JoystickSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.JoystickSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.JoystickSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.JoystickSim"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.HIDType"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": "Set the type of this device.\n\n:param type: the new device type"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.JoystickSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.JoystickSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.JoystickSim"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.LinearSystemSim_1_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "system",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": "[0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], FixedSize(1)]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_1",
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "system",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ },
+ {
+ "defaultValue": "[0.0, 0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], FixedSize(2)]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2",
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_2"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2",
+ "functionName": "setState",
+ "returnType": "None",
+ "tooltip": "Sets the system state.\n\n:param state: The new state."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_1_1_2",
+ "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_2_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "system",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_1"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_1"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1",
+ "functionName": "setInput",
+ "returnType": "None",
+ "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_1",
+ "functionName": "setState",
+ "returnType": "None",
+ "tooltip": "Sets the system state.\n\n:param state: The new state."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_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_2_1_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "system",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2",
+ "functionName": "setInput",
+ "returnType": "None",
+ "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2",
+ "functionName": "setState",
+ "returnType": "None",
+ "tooltip": "Sets the system state.\n\n:param state: The new state."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2",
+ "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_2_2_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "system",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ },
+ {
+ "defaultValue": "[0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], FixedSize(1)]"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_1"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1",
+ "functionName": "getInput",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_1"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1",
+ "functionName": "setInput",
+ "returnType": "None",
+ "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_1",
+ "functionName": "setState",
+ "returnType": "None",
+ "tooltip": "Sets the system state.\n\n:param state: The new state."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_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_2_2_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "system",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": "[0.0, 0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], 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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2",
+ "functionName": "getInput",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the current input of the plant.\n\n:returns: The current input of the plant."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2",
+ "functionName": "setInput",
+ "returnType": "None",
+ "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2",
+ "functionName": "setState",
+ "returnType": "None",
+ "tooltip": "Sets the system state.\n\n:param state: The new state."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_2_2",
+ "functionName": "update",
+ "returnType": "None",
+ "tooltip": "Updates the simulation.\n\n:param dt: The time between updates."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.PS4ControllerSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS4ControllerSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.PS4ControllerSim",
+ "tooltip": "Constructs from a joystick port number.\n\n:param port: port number"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "notifyNewData",
+ "returnType": "None",
+ "tooltip": "Updates joystick data so that new values are visible to the user program."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS4ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.HIDType"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": "Set the type of this device.\n\n:param type: the new device type"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.PS5ControllerSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystick",
+ "type": "wpilib.PS5Controller"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.PS5ControllerSim",
+ "tooltip": "Constructs from a PS5Controller object.\n\n:param joystick: controller to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.PS5ControllerSim",
+ "tooltip": "Constructs from a joystick port number.\n\n:param port: port number"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "notifyNewData",
+ "returnType": "None",
+ "tooltip": "Updates joystick data so that new values are visible to the user program."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setL2Axis",
+ "returnType": "None",
+ "tooltip": "Change the value of the left trigger 2 axis on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setL2Button",
+ "returnType": "None",
+ "tooltip": "Change the value of the left trigger 2 button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setL3Button",
+ "returnType": "None",
+ "tooltip": "Change the value of the L3 (left stick) button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setLeftX",
+ "returnType": "None",
+ "tooltip": "Change the left X value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setLeftY",
+ "returnType": "None",
+ "tooltip": "Change the left Y value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setOptionsButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the options button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setRightX",
+ "returnType": "None",
+ "tooltip": "Change the right X value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setRightY",
+ "returnType": "None",
+ "tooltip": "Change the right Y value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setSquareButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the square button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setTouchpadButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the touchpad button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PS5ControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PS5ControllerSim",
+ "functionName": "setTriangleButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the triangle button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.HIDType"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": "Set the type of this device.\n\n:param type: the new device type"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.PWMSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "motorctrl",
+ "type": "wpilib.PWMMotorController"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.PWMSim",
+ "tooltip": "Constructs from a PWMMotorController object.\n\n:param motorctrl: PWMMotorController to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": "Check whether the PWM has been initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "getPeriodScale",
+ "returnType": "int",
+ "tooltip": "Get the PWM period scale.\n\n:returns: the PWM period scale"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "getPosition",
+ "returnType": "float",
+ "tooltip": "Get the PWM position.\n\n:returns: the PWM position (0.0 to 1.0)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ }
+ ],
+ "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": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "getZeroLatch",
+ "returnType": "bool",
+ "tooltip": "Check whether the PWM is zero latched.\n\n:returns: true if zero latched"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": "Define whether the PWM has been initialized.\n\n:param initialized: whether this object is initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "periodScale",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "setPeriodScale",
+ "returnType": "None",
+ "tooltip": "Set the PWM period scale.\n\n:param periodScale: the PWM period scale"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "position",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "setPosition",
+ "returnType": "None",
+ "tooltip": "Set the PWM position.\n\n:param position: the PWM position (0.0 to 1.0)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "microsecondPulseTime",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "setPulseMicrosecond",
+ "returnType": "None",
+ "tooltip": "Set the PWM pulse microsecond value.\n\n:param microsecondPulseTime: the PWM pulse microsecond value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "setSpeed",
+ "returnType": "None",
+ "tooltip": "Set the PWM speed.\n\n:param speed: the PWM speed (-1.0 to 1.0)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PWMSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "zeroLatch",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PWMSim",
+ "functionName": "setZeroLatch",
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ }
+ ],
+ "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)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "getCompressorOn",
+ "returnType": "bool",
+ "tooltip": "Check if the compressor is on.\n\n:returns: true if the compressor is active"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": "Check whether the PCM/PH has been initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "getPressureSwitch",
+ "returnType": "bool",
+ "tooltip": "Check the value of the pressure switch.\n\n:returns: the pressure switch value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data for this object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputs",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "setAllSolenoidOutputs",
+ "returnType": "None",
+ "tooltip": "Change all of the solenoid outputs.\n\n:param outputs: the new solenoid outputs (1 bit per output)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "compressorCurrent",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "setCompressorCurrent",
+ "returnType": "None",
+ "tooltip": "Set the compressor current.\n\n:param compressorCurrent: the new compressor current"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "compressorOn",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "setCompressorOn",
+ "returnType": "None",
+ "tooltip": "Set whether the compressor is active.\n\n:param compressorOn: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": "Define whether the PCM/PH has been initialized.\n\n:param initialized: true for initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pressureSwitch",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "setPressureSwitch",
+ "returnType": "None",
+ "tooltip": "Set the value of the pressure switch.\n\n:param pressureSwitch: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "solenoidOutput",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "setSolenoidOutput",
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.PneumaticsModuleType"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PneumaticsBaseSim",
+ "functionName": "getForType",
+ "returnType": "wpilib.simulation.PneumaticsBaseSim",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.PowerDistributionSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "module",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PowerDistributionSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.PowerDistributionSim",
+ "tooltip": "Constructs from a PowerDistribution module number (CAN ID).\n\n:param module: module number"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pdp",
+ "type": "wpilib.PowerDistribution"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PowerDistributionSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.PowerDistributionSim",
+ "tooltip": "Constructs from a PowerDistribution object.\n\n:param pdp: PowerDistribution to simulate"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PowerDistributionSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": "Check whether the PowerDistribution has been initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PowerDistributionSim",
+ "functionName": "getTemperature",
+ "returnType": "float",
+ "tooltip": "Check the temperature of the PowerDistribution.\n\n:returns: the PowerDistribution temperature"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PowerDistributionSim",
+ "functionName": "getVoltage",
+ "returnType": "float",
+ "tooltip": "Check the PowerDistribution voltage.\n\n:returns: the PowerDistribution voltage."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PowerDistributionSim",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PowerDistributionSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all PowerDistribution simulation data."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "currents",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "current",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "temperature",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.PowerDistributionSim",
+ "functionName": "setTemperature",
+ "returnType": "None",
+ "tooltip": "Define the PowerDistribution temperature.\n\n:param temperature: the new PowerDistribution temperature"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.PowerDistributionSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "module",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "pneumatics",
+ "type": "wpilib.PneumaticsBase"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.REVPHSim",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "getAllSolenoidOutputs",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "getCompressorCurrent",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "getInitialized",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "getPressureSwitch",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "getSolenoidOutput",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "registerCompressorCurrentCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "registerCompressorOnCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "registerInitializedCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "registerPressureSwitchCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "registerSolenoidOutputCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputs",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "setAllSolenoidOutputs",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "compressorCurrent",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "setCompressorCurrent",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "compressorOn",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "setCompressorOn",
+ "returnType": "None",
+ "tooltip": "Set whether the compressor is active.\n\n:param compressorOn: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "solenoidInitialized",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "setInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pressureSwitch",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "setPressureSwitch",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.REVPHSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "solenoidOutput",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "setSolenoidOutput",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.PneumaticsModuleType"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.REVPHSim",
+ "functionName": "getForType",
+ "returnType": "wpilib.simulation.PneumaticsBaseSim",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.RelaySim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "relay",
+ "type": "wpilib.Relay"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.RelaySim",
+ "tooltip": "Constructs from a Relay object.\n\n:param relay: Relay to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.RelaySim",
+ "tooltip": "Constructs from a relay channel number.\n\n:param channel: Channel number"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "getForward",
+ "returnType": "bool",
+ "tooltip": "Check whether the forward direction is active.\n\n:returns: true if active"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "getInitializedForward",
+ "returnType": "bool",
+ "tooltip": "Check whether the forward direction has been initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "getInitializedReverse",
+ "returnType": "bool",
+ "tooltip": "Check whether the reverse direction has been initialized.\n\n:returns: true if initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "getReverse",
+ "returnType": "bool",
+ "tooltip": "Check whether the reverse direction is active.\n\n:returns: true if active"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "registerInitializedForwardCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "registerInitializedReverseCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "registerReverseCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ },
+ {
+ "defaultValue": null,
+ "name": "forward",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ },
+ {
+ "defaultValue": null,
+ "name": "initializedForward",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "setInitializedForward",
+ "returnType": "None",
+ "tooltip": "Define whether the forward direction has been initialized.\n\n:param initializedForward: whether this object is initialized"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.RelaySim"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverse",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RelaySim",
+ "functionName": "setReverse",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "registerUserFaults5VCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "registerUserFaults6VCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "registerUserVoltage3V3Callback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "registerUserVoltage5VCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "registerUserVoltage6VCallback",
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "registerVInVoltageCallback",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "brownoutVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setBrownoutVoltage",
+ "returnType": "None",
+ "tooltip": "Define the brownout voltage.\n\n:param brownoutVoltage: the new voltage"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "comments",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setComments",
+ "returnType": "None",
+ "tooltip": "Set the comments.\n\n:param comments: The comments."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "wpilib.RadioLEDState"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setRadioLEDState",
+ "returnType": "None",
+ "tooltip": "Set the state of the radio led.\n\n:param state: The state of the radio led."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "teamNumber",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setTeamNumber",
+ "returnType": "None",
+ "tooltip": "Set the team number.\n\n:param teamNumber: the new team number."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userActive3V3",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setUserActive3V3",
+ "returnType": "None",
+ "tooltip": "Set the 3.3V rail active state.\n\n:param userActive3V3: true to make rail active"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userActive5V",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setUserActive5V",
+ "returnType": "None",
+ "tooltip": "Set the 5V rail active state.\n\n:param userActive5V: true to make rail active"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userActive6V",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setUserActive6V",
+ "returnType": "None",
+ "tooltip": "Set the 6V rail active state.\n\n:param userActive6V: true to make rail active"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "userCurrent5V",
+ "type": "wpimath.units.amperes"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setUserCurrent5V",
+ "returnType": "None",
+ "tooltip": "Define the 5V rail current.\n\n:param userCurrent5V: the new current"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userCurrent6V",
+ "type": "wpimath.units.amperes"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setUserCurrent6V",
+ "returnType": "None",
+ "tooltip": "Define the 6V rail current.\n\n:param userCurrent6V: the new current"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userFaults3V3",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setUserFaults3V3",
+ "returnType": "None",
+ "tooltip": "Set the 3.3V rail number of faults.\n\n:param userFaults3V3: number of faults"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userFaults5V",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setUserFaults5V",
+ "returnType": "None",
+ "tooltip": "Set the 5V rail number of faults.\n\n:param userFaults5V: number of faults"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userFaults6V",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setUserFaults6V",
+ "returnType": "None",
+ "tooltip": "Set the 6V rail number of faults.\n\n:param userFaults6V: number of faults"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "userVoltage5V",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setUserVoltage5V",
+ "returnType": "None",
+ "tooltip": "Define the 5V rail voltage.\n\n:param userVoltage5V: the new voltage"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userVoltage6V",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setUserVoltage6V",
+ "returnType": "None",
+ "tooltip": "Define the 6V rail voltage.\n\n:param userVoltage6V: the new voltage"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "vInCurrent",
+ "type": "wpimath.units.amperes"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.RoboRioSim",
+ "functionName": "setVInCurrent",
+ "returnType": "None",
+ "tooltip": "Define the Vin current.\n\n:param vInCurrent: the new current"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "vInVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "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": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "functionName": "getActive",
+ "returnType": "bool",
+ "tooltip": "Check whether the accelerometer is active.\n\n:returns: true if active"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "functionName": "getX",
+ "returnType": "float",
+ "tooltip": "Measure the X axis value.\n\n:returns: the X axis measurement"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "functionName": "getZ",
+ "returnType": "float",
+ "tooltip": "Measure the Z axis value.\n\n:returns: the Z axis measurement"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all simulation data of this object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "active",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "functionName": "setActive",
+ "returnType": "None",
+ "tooltip": "Define whether this accelerometer is active.\n\n:param active: the new state"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "range",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "functionName": "setRange",
+ "returnType": "None",
+ "tooltip": "Change the range of this accelerometer.\n\n:param range: the new accelerometer range"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.SPIAccelerometerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "z",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SPIAccelerometerSim",
+ "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.SendableChooserSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "path",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SendableChooserSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SendableChooserSim",
+ "tooltip": "Constructs a SendableChooserSim.\n\n:param path: The path where the SendableChooser is published."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "inst",
+ "type": "ntcore.NetworkTableInstance"
+ },
+ {
+ "defaultValue": null,
+ "name": "path",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SendableChooserSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SendableChooserSim",
+ "tooltip": "Constructs a SendableChooserSim.\n\n:param inst: The NetworkTables instance.\n:param path: The path where the SendableChooser is published."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SendableChooserSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "option",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SendableChooserSim",
+ "functionName": "setSelected",
+ "returnType": "None",
+ "tooltip": "Set the selected option.\n\n:param option: The option."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.SharpIRSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "sharpIR",
+ "type": "wpilib.SharpIR"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SharpIRSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SharpIRSim",
+ "tooltip": "Constructor.\n\n:param sharpIR: The real sensor to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SharpIRSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SharpIRSim",
+ "tooltip": "Constructor.\n\n:param channel: Analog channel for this sensor"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SharpIRSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "rng",
+ "type": "wpimath.units.centimeters"
+ }
+ ],
+ "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"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.SimDeviceSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SimDeviceSim",
+ "tooltip": "Constructs a SimDeviceSim.\n\n:param name: name of the SimDevice"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SimDeviceSim",
+ "tooltip": "Constructs a SimDeviceSim.\n\n:param name: name of the SimDevice\n:param index: device index number to append to name"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SimDeviceSim",
+ "tooltip": "Constructs a SimDeviceSim.\n\n:param name: name of the SimDevice\n:param index: device index number to append to name\n:param channel: device channel number to append to name"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SimDeviceSim",
+ "tooltip": "Constructs a SimDeviceSim.\n\n:param handle: the low level handle for the corresponding SimDevice."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SimDeviceSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "enumerateValues",
+ "returnType": "list[tuple[str, bool]]",
+ "tooltip": "Returns a list of (name, readonly) tuples of available values for this device"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SimDeviceSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "getBoolean",
+ "returnType": "hal.SimBoolean",
+ "tooltip": "Retrieves an object that allows you to interact with simulated values\nrepresented as a boolean."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SimDeviceSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "getDouble",
+ "returnType": "hal.SimDouble",
+ "tooltip": "Retrieves an object that allows you to interact with simulated values\nrepresented as a double."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SimDeviceSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "getEnum",
+ "returnType": "hal.SimEnum",
+ "tooltip": "Get the property object with the given name.\n\n:param name: the property name\n\n:returns: the property object"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SimDeviceSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "getInt",
+ "returnType": "hal.SimInt",
+ "tooltip": "Retrieves an object that allows you to interact with simulated values\nrepresented as an integer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SimDeviceSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "getLong",
+ "returnType": "hal.SimLong",
+ "tooltip": "Retrieves an object that allows you to interact with simulated values\nrepresented as a long."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SimDeviceSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "getName",
+ "returnType": "str",
+ "tooltip": "Get the name of this object.\n\n:returns: name"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SimDeviceSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "getValue",
+ "returnType": "hal.SimValue",
+ "tooltip": "Provides a readonly mechanism to retrieve all types of device values"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": "''",
+ "name": "prefix",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "enumerateDevices",
+ "returnType": "list[str]",
+ "tooltip": "Returns a list of available device names"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "val",
+ "type": "hal.SimEnum"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "getEnumOptions",
+ "returnType": "list[str]",
+ "tooltip": "Get all options for the given enum.\n\n:param val: the enum\n\n:returns: names of the different values for that enum"
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpilib.simulation.SimDeviceSim",
+ "functionName": "resetData",
+ "returnType": "None",
+ "tooltip": "Reset all SimDevice data."
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.SingleJointedArmSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "system",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearbox",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "armLength",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "minAngle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAngle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "simulateGravity",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "startingAngle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": "[0.0, 0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], FixedSize(2)]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SingleJointedArmSim",
+ "tooltip": "Creates a simulated arm mechanism.\n\n:param system: The system representing this arm. This system can\n be created with\n LinearSystemId::SingleJointedArmSystem().\n:param gearbox: The type and number of motors on the arm gearbox.\n:param gearing: The gear ratio of the arm (numbers greater than 1\n represent reductions).\n:param armLength: The length of the arm.\n:param minAngle: The minimum angle that the arm is capable of.\n:param maxAngle: The maximum angle that the arm is capable of.\n:param simulateGravity: Whether gravity should be simulated or not.\n:param startingAngle: The initial position of the arm.\n:param measurementStdDevs: The standard deviations of the measurements."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "gearbox",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "moi",
+ "type": "wpimath.units.kilogram_square_meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "armLength",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "minAngle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAngle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "simulateGravity",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "startingAngle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": "[0.0, 0.0]",
+ "name": "measurementStdDevs",
+ "type": "Annotated[list[float], FixedSize(2)]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SingleJointedArmSim",
+ "tooltip": "Creates a simulated arm mechanism.\n\n:param gearbox: The type and number of motors on the arm gearbox.\n:param gearing: The gear ratio of the arm (numbers greater than 1\n represent reductions).\n:param moi: The moment of inertia of the arm. This can be\n calculated from CAD software.\n:param armLength: The length of the arm.\n:param minAngle: The minimum angle that the arm is capable of.\n:param maxAngle: The maximum angle that the arm is capable of.\n:param simulateGravity: Whether gravity should be simulated or not.\n:param startingAngle: The initial position of the arm.\n:param measurementStdDevs: The standard deviation of the measurement noise."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "getAngle",
+ "returnType": "wpimath.units.radians",
+ "tooltip": "Returns the current arm angle.\n\n:returns: The current arm angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "getAngleDegrees",
+ "returnType": "wpimath.units.degrees",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "getCurrentDraw",
+ "returnType": "wpimath.units.amperes",
+ "tooltip": "Returns the arm current draw.\n\n:returns: The arm current draw."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "getVelocity",
+ "returnType": "wpimath.units.radians_per_second",
+ "tooltip": "Returns the current arm velocity.\n\n:returns: The current arm velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "getVelocityDps",
+ "returnType": "wpimath.units.degrees_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "hasHitLowerLimit",
+ "returnType": "bool",
+ "tooltip": "Returns whether the arm has hit the lower limit.\n\n:returns: Whether the arm has hit the lower limit."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "hasHitUpperLimit",
+ "returnType": "bool",
+ "tooltip": "Returns whether the arm has hit the upper limit.\n\n:returns: Whether the arm has hit the upper limit."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2",
+ "functionName": "setInput",
+ "returnType": "None",
+ "tooltip": "Sets the system inputs (usually voltages).\n\n:param u: The system inputs."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "row",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "setInputVoltage",
+ "returnType": "None",
+ "tooltip": "Sets the input voltage for the arm.\n\n:param voltage: The input voltage."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "setState",
+ "returnType": "None",
+ "tooltip": "Sets the arm's state. The new angle will be limited between the minimum and\nmaximum allowed limits.\n\n:param angle: The new angle.\n:param velocity: The new angular velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.LinearSystemSim_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.LinearSystemSim_2_1_2",
+ "functionName": "update",
+ "returnType": "None",
+ "tooltip": "Updates the simulation.\n\n:param dt: The time between updates."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "armAngle",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "wouldHitLowerLimit",
+ "returnType": "bool",
+ "tooltip": "Returns whether the arm would hit the lower limit.\n\n:param armAngle: The arm height.\n\n:returns: Whether the arm would hit the lower limit."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SingleJointedArmSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "armAngle",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "wouldHitUpperLimit",
+ "returnType": "bool",
+ "tooltip": "Returns whether the arm would hit the upper limit.\n\n:param armAngle: The arm height.\n\n:returns: Whether the arm would hit the upper limit."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "mass",
+ "type": "wpimath.units.kilograms"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SingleJointedArmSim",
+ "functionName": "estimateMOI",
+ "returnType": "wpimath.units.kilogram_square_meters",
+ "tooltip": "Calculates a rough estimate of the moment of inertia of an arm given its\nlength and mass.\n\n:param length: The length of the arm.\n:param mass: The mass of the arm.\n\n:returns: The calculated moment of inertia."
+ }
+ ]
+ },
+ {
+ "className": "wpilib.simulation.SolenoidSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleSim",
+ "type": "wpilib.simulation.PneumaticsBaseSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SolenoidSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SolenoidSim",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.PneumaticsModuleType"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SolenoidSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SolenoidSim",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.PneumaticsModuleType"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SolenoidSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.SolenoidSim",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SolenoidSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SolenoidSim",
+ "functionName": "getModuleSim",
+ "returnType": "wpilib.simulation.PneumaticsBaseSim",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SolenoidSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SolenoidSim",
+ "functionName": "getOutput",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.SolenoidSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SolenoidSim",
+ "functionName": "registerOutputCallback",
+ "returnType": "wpilib.simulation.CallbackStore",
+ "tooltip": "Register a callback to be run when the output of this solenoid has changed.\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": null,
+ "name": "self",
+ "type": "wpilib.simulation.SolenoidSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "output",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.SolenoidSim",
+ "functionName": "setOutput",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.StadiaControllerSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystick",
+ "type": "wpilib.StadiaController"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.StadiaControllerSim",
+ "tooltip": "Constructs from a StadiaController object.\n\n:param joystick: controller to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.StadiaControllerSim",
+ "tooltip": "Constructs from a joystick port number.\n\n:param port: port number"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "notifyNewData",
+ "returnType": "None",
+ "tooltip": "Updates joystick data so that new values are visible to the user program."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setAButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the A button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setBButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the B button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setEllipsesButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the ellipses button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setFrameButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the frame button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setGoogleButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the google button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setHamburgerButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the hamburger button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setLeftBumperButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the left bumper button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setLeftStickButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the left stick button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setLeftTriggerButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the left trigger button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setLeftX",
+ "returnType": "None",
+ "tooltip": "Change the left X value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setLeftY",
+ "returnType": "None",
+ "tooltip": "Change the left Y value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setRightBumperButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the right bumper button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setRightStickButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the right stick button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setRightTriggerButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the right trigger button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setRightX",
+ "returnType": "None",
+ "tooltip": "Change the right X value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setRightY",
+ "returnType": "None",
+ "tooltip": "Change the right Y value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setStadiaButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the stadia button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.HIDType"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": "Set the type of this device.\n\n:param type: the new device type"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setXButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the X button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.StadiaControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.StadiaControllerSim",
+ "functionName": "setYButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the Y button on the controller.\n\n:param value: the new value"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.simulation.UltrasonicSim",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "ping",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.UltrasonicSim"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.UltrasonicSim"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystick",
+ "type": "wpilib.XboxController"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.XboxControllerSim",
+ "tooltip": "Constructs from a XboxController object.\n\n:param joystick: controller to simulate"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "__init__",
+ "returnType": "wpilib.simulation.XboxControllerSim",
+ "tooltip": "Constructs from a joystick port number.\n\n:param port: port number"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputNumber",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.RumbleType"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "notifyNewData",
+ "returnType": "None",
+ "tooltip": "Updates joystick data so that new values are visible to the user program."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setAButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the A button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setBButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the B button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setBackButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the back button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setLeftBumperButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the left bumper button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setLeftStickButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the left stick button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setLeftTriggerAxis",
+ "returnType": "None",
+ "tooltip": "Change the value of the left trigger axis on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setLeftX",
+ "returnType": "None",
+ "tooltip": "Change the left X value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setLeftY",
+ "returnType": "None",
+ "tooltip": "Change the left Y value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setRightBumperButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the right bumper button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setRightStickButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the right stick button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setRightTriggerAxis",
+ "returnType": "None",
+ "tooltip": "Change the value of the right trigger axis on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setRightX",
+ "returnType": "None",
+ "tooltip": "Change the right X value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setRightY",
+ "returnType": "None",
+ "tooltip": "Change the right Y value of the controller's joystick.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setStartButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the start button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.GenericHIDSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "wpilib.interfaces.GenericHID.HIDType"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.GenericHIDSim",
+ "functionName": "setType",
+ "returnType": "None",
+ "tooltip": "Set the type of this device.\n\n:param type: the new device type"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setXButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the X button on the controller.\n\n:param value: the new value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.simulation.XboxControllerSim"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpilib.simulation.XboxControllerSim",
+ "functionName": "setYButton",
+ "returnType": "None",
+ "tooltip": "Change the value of the Y button on the controller.\n\n:param value: the new value"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.simulation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpilib.sysid.SysIdRoutineLog",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "logName",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog",
+ "functionName": "__init__",
+ "returnType": "wpilib.sysid.SysIdRoutineLog",
+ "tooltip": "Create a new logging utility for a SysId test routine.\n\n:param logName: The name for the test routine in the log. Should be unique\n between complete test routines (quasistatic and dynamic, forward and\n reverse). The current state of this test (e.g. \"quasistatic-forward\")\n will appear in WPILog under the \"sysid-test-state-logName\" entry."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "motorName",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog",
+ "functionName": "motor",
+ "returnType": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "tooltip": "Log data from a motor during a SysId routine.\n\n:param motorName: The name of the motor.\n\n:returns: Handle with chainable callbacks to log individual data fields."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "wpilib.sysid.State"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog",
+ "functionName": "recordState",
+ "returnType": "None",
+ "tooltip": "Records the current state of the SysId test routine. Should be called once\nper iteration during tests with the type of the current test, and once upon\ntest end with state `none`.\n\n:param state: The current state of the SysId test routine."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.sysid",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "wpilib.sysid.State"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog",
+ "functionName": "stateEnumToString",
+ "returnType": "str",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog.MotorLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "acceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "functionName": "acceleration",
+ "returnType": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "tooltip": "Log the linear acceleration of the motor.\n\nThis is optional; SysId can perform an accurate fit without it.\n\n:param acceleration: The linear acceleration to record.\n\n:returns: The motor log (for call chaining)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog.MotorLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "acceleration",
+ "type": "wpimath.units.turns_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "functionName": "angularAcceleration",
+ "returnType": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "tooltip": "Log the angular acceleration of the motor.\n\nThis is optional; SysId can perform an accurate fit without it.\n\n:param acceleration: The angular acceleration to record.\n\n:returns: The motor log (for call chaining)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog.MotorLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "position",
+ "type": "wpimath.units.turns"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "functionName": "angularPosition",
+ "returnType": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "tooltip": "Log the angular position of the motor.\n\n:param position: The angular position to record.\n\n:returns: The motor log (for call chaining)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog.MotorLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.turns_per_second"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "functionName": "angularVelocity",
+ "returnType": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "tooltip": "Log the angular velocity of the motor.\n\n:param velocity: The angular velocity to record.\n\n:returns: The motor log (for call chaining)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog.MotorLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "current",
+ "type": "wpimath.units.amperes"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "functionName": "current",
+ "returnType": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "tooltip": "Log the current applied to the motor.\n\nThis is optional; SysId can perform an accurate fit without it.\n\n:param current: The current to record.\n\n:returns: The motor log (for call chaining)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog.MotorLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "position",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "functionName": "position",
+ "returnType": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "tooltip": "Log the linear position of the motor.\n\n:param position: The linear position to record.\n\n:returns: The motor log (for call chaining)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog.MotorLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "unit",
+ "type": "str"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "functionName": "value",
+ "returnType": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "tooltip": "Log a generic data value from the motor.\n\n:param name: The name of the data field being recorded.\n:param value: The numeric value of the data field.\n:param unit: The unit string of the data field.\n\n:returns: The motor log (for call chaining)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog.MotorLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "functionName": "velocity",
+ "returnType": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "tooltip": "Log the linear velocity of the motor.\n\n:param velocity: The linear velocity to record.\n\n:returns: The motor log (for call chaining)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpilib.sysid.SysIdRoutineLog.MotorLog"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "functionName": "voltage",
+ "returnType": "wpilib.sysid.SysIdRoutineLog.MotorLog",
+ "tooltip": "Log the voltage applied to the motor.\n\n:param voltage: The voltage to record.\n\n:returns: The motor log (for call chaining)."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpilib.sysid",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.ArmFeedforward",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kS",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "kG",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_radian"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_radian"
+ },
+ {
+ "defaultValue": "0.02",
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ArmFeedforward",
+ "tooltip": "Creates a new ArmFeedforward with the specified gains.\n\n:param kS: The static gain, in volts.\n:param kG: The gravity gain, in volts.\n:param kV: The velocity gain, in volt seconds per radian.\n:param kA: The acceleration gain, in volt seconds\u00b2 per radian.\n:param dt: The period in seconds.\n @throws IllegalArgumentException for kv < zero.\n @throws IllegalArgumentException for ka < zero.\n @throws IllegalArgumentException for period ≤ zero."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ArmFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentAngle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentVelocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "functionName": "calculate",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Calculates the feedforward from the gains and setpoint assuming discrete\ncontrol. Use this method when the velocity does not change.\n\n:param currentAngle: The current angle. This angle should be measured from\n the horizontal (i.e. if the provided angle is 0, the arm should be parallel\n to the floor). If your encoder does not follow this convention, an offset\n should be added.\n:param currentVelocity: The current velocity.\n\n:returns: The computed feedforward in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ArmFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentAngle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentVelocity",
+ "type": "wpimath.units.radians_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextVelocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "functionName": "calculate",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Calculates the feedforward from the gains and setpoints assuming discrete\ncontrol.\n\n:param currentAngle: The current angle. This angle should be measured from\n the horizontal (i.e. if the provided angle is 0, the arm should be parallel\n to the floor). If your encoder does not follow this convention, an offset\n should be added.\n:param currentVelocity: The current velocity.\n:param nextVelocity: The next velocity.\n\n:returns: The computed feedforward in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ArmFeedforward"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "functionName": "getKa",
+ "returnType": "wpimath.units.volt_seconds_squared_per_radian",
+ "tooltip": "Returns the acceleration gain.\n\n:returns: The acceleration gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ArmFeedforward"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "functionName": "getKg",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Returns the gravity gain.\n\n:returns: The gravity gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ArmFeedforward"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "functionName": "getKs",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Returns the static gain.\n\n:returns: The static gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ArmFeedforward"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "functionName": "getKv",
+ "returnType": "wpimath.units.volt_seconds_per_radian",
+ "tooltip": "Returns the velocity gain.\n\n:returns: The velocity gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ArmFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "functionName": "maxAchievableAcceleration",
+ "returnType": "wpimath.units.radians_per_second_squared",
+ "tooltip": "Calculates the maximum achievable acceleration given a maximum voltage\nsupply, a position, and a velocity. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the velocity constraint, and this will give you\na simultaneously-achievable acceleration 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 velocity: The velocity of the arm.\n\n:returns: The maximum possible acceleration at the given velocity and angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ArmFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "acceleration",
+ "type": "wpimath.units.radians_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "functionName": "maxAchievableVelocity",
+ "returnType": "wpimath.units.radians_per_second",
+ "tooltip": "Calculates the maximum 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 maximum possible velocity at the given acceleration and angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ArmFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "functionName": "minAchievableAcceleration",
+ "returnType": "wpimath.units.radians_per_second_squared",
+ "tooltip": "Calculates the minimum achievable acceleration given a maximum voltage\nsupply, a position, and a velocity. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the velocity constraint, and this will give you\na simultaneously-achievable acceleration 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 velocity: The velocity of the arm.\n\n:returns: The minimum possible acceleration at the given velocity and angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ArmFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "acceleration",
+ "type": "wpimath.units.radians_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ArmFeedforward",
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.BangBangController",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "inf",
+ "name": "tolerance",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.BangBangController",
+ "tooltip": "Creates a new bang-bang controller.\n\nAlways ensure that your motor controllers are set to \"coast\" before\nattempting to control them with a bang-bang controller.\n\n:param tolerance: Tolerance for atSetpoint."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.BangBangController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "atSetpoint",
+ "returnType": "bool",
+ "tooltip": "Returns true if the error is within the tolerance of the setpoint.\n\n:returns: Whether the error is within the acceptable bounds."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.BangBangController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "setpoint",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the calculated control output.\n\nAlways ensure that your motor controllers are set to \"coast\" before\nattempting to control them with a bang-bang controller.\n\n:param measurement: The most recent measurement of the process variable.\n:param setpoint: The setpoint for the process variable.\n\n:returns: The calculated motor output (0 or 1)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.BangBangController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the calculated control output.\n\n:param measurement: The most recent measurement of the process variable.\n\n:returns: The calculated motor output (0 or 1)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.BangBangController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "getError",
+ "returnType": "float",
+ "tooltip": "Returns the current error.\n\n:returns: The current error."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.BangBangController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "getMeasurement",
+ "returnType": "float",
+ "tooltip": "Returns the current measurement of the process variable.\n\n:returns: The current measurement of the process variable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.BangBangController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "getSetpoint",
+ "returnType": "float",
+ "tooltip": "Returns the current setpoint of the bang-bang controller.\n\n:returns: The current setpoint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.BangBangController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "getTolerance",
+ "returnType": "float",
+ "tooltip": "Returns the current tolerance of the controller.\n\n:returns: The current tolerance."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.BangBangController"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.BangBangController"
+ },
+ {
+ "defaultValue": null,
+ "name": "setpoint",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "setSetpoint",
+ "returnType": "None",
+ "tooltip": "Sets the setpoint for the bang-bang controller.\n\n:param setpoint: The desired setpoint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.BangBangController"
+ },
+ {
+ "defaultValue": null,
+ "name": "tolerance",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.BangBangController",
+ "functionName": "setTolerance",
+ "returnType": "None",
+ "tooltip": "Sets the error within which AtSetpoint will return true.\n\n:param tolerance: Position error which is tolerable."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "tooltip": "Constructs a feedforward with given model dynamics as a function\nof state and input.\n\n:param f: A vector-valued function of x, the state, and\n u, the input, that returns the derivative of\n the state vector. HAS to be control-affine\n (of the form f(x) + Bu).\n:param dt: The timestep between calls of calculate()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "tooltip": "Constructs a feedforward with given model dynamics as a function of state,\nand the plant's B matrix(continuous input matrix).\n\n:param f: A vector-valued function of x, the state,\n that returns the derivative of the state vector.\n:param B: Continuous input matrix of the plant being controlled.\n:param dt: The timestep between calls of calculate()."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a specified initial state vector.\n\n:param initialState: The initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a zero initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "functionName": "uff",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_1_1",
+ "functionName": "uff",
+ "returnType": "float",
+ "tooltip": "Returns an element of the previously calculated feedforward.\n\n:param i: Row of uff.\n\n:returns: The row of the calculated feedforward."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "tooltip": "Constructs a feedforward with given model dynamics as a function\nof state and input.\n\n:param f: A vector-valued function of x, the state, and\n u, the input, that returns the derivative of\n the state vector. HAS to be control-affine\n (of the form f(x) + Bu).\n:param dt: The timestep between calls of calculate()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "tooltip": "Constructs a feedforward with given model dynamics as a function of state,\nand the plant's B matrix(continuous input matrix).\n\n:param f: A vector-valued function of x, the state,\n that returns the derivative of the state vector.\n:param B: Continuous input matrix of the plant being controlled.\n:param dt: The timestep between calls of calculate()."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a specified initial state vector.\n\n:param initialState: The initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a zero initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "functionName": "uff",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_1",
+ "functionName": "uff",
+ "returnType": "float",
+ "tooltip": "Returns an element of the previously calculated feedforward.\n\n:param i: Row of uff.\n\n:returns: The row of the calculated feedforward."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "tooltip": "Constructs a feedforward with given model dynamics as a function\nof state and input.\n\n:param f: A vector-valued function of x, the state, and\n u, the input, that returns the derivative of\n the state vector. HAS to be control-affine\n (of the form f(x) + Bu).\n:param dt: The timestep between calls of calculate()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "tooltip": "Constructs a feedforward with given model dynamics as a function of state,\nand the plant's B matrix(continuous input matrix).\n\n:param f: A vector-valued function of x, the state,\n that returns the derivative of the state vector.\n:param B: Continuous input matrix of the plant being controlled.\n:param dt: The timestep between calls of calculate()."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a specified initial state vector.\n\n:param initialState: The initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a zero initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "functionName": "uff",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ControlAffinePlantInversionFeedforward_2_2",
+ "functionName": "uff",
+ "returnType": "float",
+ "tooltip": "Returns an element of the previously calculated feedforward.\n\n:param i: Row of uff.\n\n:returns: The row of the calculated feedforward."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.DifferentialDriveAccelerationLimiter",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "system",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "trackwidth",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxLinearAccel",
+ "type": "wpimath.units.meters_per_second_squared"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAngularAccel",
+ "type": "wpimath.units.radians_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.DifferentialDriveAccelerationLimiter",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.DifferentialDriveAccelerationLimiter",
+ "tooltip": "Constructs a DifferentialDriveAccelerationLimiter.\n\n:param system: The differential drive dynamics.\n:param trackwidth: The distance between the differential drive's left and\n right wheels.\n:param maxLinearAccel: The maximum linear acceleration.\n:param maxAngularAccel: The maximum angular acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "system",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "trackwidth",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "minLinearAccel",
+ "type": "wpimath.units.meters_per_second_squared"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxLinearAccel",
+ "type": "wpimath.units.meters_per_second_squared"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAngularAccel",
+ "type": "wpimath.units.radians_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.DifferentialDriveAccelerationLimiter",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.DifferentialDriveAccelerationLimiter",
+ "tooltip": "Constructs a DifferentialDriveAccelerationLimiter.\n\n:param system: The differential drive dynamics.\n:param trackwidth: The distance between the differential drive's left and\n right wheels.\n:param minLinearAccel: The minimum (most negative) linear acceleration.\n:param maxLinearAccel: The maximum (most positive) linear acceleration.\n:param maxAngularAccel: The maximum angular acceleration.\n @throws std::invalid_argument if minimum linear acceleration is greater\n than maximum linear acceleration"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.DifferentialDriveAccelerationLimiter"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.DifferentialDriveAccelerationLimiter",
+ "functionName": "calculate",
+ "returnType": "wpimath.controller.DifferentialDriveWheelVoltages",
+ "tooltip": "Returns the next voltage pair subject to acceleration constraints.\n\n:param leftVelocity: The left wheel velocity.\n:param rightVelocity: The right wheel velocity.\n:param leftVoltage: The unconstrained left motor voltage.\n:param rightVoltage: The unconstrained right motor voltage.\n\n:returns: The constrained wheel voltages."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.DifferentialDriveWheelVoltages",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "left",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": "0",
+ "name": "right",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.DifferentialDriveWheelVoltages",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.DifferentialDriveWheelVoltages",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "left",
+ "tooltip": "Left wheel voltage.",
+ "type": "wpimath.units.volts",
+ "writable": true
+ },
+ {
+ "name": "right",
+ "tooltip": "Right wheel voltage.",
+ "type": "wpimath.units.volts",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.ElevatorFeedforward",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kS",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "kG",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_meter"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_meter"
+ },
+ {
+ "defaultValue": "0.02",
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ElevatorFeedforward",
+ "tooltip": "Creates a new ElevatorFeedforward with the specified gains.\n\n:param kS: The static gain, in volts.\n:param kG: The gravity gain, in volts.\n:param kV: The velocity gain, in volt seconds per distance.\n:param kA: The acceleration gain, in volt seconds\u00b2 per distance.\n:param dt: The period in seconds.\n @throws IllegalArgumentException for kv < zero.\n @throws IllegalArgumentException for ka < zero.\n @throws IllegalArgumentException for period ≤ zero."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ElevatorFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentVelocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "functionName": "calculate",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Calculates the feedforward from the gains and setpoint assuming discrete\ncontrol. Use this method when the setpoint does not change.\n\n:param currentVelocity: The velocity setpoint.\n\n:returns: The computed feedforward, in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ElevatorFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextVelocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "functionName": "calculate",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Calculates the feedforward from the gains and setpoints assuming discrete\ncontrol.\n\nNote this method is inaccurate when the velocity crosses 0.\n\n:param currentVelocity: The current velocity setpoint.\n:param nextVelocity: The next velocity setpoint.\n\n:returns: The computed feedforward, in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ElevatorFeedforward"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "functionName": "getKa",
+ "returnType": "wpimath.units.volt_seconds_squared_per_meter",
+ "tooltip": "Returns the acceleration gain.\n\n:returns: The acceleration gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ElevatorFeedforward"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "functionName": "getKg",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Returns the gravity gain.\n\n:returns: The gravity gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ElevatorFeedforward"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "functionName": "getKs",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Returns the static gain.\n\n:returns: The static gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ElevatorFeedforward"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "functionName": "getKv",
+ "returnType": "wpimath.units.volt_seconds_per_meter",
+ "tooltip": "Returns the velocity gain.\n\n:returns: The velocity gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ElevatorFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "functionName": "maxAchievableAcceleration",
+ "returnType": "wpimath.units.meters_per_second_squared",
+ "tooltip": "Calculates the maximum achievable acceleration given a maximum voltage\nsupply and a velocity. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the velocity constraint, and this will give you\na simultaneously-achievable acceleration constraint.\n\n:param maxVoltage: The maximum voltage that can be supplied to the elevator.\n:param velocity: The velocity of the elevator.\n\n:returns: The maximum possible acceleration at the given velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ElevatorFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "acceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "functionName": "maxAchievableVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": "Calculates the maximum 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 maximum possible velocity at the given acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ElevatorFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "functionName": "minAchievableAcceleration",
+ "returnType": "wpimath.units.meters_per_second_squared",
+ "tooltip": "Calculates the minimum achievable acceleration given a maximum voltage\nsupply and a velocity. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the velocity constraint, and this will give you\na simultaneously-achievable acceleration constraint.\n\n:param maxVoltage: The maximum voltage that can be supplied to the elevator.\n:param velocity: The velocity of the elevator.\n\n:returns: The minimum possible acceleration at the given velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ElevatorFeedforward"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "acceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ElevatorFeedforward",
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.HolonomicDriveController",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "xController",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "yController",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "thetaController",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.HolonomicDriveController",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.HolonomicDriveController",
+ "tooltip": "Constructs a holonomic drive controller.\n\n:param xController: A PID Controller to respond to error in the\n field-relative x direction.\n:param yController: A PID Controller to respond to error in the\n field-relative y direction.\n:param thetaController: A profiled PID controller to respond to error in\n angle."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.HolonomicDriveController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.HolonomicDriveController",
+ "functionName": "atReference",
+ "returnType": "bool",
+ "tooltip": "Returns true if the pose error is within tolerance of the reference."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.HolonomicDriveController"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "trajectoryPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "desiredLinearVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "desiredHeading",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.HolonomicDriveController",
+ "functionName": "calculate",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Returns the next output of the holonomic drive controller.\n\n:param currentPose: The current pose, as measured by odometry or pose\n estimator.\n:param trajectoryPose: The desired trajectory pose, as sampled for the\n current timestep.\n:param desiredLinearVelocity: The desired linear velocity.\n:param desiredHeading: The desired heading.\n\n:returns: The next output of the holonomic drive controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.HolonomicDriveController"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "desiredState",
+ "type": "wpimath.trajectory.Trajectory.State"
+ },
+ {
+ "defaultValue": null,
+ "name": "desiredHeading",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.HolonomicDriveController",
+ "functionName": "calculate",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Returns the next output of the holonomic drive controller.\n\n:param currentPose: The current pose, as measured by odometry or pose\n estimator.\n:param desiredState: The desired trajectory pose, as sampled for the current\n timestep.\n:param desiredHeading: The desired heading.\n\n:returns: The next output of the holonomic drive controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.HolonomicDriveController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.HolonomicDriveController",
+ "functionName": "getThetaController",
+ "returnType": "wpimath.controller.ProfiledPIDControllerRadians",
+ "tooltip": "Returns the rotation ProfiledPIDController"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.HolonomicDriveController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.HolonomicDriveController",
+ "functionName": "getXController",
+ "returnType": "wpimath.controller.PIDController",
+ "tooltip": "Returns the X PIDController"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.HolonomicDriveController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.HolonomicDriveController",
+ "functionName": "getYController",
+ "returnType": "wpimath.controller.PIDController",
+ "tooltip": "Returns the Y PIDController"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.HolonomicDriveController"
+ },
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.HolonomicDriveController",
+ "functionName": "setEnabled",
+ "returnType": "None",
+ "tooltip": "Enables and disables the controller for troubleshooting purposes. When\nCalculate() is called on a disabled controller, only feedforward values\nare returned.\n\n:param enabled: If the controller is enabled or not."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.HolonomicDriveController"
+ },
+ {
+ "defaultValue": null,
+ "name": "tolerance",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.HolonomicDriveController",
+ "functionName": "setTolerance",
+ "returnType": "None",
+ "tooltip": "Sets the pose error which is considered tolerable for use with\nAtReference().\n\n:param tolerance: Pose error which is tolerable."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.ImplicitModelFollower_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Aref",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Bref",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_1_1",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Aref: Continuous system matrix whose dynamics should be followed.\n:param Bref: Continuous input matrix whose dynamics should be followed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "plantRef",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_1_1",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "plantRef",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_1_1",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "plantRef",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_1_1",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the control input vector u.\n\n:returns: The control input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1",
+ "functionName": "U",
+ "returnType": "float",
+ "tooltip": "Returns an element of the control input vector u.\n\n:param i: Row of u.\n\n:returns: The row of the control input vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_1_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the controller."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.ImplicitModelFollower_2_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Aref",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Bref",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_2_1",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Aref: Continuous system matrix whose dynamics should be followed.\n:param Bref: Continuous input matrix whose dynamics should be followed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "plantRef",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_2_1",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "plantRef",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_2_1",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "plantRef",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_2_1",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the control input vector u.\n\n:returns: The control input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1",
+ "functionName": "U",
+ "returnType": "float",
+ "tooltip": "Returns an element of the control input vector u.\n\n:param i: Row of u.\n\n:returns: The row of the control input vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the controller."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.ImplicitModelFollower_2_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Aref",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Bref",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_2_2",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Aref: Continuous system matrix whose dynamics should be followed.\n:param Bref: Continuous input matrix whose dynamics should be followed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "plantRef",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_2_2",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "plantRef",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_2_2",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "plantRef",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ImplicitModelFollower_2_2",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the control input vector u.\n\n:returns: The control input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2",
+ "functionName": "U",
+ "returnType": "float",
+ "tooltip": "Returns an element of the control input vector u.\n\n:param i: Row of u.\n\n:returns: The row of the control input vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ImplicitModelFollower_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ImplicitModelFollower_2_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the controller."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.LTVDifferentialDriveController",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "trackwidth",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "Qelems",
+ "type": "Tuple[float, float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Relems",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LTVDifferentialDriveController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LTVDifferentialDriveController",
+ "functionName": "atReference",
+ "returnType": "bool",
+ "tooltip": "Returns true if the pose error is within tolerance of the reference."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LTVDifferentialDriveController"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "poseRef",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftVelocityRef",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightVelocityRef",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LTVDifferentialDriveController",
+ "functionName": "calculate",
+ "returnType": "wpimath.controller.DifferentialDriveWheelVoltages",
+ "tooltip": "Returns the left and right output voltages of the LTV 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 leftVelocity: The current left velocity.\n:param rightVelocity: The current right velocity.\n:param poseRef: The desired pose.\n:param leftVelocityRef: The desired left velocity.\n:param rightVelocityRef: The desired right velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LTVDifferentialDriveController"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "desiredState",
+ "type": "wpimath.trajectory.Trajectory.State"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LTVDifferentialDriveController",
+ "functionName": "calculate",
+ "returnType": "wpimath.controller.DifferentialDriveWheelVoltages",
+ "tooltip": "Returns the left and right output voltages of the LTV 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 leftVelocity: The left velocity.\n:param rightVelocity: The right velocity.\n:param desiredState: The desired pose, linear velocity, and angular velocity\n from a trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LTVDifferentialDriveController"
+ },
+ {
+ "defaultValue": null,
+ "name": "poseTolerance",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftVelocityTolerance",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightVelocityTolerance",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LTVDifferentialDriveController",
+ "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.\n:param leftVelocityTolerance: Left velocity error which is tolerable.\n:param rightVelocityTolerance: Right velocity error which is tolerable."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.LTVUnicycleController",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "Qelems",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Relems",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LTVUnicycleController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LTVUnicycleController",
+ "functionName": "atReference",
+ "returnType": "bool",
+ "tooltip": "Returns true if the pose error is within tolerance of the reference."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LTVUnicycleController"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "poseRef",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "linearVelocityRef",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "angularVelocityRef",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LTVUnicycleController",
+ "functionName": "calculate",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Returns the linear and angular velocity outputs of the LTV 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": null,
+ "name": "self",
+ "type": "wpimath.controller.LTVUnicycleController"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "desiredState",
+ "type": "wpimath.trajectory.Trajectory.State"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LTVUnicycleController",
+ "functionName": "calculate",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Returns the linear and angular velocity outputs of the LTV 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": null,
+ "name": "self",
+ "type": "wpimath.controller.LTVUnicycleController"
+ },
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LTVUnicycleController",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.controller.LTVUnicycleController"
+ },
+ {
+ "defaultValue": null,
+ "name": "poseTolerance",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LTVUnicycleController",
+ "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.LinearPlantInversionFeedforward_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearPlantInversionFeedforward_1_1",
+ "tooltip": "Constructs a feedforward with the given coefficients.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param dt: Discretization timestep."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a specified initial state vector.\n\n:param initialState: The initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a zero initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1",
+ "functionName": "uff",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_1_1",
+ "functionName": "uff",
+ "returnType": "float",
+ "tooltip": "Returns an element of the previously calculated feedforward.\n\n:param i: Row of uff.\n\n:returns: The row of the calculated feedforward."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "tooltip": "Constructs a feedforward with the given coefficients.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param dt: Discretization timestep."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a specified initial state vector.\n\n:param initialState: The initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a zero initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "functionName": "uff",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_1",
+ "functionName": "uff",
+ "returnType": "float",
+ "tooltip": "Returns an element of the previously calculated feedforward.\n\n:param i: Row of uff.\n\n:returns: The row of the calculated feedforward."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "tooltip": "Constructs a feedforward with the given coefficients.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param dt: Discretization timestep."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a specified initial state vector.\n\n:param initialState: The initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a zero initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "functionName": "uff",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_2_2",
+ "functionName": "uff",
+ "returnType": "float",
+ "tooltip": "Returns an element of the previously calculated feedforward.\n\n:param i: Row of uff.\n\n:returns: The row of the calculated feedforward."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "tooltip": "Constructs a feedforward with the given coefficients.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param dt: Discretization timestep."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_3_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns the current reference vector r.\n\n:returns: The current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the current reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a specified initial state vector.\n\n:param initialState: The initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_3_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the feedforward with a zero initial state vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_3_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "functionName": "uff",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the previously calculated feedforward as an input vector.\n\n:returns: The calculated feedforward."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearPlantInversionFeedforward_3_2",
+ "functionName": "uff",
+ "returnType": "float",
+ "tooltip": "Returns an element of the previously calculated feedforward.\n\n:param i: Row of uff.\n\n:returns: The row of the calculated feedforward."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Qelems",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Relems",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\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 A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\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::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Q",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Q: The state cost matrix.\n:param R: The input cost matrix.\n:param dt: Discretization timestep.\n @throws std::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Q",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "N",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Q: The state cost matrix.\n:param R: The input cost matrix.\n:param N: The state-input cross-term cost matrix.\n:param dt: Discretization timestep.\n @throws std::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "K",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the controller matrix K."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "K",
+ "returnType": "float",
+ "tooltip": "Returns an element of the controller matrix K.\n\n:param i: Row of K.\n:param j: Column of K."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the reference vector r.\n\n:returns: The reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the control input vector u.\n\n:returns: The control input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "U",
+ "returnType": "float",
+ "tooltip": "Returns an element of the control input vector u.\n\n:param i: Row of u.\n\n:returns: The row of the control input vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "calculate",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputDelay",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "latencyCompensate",
+ "returnType": "None",
+ "tooltip": "Adjusts LQR controller gain to compensate for a pure time delay in the\ninput.\n\nLinear-Quadratic regulator controller gains tend to be aggressive. If\nsensor measurements are time-delayed too long, the LQR may be unstable.\nHowever, if we know the amount of delay, we can compute the control based\non where the system will be after the time delay.\n\nSee https://file.tavsys.net/control/controls-engineering-in-frc.pdf\nappendix C.4 for a derivation.\n\n:param plant: The plant being controlled.\n:param dt: Discretization timestep.\n:param inputDelay: Input time delay."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputDelay",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "latencyCompensate",
+ "returnType": "None",
+ "tooltip": "Adjusts LQR controller gain to compensate for a pure time delay in the\ninput.\n\nLinear-Quadratic regulator controller gains tend to be aggressive. If\nsensor measurements are time-delayed too long, the LQR may be unstable.\nHowever, if we know the amount of delay, we can compute the control based\non where the system will be after the time delay.\n\nSee https://file.tavsys.net/control/controls-engineering-in-frc.pdf\nappendix C.4 for a derivation.\n\n:param plant: The plant being controlled.\n:param dt: Discretization timestep.\n:param inputDelay: Input time delay."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_1_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the controller."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Qelems",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Relems",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\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 A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\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::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Q",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Q: The state cost matrix.\n:param R: The input cost matrix.\n:param dt: Discretization timestep.\n @throws std::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Q",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "N",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Q: The state cost matrix.\n:param R: The input cost matrix.\n:param N: The state-input cross-term cost matrix.\n:param dt: Discretization timestep.\n @throws std::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "K",
+ "returnType": "numpy.ndarray[numpy.float64[1, 2]]",
+ "tooltip": "Returns the controller matrix K."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "K",
+ "returnType": "float",
+ "tooltip": "Returns an element of the controller matrix K.\n\n:param i: Row of K.\n:param j: Column of K."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the reference vector r.\n\n:returns: The reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the control input vector u.\n\n:returns: The control input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "U",
+ "returnType": "float",
+ "tooltip": "Returns an element of the control input vector u.\n\n:param i: Row of u.\n\n:returns: The row of the control input vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "calculate",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputDelay",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "latencyCompensate",
+ "returnType": "None",
+ "tooltip": "Adjusts LQR controller gain to compensate for a pure time delay in the\ninput.\n\nLinear-Quadratic regulator controller gains tend to be aggressive. If\nsensor measurements are time-delayed too long, the LQR may be unstable.\nHowever, if we know the amount of delay, we can compute the control based\non where the system will be after the time delay.\n\nSee https://file.tavsys.net/control/controls-engineering-in-frc.pdf\nappendix C.4 for a derivation.\n\n:param plant: The plant being controlled.\n:param dt: Discretization timestep.\n:param inputDelay: Input time delay."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputDelay",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "latencyCompensate",
+ "returnType": "None",
+ "tooltip": "Adjusts LQR controller gain to compensate for a pure time delay in the\ninput.\n\nLinear-Quadratic regulator controller gains tend to be aggressive. If\nsensor measurements are time-delayed too long, the LQR may be unstable.\nHowever, if we know the amount of delay, we can compute the control based\non where the system will be after the time delay.\n\nSee https://file.tavsys.net/control/controls-engineering-in-frc.pdf\nappendix C.4 for a derivation.\n\n:param plant: The plant being controlled.\n:param dt: Discretization timestep.\n:param inputDelay: Input time delay."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the controller."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Qelems",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Relems",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\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 A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\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::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Q",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Q: The state cost matrix.\n:param R: The input cost matrix.\n:param dt: Discretization timestep.\n @throws std::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Q",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "N",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Q: The state cost matrix.\n:param R: The input cost matrix.\n:param N: The state-input cross-term cost matrix.\n:param dt: Discretization timestep.\n @throws std::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "K",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the controller matrix K."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "K",
+ "returnType": "float",
+ "tooltip": "Returns an element of the controller matrix K.\n\n:param i: Row of K.\n:param j: Column of K."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the reference vector r.\n\n:returns: The reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the control input vector u.\n\n:returns: The control input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "U",
+ "returnType": "float",
+ "tooltip": "Returns an element of the control input vector u.\n\n:param i: Row of u.\n\n:returns: The row of the control input vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "calculate",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputDelay",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "latencyCompensate",
+ "returnType": "None",
+ "tooltip": "Adjusts LQR controller gain to compensate for a pure time delay in the\ninput.\n\nLinear-Quadratic regulator controller gains tend to be aggressive. If\nsensor measurements are time-delayed too long, the LQR may be unstable.\nHowever, if we know the amount of delay, we can compute the control based\non where the system will be after the time delay.\n\nSee https://file.tavsys.net/control/controls-engineering-in-frc.pdf\nappendix C.4 for a derivation.\n\n:param plant: The plant being controlled.\n:param dt: Discretization timestep.\n:param inputDelay: Input time delay."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputDelay",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "latencyCompensate",
+ "returnType": "None",
+ "tooltip": "Adjusts LQR controller gain to compensate for a pure time delay in the\ninput.\n\nLinear-Quadratic regulator controller gains tend to be aggressive. If\nsensor measurements are time-delayed too long, the LQR may be unstable.\nHowever, if we know the amount of delay, we can compute the control based\non where the system will be after the time delay.\n\nSee https://file.tavsys.net/control/controls-engineering-in-frc.pdf\nappendix C.4 for a derivation.\n\n:param plant: The plant being controlled.\n:param dt: Discretization timestep.\n:param inputDelay: Input time delay."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_2_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the controller."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Qelems",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Relems",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\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 A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\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::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Q",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Q: The state cost matrix.\n:param R: The input cost matrix.\n:param dt: Discretization timestep.\n @throws std::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "Q",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "N",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "tooltip": "Constructs a controller with the given coefficients and plant.\n\n:param A: Continuous system matrix of the plant being controlled.\n:param B: Continuous input matrix of the plant being controlled.\n:param Q: The state cost matrix.\n:param R: The input cost matrix.\n:param N: The state-input cross-term cost matrix.\n:param dt: Discretization timestep.\n @throws std::invalid_argument If the system is unstabilizable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "K",
+ "returnType": "numpy.ndarray[numpy.float64[2, 3]]",
+ "tooltip": "Returns the controller matrix K."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "K",
+ "returnType": "float",
+ "tooltip": "Returns an element of the controller matrix K.\n\n:param i: Row of K.\n:param j: Column of K."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "R",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns the reference vector r.\n\n:returns: The reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "R",
+ "returnType": "float",
+ "tooltip": "Returns an element of the reference vector r.\n\n:param i: Row of r.\n\n:returns: The row of the reference vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the control input vector u.\n\n:returns: The control input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "U",
+ "returnType": "float",
+ "tooltip": "Returns an element of the control input vector u.\n\n:param i: Row of u.\n\n:returns: The row of the control input vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "calculate",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the next output of the controller.\n\n:param x: The current state x."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "calculate",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputDelay",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "latencyCompensate",
+ "returnType": "None",
+ "tooltip": "Adjusts LQR controller gain to compensate for a pure time delay in the\ninput.\n\nLinear-Quadratic regulator controller gains tend to be aggressive. If\nsensor measurements are time-delayed too long, the LQR may be unstable.\nHowever, if we know the amount of delay, we can compute the control based\non where the system will be after the time delay.\n\nSee https://file.tavsys.net/control/controls-engineering-in-frc.pdf\nappendix C.4 for a derivation.\n\n:param plant: The plant being controlled.\n:param dt: Discretization timestep.\n:param inputDelay: Input time delay."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputDelay",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "latencyCompensate",
+ "returnType": "None",
+ "tooltip": "Adjusts LQR controller gain to compensate for a pure time delay in the\ninput.\n\nLinear-Quadratic regulator controller gains tend to be aggressive. If\nsensor measurements are time-delayed too long, the LQR may be unstable.\nHowever, if we know the amount of delay, we can compute the control based\non where the system will be after the time delay.\n\nSee https://file.tavsys.net/control/controls-engineering-in-frc.pdf\nappendix C.4 for a derivation.\n\n:param plant: The plant being controlled.\n:param dt: Discretization timestep.\n:param inputDelay: Input time delay."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.LinearQuadraticRegulator_3_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the controller."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.PIDController",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "Kp",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Ki",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kd",
+ "type": "float"
+ },
+ {
+ "defaultValue": "0.02",
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.PIDController",
+ "tooltip": "Allocates a PIDController with the given constants for Kp, Ki, and Kd.\n\n:param Kp: The proportional coefficient. Must be >= 0.\n:param Ki: The integral coefficient. Must be >= 0.\n:param Kd: The derivative coefficient. Must be >= 0.\n:param period: The period between controller updates in seconds. The\n default is 20 milliseconds. Must be positive."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "atSetpoint",
+ "returnType": "bool",
+ "tooltip": "Returns true if the error is within the tolerance of the setpoint.\nThe error tolerance defauls to 0.05, and the error derivative tolerance\ndefaults to \u221e.\n\nThis will return false until at least one input value has been computed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the next output of the PID controller.\n\n:param measurement: The current measurement of the process variable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "setpoint",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the next output of the PID controller.\n\n:param measurement: The current measurement of the process variable.\n:param setpoint: The new setpoint of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "disableContinuousInput",
+ "returnType": "None",
+ "tooltip": "Disables continuous input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "minimumInput",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "maximumInput",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "enableContinuousInput",
+ "returnType": "None",
+ "tooltip": "Enables continuous input.\n\nRather then using the max and min input range as constraints, it considers\nthem to be the same point and automatically calculates the shortest route\nto the setpoint.\n\n:param minimumInput: The minimum value expected from the input.\n:param maximumInput: The maximum value expected from the input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getAccumulatedError",
+ "returnType": "float",
+ "tooltip": "Gets the accumulated error used in the integral calculation of this\ncontroller.\n\n:returns: The accumulated error of this controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getD",
+ "returnType": "float",
+ "tooltip": "Gets the differential coefficient.\n\n:returns: differential coefficient"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getError",
+ "returnType": "float",
+ "tooltip": "Returns the difference between the setpoint and the measurement."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getErrorDerivative",
+ "returnType": "float",
+ "tooltip": "Returns the error derivative."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getErrorDerivativeTolerance",
+ "returnType": "float",
+ "tooltip": "Gets the error derivative tolerance of this controller. Defaults to \u221e.\n\n:returns: The error derivative tolerance of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getErrorTolerance",
+ "returnType": "float",
+ "tooltip": "Gets the error tolerance of this controller. Defaults to 0.05.\n\n:returns: The error tolerance of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getI",
+ "returnType": "float",
+ "tooltip": "Gets the integral coefficient.\n\n:returns: integral coefficient"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getIZone",
+ "returnType": "float",
+ "tooltip": "Get the IZone range.\n\n:returns: Maximum magnitude of error to allow integral control."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getP",
+ "returnType": "float",
+ "tooltip": "Gets the proportional coefficient.\n\n:returns: proportional coefficient"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getPeriod",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": "Gets the period of this controller.\n\n:returns: The period of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getPositionError",
+ "returnType": "float",
+ "tooltip": "Returns the difference between the setpoint and the measurement.\n\n:deprecated: Use GetError() instead."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getPositionTolerance",
+ "returnType": "float",
+ "tooltip": "Gets the position tolerance of this controller.\n\n:deprecated: Use GetErrorTolerance() instead.\n\n:returns: The position tolerance of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getSetpoint",
+ "returnType": "float",
+ "tooltip": "Returns the current setpoint of the PIDController.\n\n:returns: The current setpoint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getVelocityError",
+ "returnType": "float",
+ "tooltip": "Returns the velocity error.\n\n:deprecated: Use GetErrorDerivative() instead."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "getVelocityTolerance",
+ "returnType": "float",
+ "tooltip": "Gets the velocity tolerance of this controller.\n\n:deprecated: Use GetErrorDerivativeTolerance() instead.\n\n:returns: The velocity tolerance of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "isContinuousInputEnabled",
+ "returnType": "bool",
+ "tooltip": "Returns true if continuous input is enabled."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Reset the previous error, the integral term, and disable the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kd",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "setD",
+ "returnType": "None",
+ "tooltip": "Sets the differential coefficient of the PID controller gain.\n\n:param Kd: The differential coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "Ki",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "setI",
+ "returnType": "None",
+ "tooltip": "Sets the integral coefficient of the PID controller gain.\n\n:param Ki: The integral coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "iZone",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "setIZone",
+ "returnType": "None",
+ "tooltip": "Sets the IZone range. When the absolute value of the position error is\ngreater than IZone, the total accumulated error will reset to zero,\ndisabling integral gain until the absolute value of the position error is\nless than IZone. This is used to prevent integral windup. Must be\nnon-negative. Passing a value of zero will effectively disable integral\ngain. Passing a value of infinity disables IZone functionality.\n\n:param iZone: Maximum magnitude of error to allow integral control. Must be\n >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "minimumIntegral",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "maximumIntegral",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "setIntegratorRange",
+ "returnType": "None",
+ "tooltip": "Sets the minimum and maximum contributions of the integral term.\n\nThe internal integrator is clamped so that the integral term's contribution\nto the output stays between minimumIntegral and maximumIntegral. This\nprevents integral windup.\n\n:param minimumIntegral: The minimum contribution of the integral term.\n:param maximumIntegral: The maximum contribution of the integral term."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kp",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "setP",
+ "returnType": "None",
+ "tooltip": "Sets the proportional coefficient of the PID controller gain.\n\n:param Kp: The proportional coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kp",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Ki",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kd",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "setPID",
+ "returnType": "None",
+ "tooltip": "Sets the PID Controller gain parameters.\n\nSets the proportional, integral, and differential coefficients.\n\n:param Kp: The proportional coefficient. Must be >= 0.\n:param Ki: The integral coefficient. Must be >= 0.\n:param Kd: The differential coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "setpoint",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "setSetpoint",
+ "returnType": "None",
+ "tooltip": "Sets the setpoint for the PIDController.\n\n:param setpoint: The desired setpoint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.PIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "errorTolerance",
+ "type": "float"
+ },
+ {
+ "defaultValue": "inf",
+ "name": "errorDerivativeTolerance",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.PIDController",
+ "functionName": "setTolerance",
+ "returnType": "None",
+ "tooltip": "Sets the error which is considered tolerable for use with AtSetpoint().\n\n:param errorTolerance: error which is tolerable.\n:param errorDerivativeTolerance: error derivative which is tolerable."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.ProfiledPIDController",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "Kp",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Ki",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kd",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraints",
+ "type": "wpimath.trajectory.TrapezoidProfile.Constraints"
+ },
+ {
+ "defaultValue": "0.02",
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ProfiledPIDController",
+ "tooltip": "Allocates a ProfiledPIDController with the given constants for Kp, Ki, and\nKd. Users should call reset() when they first start running the controller\nto avoid unwanted behavior.\n\n:param Kp: The proportional coefficient. Must be >= 0.\n:param Ki: The integral coefficient. Must be >= 0.\n:param Kd: The derivative coefficient. Must be >= 0.\n:param constraints: Velocity and acceleration constraints for goal.\n:param period: The period between controller updates in seconds. The\n default is 20 milliseconds. Must be positive."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "atGoal",
+ "returnType": "bool",
+ "tooltip": "Returns true if the error is within the tolerance of the error.\n\nThis will return false until at least one input value has been computed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "atSetpoint",
+ "returnType": "bool",
+ "tooltip": "Returns true if the error is within the tolerance of the error.\n\nCurrently this just reports on target as the actual value passes through\nthe setpoint. Ideally it should be based on being within the tolerance for\nsome period of time.\n\nThis will return false until at least one input value has been computed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the next output of the PID controller.\n\n:param measurement: The current measurement of the process variable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.trajectory.TrapezoidProfile.State"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the next output of the PID controller.\n\n:param measurement: The current measurement of the process variable.\n:param goal: The new goal of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the next output of the PID controller.\n\n:param measurement: The current measurement of the process variable.\n:param goal: The new goal of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraints",
+ "type": "wpimath.trajectory.TrapezoidProfile.Constraints"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the next output of the PID controller.\n\n:param measurement: The current measurement of the process variable.\n:param goal: The new goal of the controller.\n:param constraints: Velocity and acceleration constraints for goal."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "disableContinuousInput",
+ "returnType": "None",
+ "tooltip": "Disables continuous input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "minimumInput",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "maximumInput",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "enableContinuousInput",
+ "returnType": "None",
+ "tooltip": "Enables continuous input.\n\nRather then using the max and min input range as constraints, it considers\nthem to be the same point and automatically calculates the shortest route\nto the setpoint.\n\n:param minimumInput: The minimum value expected from the input.\n:param maximumInput: The maximum value expected from the input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getAccumulatedError",
+ "returnType": "float",
+ "tooltip": "Gets the accumulated error used in the integral calculation of this\ncontroller.\n\n:returns: The accumulated error of this controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getConstraints",
+ "returnType": "wpimath.trajectory.TrapezoidProfile.Constraints",
+ "tooltip": "Get the velocity and acceleration constraints for this controller.\n\n:returns: Velocity and acceleration constraints."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getD",
+ "returnType": "float",
+ "tooltip": "Gets the differential coefficient.\n\n:returns: differential coefficient"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getGoal",
+ "returnType": "wpimath.trajectory.TrapezoidProfile.State",
+ "tooltip": "Gets the goal for the ProfiledPIDController."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getI",
+ "returnType": "float",
+ "tooltip": "Gets the integral coefficient.\n\n:returns: integral coefficient"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getIZone",
+ "returnType": "float",
+ "tooltip": "Get the IZone range.\n\n:returns: Maximum magnitude of error to allow integral control."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getP",
+ "returnType": "float",
+ "tooltip": "Gets the proportional coefficient.\n\n:returns: proportional coefficient"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getPeriod",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": "Gets the period of this controller.\n\n:returns: The period of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getPositionError",
+ "returnType": "float",
+ "tooltip": "Returns the difference between the setpoint and the measurement.\n\n:returns: The error."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getPositionTolerance",
+ "returnType": "float",
+ "tooltip": "Gets the position tolerance of this controller.\n\n:returns: The position tolerance of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getSetpoint",
+ "returnType": "wpimath.trajectory.TrapezoidProfile.State",
+ "tooltip": "Returns the current setpoint of the ProfiledPIDController.\n\n:returns: The current setpoint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getVelocityError",
+ "returnType": "wpimath.units.units_per_second",
+ "tooltip": "Returns the change in error per second."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "getVelocityTolerance",
+ "returnType": "float",
+ "tooltip": "Gets the velocity tolerance of this controller.\n\n:returns: The velocity tolerance of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "wpimath.trajectory.TrapezoidProfile.State"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Reset the previous error and the integral term.\n\n:param measurement: The current measured State of the system."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measuredPosition",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "measuredVelocity",
+ "type": "wpimath.units.units_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Reset the previous error and the integral term.\n\n:param measuredPosition: The current measured position of the system.\n:param measuredVelocity: The current measured velocity of the system."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "measuredPosition",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Reset the previous error and the integral term.\n\n:param measuredPosition: The current measured position of the system. The\n velocity is assumed to be zero."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraints",
+ "type": "wpimath.trajectory.TrapezoidProfile.Constraints"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "setConstraints",
+ "returnType": "None",
+ "tooltip": "Set velocity and acceleration constraints for goal.\n\n:param constraints: Velocity and acceleration constraints for goal."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kd",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "setD",
+ "returnType": "None",
+ "tooltip": "Sets the differential coefficient of the PID controller gain.\n\n:param Kd: The differential coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.trajectory.TrapezoidProfile.State"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "setGoal",
+ "returnType": "None",
+ "tooltip": "Sets the goal for the ProfiledPIDController.\n\n:param goal: The desired unprofiled setpoint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "setGoal",
+ "returnType": "None",
+ "tooltip": "Sets the goal for the ProfiledPIDController.\n\n:param goal: The desired unprofiled setpoint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "Ki",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "setI",
+ "returnType": "None",
+ "tooltip": "Sets the integral coefficient of the PID controller gain.\n\n:param Ki: The integral coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "iZone",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "setIZone",
+ "returnType": "None",
+ "tooltip": "Sets the IZone range. When the absolute value of the position error is\ngreater than IZone, the total accumulated error will reset to zero,\ndisabling integral gain until the absolute value of the position error is\nless than IZone. This is used to prevent integral windup. Must be\nnon-negative. Passing a value of zero will effectively disable integral\ngain. Passing a value of infinity disables IZone functionality.\n\n:param iZone: Maximum magnitude of error to allow integral control. Must be\n >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "minimumIntegral",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "maximumIntegral",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "setIntegratorRange",
+ "returnType": "None",
+ "tooltip": "Sets the minimum and maximum contributions of the integral term.\n\nThe internal integrator is clamped so that the integral term's contribution\nto the output stays between minimumIntegral and maximumIntegral. This\nprevents integral windup.\n\n:param minimumIntegral: The minimum contribution of the integral term.\n:param maximumIntegral: The maximum contribution of the integral term."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kp",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "setP",
+ "returnType": "None",
+ "tooltip": "Sets the proportional coefficient of the PID controller gain.\n\n:param Kp: The proportional coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kp",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Ki",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kd",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "setPID",
+ "returnType": "None",
+ "tooltip": "Sets the PID Controller gain parameters.\n\nSets the proportional, integral, and differential coefficients.\n\n:param Kp: The proportional coefficient. Must be >= 0.\n:param Ki: The integral coefficient. Must be >= 0.\n:param Kd: The differential coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDController"
+ },
+ {
+ "defaultValue": null,
+ "name": "positionTolerance",
+ "type": "float"
+ },
+ {
+ "defaultValue": "inf",
+ "name": "velocityTolerance",
+ "type": "wpimath.units.units_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDController",
+ "functionName": "setTolerance",
+ "returnType": "None",
+ "tooltip": "Sets the error which is considered tolerable for use with\nAtSetpoint().\n\n:param positionTolerance: Position error which is tolerable.\n:param velocityTolerance: Velocity error which is tolerable."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.ProfiledPIDControllerRadians",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "Kp",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Ki",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kd",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraints",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians.Constraints"
+ },
+ {
+ "defaultValue": "0.02",
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.ProfiledPIDControllerRadians",
+ "tooltip": "Allocates a ProfiledPIDController with the given constants for Kp, Ki, and\nKd. Users should call reset() when they first start running the controller\nto avoid unwanted behavior.\n\n:param Kp: The proportional coefficient. Must be >= 0.\n:param Ki: The integral coefficient. Must be >= 0.\n:param Kd: The derivative coefficient. Must be >= 0.\n:param constraints: Velocity and acceleration constraints for goal.\n:param period: The period between controller updates in seconds. The\n default is 20 milliseconds. Must be positive."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "atGoal",
+ "returnType": "bool",
+ "tooltip": "Returns true if the error is within the tolerance of the error.\n\nThis will return false until at least one input value has been computed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "atSetpoint",
+ "returnType": "bool",
+ "tooltip": "Returns true if the error is within the tolerance of the error.\n\nCurrently this just reports on target as the actual value passes through\nthe setpoint. Ideally it should be based on being within the tolerance for\nsome period of time.\n\nThis will return false until at least one input value has been computed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the next output of the PID controller.\n\n:param measurement: The current measurement of the process variable."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians.State"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the next output of the PID controller.\n\n:param measurement: The current measurement of the process variable.\n:param goal: The new goal of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the next output of the PID controller.\n\n:param measurement: The current measurement of the process variable.\n:param goal: The new goal of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraints",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians.Constraints"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Returns the next output of the PID controller.\n\n:param measurement: The current measurement of the process variable.\n:param goal: The new goal of the controller.\n:param constraints: Velocity and acceleration constraints for goal."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "disableContinuousInput",
+ "returnType": "None",
+ "tooltip": "Disables continuous input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "minimumInput",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "maximumInput",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "enableContinuousInput",
+ "returnType": "None",
+ "tooltip": "Enables continuous input.\n\nRather then using the max and min input range as constraints, it considers\nthem to be the same point and automatically calculates the shortest route\nto the setpoint.\n\n:param minimumInput: The minimum value expected from the input.\n:param maximumInput: The maximum value expected from the input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getAccumulatedError",
+ "returnType": "float",
+ "tooltip": "Gets the accumulated error used in the integral calculation of this\ncontroller.\n\n:returns: The accumulated error of this controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getConstraints",
+ "returnType": "wpimath.trajectory.TrapezoidProfileRadians.Constraints",
+ "tooltip": "Get the velocity and acceleration constraints for this controller.\n\n:returns: Velocity and acceleration constraints."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getD",
+ "returnType": "float",
+ "tooltip": "Gets the differential coefficient.\n\n:returns: differential coefficient"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getGoal",
+ "returnType": "wpimath.trajectory.TrapezoidProfileRadians.State",
+ "tooltip": "Gets the goal for the ProfiledPIDController."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getI",
+ "returnType": "float",
+ "tooltip": "Gets the integral coefficient.\n\n:returns: integral coefficient"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getIZone",
+ "returnType": "float",
+ "tooltip": "Get the IZone range.\n\n:returns: Maximum magnitude of error to allow integral control."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getP",
+ "returnType": "float",
+ "tooltip": "Gets the proportional coefficient.\n\n:returns: proportional coefficient"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getPeriod",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": "Gets the period of this controller.\n\n:returns: The period of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getPositionError",
+ "returnType": "wpimath.units.radians",
+ "tooltip": "Returns the difference between the setpoint and the measurement.\n\n:returns: The error."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getPositionTolerance",
+ "returnType": "float",
+ "tooltip": "Gets the position tolerance of this controller.\n\n:returns: The position tolerance of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getSetpoint",
+ "returnType": "wpimath.trajectory.TrapezoidProfileRadians.State",
+ "tooltip": "Returns the current setpoint of the ProfiledPIDController.\n\n:returns: The current setpoint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getVelocityError",
+ "returnType": "wpimath.units.radians_per_second",
+ "tooltip": "Returns the change in error per second."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "getVelocityTolerance",
+ "returnType": "float",
+ "tooltip": "Gets the velocity tolerance of this controller.\n\n:returns: The velocity tolerance of the controller."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "builder",
+ "type": "wpiutil.SendableBuilder"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "initSendable",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurement",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians.State"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Reset the previous error and the integral term.\n\n:param measurement: The current measured State of the system."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "measuredPosition",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "measuredVelocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Reset the previous error and the integral term.\n\n:param measuredPosition: The current measured position of the system.\n:param measuredVelocity: The current measured velocity of the system."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "measuredPosition",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Reset the previous error and the integral term.\n\n:param measuredPosition: The current measured position of the system. The\n velocity is assumed to be zero."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraints",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians.Constraints"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "setConstraints",
+ "returnType": "None",
+ "tooltip": "Set velocity and acceleration constraints for goal.\n\n:param constraints: Velocity and acceleration constraints for goal."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kd",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "setD",
+ "returnType": "None",
+ "tooltip": "Sets the differential coefficient of the PID controller gain.\n\n:param Kd: The differential coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians.State"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "setGoal",
+ "returnType": "None",
+ "tooltip": "Sets the goal for the ProfiledPIDController.\n\n:param goal: The desired unprofiled setpoint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "setGoal",
+ "returnType": "None",
+ "tooltip": "Sets the goal for the ProfiledPIDController.\n\n:param goal: The desired unprofiled setpoint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "Ki",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "setI",
+ "returnType": "None",
+ "tooltip": "Sets the integral coefficient of the PID controller gain.\n\n:param Ki: The integral coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "iZone",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "setIZone",
+ "returnType": "None",
+ "tooltip": "Sets the IZone range. When the absolute value of the position error is\ngreater than IZone, the total accumulated error will reset to zero,\ndisabling integral gain until the absolute value of the position error is\nless than IZone. This is used to prevent integral windup. Must be\nnon-negative. Passing a value of zero will effectively disable integral\ngain. Passing a value of infinity disables IZone functionality.\n\n:param iZone: Maximum magnitude of error to allow integral control. Must be\n >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "minimumIntegral",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "maximumIntegral",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "setIntegratorRange",
+ "returnType": "None",
+ "tooltip": "Sets the minimum and maximum contributions of the integral term.\n\nThe internal integrator is clamped so that the integral term's contribution\nto the output stays between minimumIntegral and maximumIntegral. This\nprevents integral windup.\n\n:param minimumIntegral: The minimum contribution of the integral term.\n:param maximumIntegral: The maximum contribution of the integral term."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kp",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "setP",
+ "returnType": "None",
+ "tooltip": "Sets the proportional coefficient of the PID controller gain.\n\n:param Kp: The proportional coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kp",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Ki",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "Kd",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "setPID",
+ "returnType": "None",
+ "tooltip": "Sets the PID Controller gain parameters.\n\nSets the proportional, integral, and differential coefficients.\n\n:param Kp: The proportional coefficient. Must be >= 0.\n:param Ki: The integral coefficient. Must be >= 0.\n:param Kd: The differential coefficient. Must be >= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.ProfiledPIDControllerRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "positionTolerance",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": "inf",
+ "name": "velocityTolerance",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.ProfiledPIDControllerRadians",
+ "functionName": "setTolerance",
+ "returnType": "None",
+ "tooltip": "Sets the error which is considered tolerable for use with\nAtSetpoint().\n\n:param positionTolerance: Position error which is tolerable.\n:param velocityTolerance: Velocity error which is tolerable."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.RamseteController",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "b",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "name": "self",
+ "type": "wpimath.controller.RamseteController"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "poseRef",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "linearVelocityRef",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpimath.controller.RamseteController"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpimath.controller.RamseteController"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpimath.controller.RamseteController"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kS",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_meter"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_meter"
+ },
+ {
+ "defaultValue": "0.02",
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "tooltip": "Creates a new SimpleMotorFeedforward with the specified gains.\n\n:param kS: The static gain, in volts.\n:param kV: The velocity gain, in volt seconds per distance.\n:param kA: The acceleration gain, in volt seconds\u00b2 per distance.\n:param dt: The period in seconds.\n @throws IllegalArgumentException for kv < zero.\n @throws IllegalArgumentException for ka < zero.\n @throws IllegalArgumentException for period ≤ zero."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "functionName": "calculate",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Calculates the feedforward from the gains and velocity setpoint assuming\ndiscrete control. Use this method when the velocity setpoint does not\nchange.\n\n:param velocity: The velocity setpoint.\n\n:returns: The computed feedforward, in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextVelocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "functionName": "calculate",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Calculates the feedforward from the gains and setpoints assuming discrete\ncontrol.\n\nNote this method is inaccurate when the velocity crosses 0.\n\n:param currentVelocity: The current velocity setpoint.\n:param nextVelocity: The next velocity setpoint.\n\n:returns: The computed feedforward, in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "functionName": "getDt",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": "Returns the period.\n\n:returns: The period."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "functionName": "getKa",
+ "returnType": "wpimath.units.volt_seconds_squared_per_meter",
+ "tooltip": "Returns the acceleration gain.\n\n:returns: The acceleration gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "functionName": "getKs",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Returns the static gain.\n\n:returns: The static gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "functionName": "getKv",
+ "returnType": "wpimath.units.volt_seconds_per_meter",
+ "tooltip": "Returns the velocity gain.\n\n:returns: The velocity gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "functionName": "maxAchievableAcceleration",
+ "returnType": "wpimath.units.meters_per_second_squared",
+ "tooltip": "Calculates the maximum achievable acceleration given a maximum voltage\nsupply and a velocity. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the velocity constraint, and this will give you\na simultaneously-achievable acceleration constraint.\n\n:param maxVoltage: The maximum voltage that can be supplied to the motor.\n:param velocity: The velocity of the motor.\n\n:returns: The maximum possible acceleration at the given velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "acceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "functionName": "maxAchievableVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": "Calculates the maximum 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 maximum possible velocity at the given acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "functionName": "minAchievableAcceleration",
+ "returnType": "wpimath.units.meters_per_second_squared",
+ "tooltip": "Calculates the minimum achievable acceleration given a maximum voltage\nsupply and a velocity. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the velocity constraint, and this will give you\na simultaneously-achievable acceleration constraint.\n\n:param maxVoltage: The maximum voltage that can be supplied to the motor.\n:param velocity: The velocity of the motor.\n\n:returns: The minimum possible acceleration at the given velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "acceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardMeters",
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kS",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_radian"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_radian"
+ },
+ {
+ "defaultValue": "0.02",
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "functionName": "__init__",
+ "returnType": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "tooltip": "Creates a new SimpleMotorFeedforward with the specified gains.\n\n:param kS: The static gain, in volts.\n:param kV: The velocity gain, in volt seconds per distance.\n:param kA: The acceleration gain, in volt seconds\u00b2 per distance.\n:param dt: The period in seconds.\n @throws IllegalArgumentException for kv < zero.\n @throws IllegalArgumentException for ka < zero.\n @throws IllegalArgumentException for period ≤ zero."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "functionName": "calculate",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Calculates the feedforward from the gains and velocity setpoint assuming\ndiscrete control. Use this method when the velocity setpoint does not\nchange.\n\n:param velocity: The velocity setpoint.\n\n:returns: The computed feedforward, in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentVelocity",
+ "type": "wpimath.units.radians_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextVelocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "functionName": "calculate",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Calculates the feedforward from the gains and setpoints assuming discrete\ncontrol.\n\nNote this method is inaccurate when the velocity crosses 0.\n\n:param currentVelocity: The current velocity setpoint.\n:param nextVelocity: The next velocity setpoint.\n\n:returns: The computed feedforward, in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "functionName": "getDt",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": "Returns the period.\n\n:returns: The period."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "functionName": "getKa",
+ "returnType": "wpimath.units.volt_seconds_squared_per_radian",
+ "tooltip": "Returns the acceleration gain.\n\n:returns: The acceleration gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "functionName": "getKs",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Returns the static gain.\n\n:returns: The static gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardRadians"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "functionName": "getKv",
+ "returnType": "wpimath.units.volt_seconds_per_radian",
+ "tooltip": "Returns the velocity gain.\n\n:returns: The velocity gain."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "functionName": "maxAchievableAcceleration",
+ "returnType": "wpimath.units.radians_per_second_squared",
+ "tooltip": "Calculates the maximum achievable acceleration given a maximum voltage\nsupply and a velocity. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the velocity constraint, and this will give you\na simultaneously-achievable acceleration constraint.\n\n:param maxVoltage: The maximum voltage that can be supplied to the motor.\n:param velocity: The velocity of the motor.\n\n:returns: The maximum possible acceleration at the given velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "acceleration",
+ "type": "wpimath.units.radians_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "functionName": "maxAchievableVelocity",
+ "returnType": "wpimath.units.radians_per_second",
+ "tooltip": "Calculates the maximum 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 maximum possible velocity at the given acceleration."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "functionName": "minAchievableAcceleration",
+ "returnType": "wpimath.units.radians_per_second_squared",
+ "tooltip": "Calculates the minimum achievable acceleration given a maximum voltage\nsupply and a velocity. Useful for ensuring that velocity and\nacceleration constraints for a trapezoidal profile are simultaneously\nachievable - enter the velocity constraint, and this will give you\na simultaneously-achievable acceleration constraint.\n\n:param maxVoltage: The maximum voltage that can be supplied to the motor.\n:param velocity: The velocity of the motor.\n\n:returns: The minimum possible acceleration at the given velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.controller.SimpleMotorFeedforwardRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "acceleration",
+ "type": "wpimath.units.radians_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.controller.SimpleMotorFeedforwardRadians",
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.controller",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.DifferentialDrivePoseEstimator",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.DifferentialDrivePoseEstimator",
+ "tooltip": "Constructs a DifferentialDrivePoseEstimator with default standard\ndeviations for the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.02 meters for x, 0.02 meters for y, and 0.01 radians for heading.\nThe default standard deviations of the vision measurements are\n0.1 meters for x, 0.1 meters for y, and 0.1 radians for heading.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The gyro angle of the robot.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n:param initialPose: The estimated initial pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.DifferentialDrivePoseEstimator",
+ "tooltip": "Constructs a DifferentialDrivePoseEstimator.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The gyro angle of the robot.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n:param initialPose: The estimated initial pose.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\n:param gyroAngle: The current gyro angle.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n\n:returns: The estimated pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n\n:returns: The estimated pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.DifferentialDrivePoseEstimator3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.DifferentialDrivePoseEstimator3d",
+ "tooltip": "Constructs a DifferentialDrivePoseEstimator3d with default standard\ndeviations for the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.02 meters for x, 0.02 meters for y, 0.02 meters for z, and 0.01 radians\nfor angle. The default standard deviations of the vision measurements are\n0.1 meters for x, 0.1 meters for y, 0.1 meters for z, and 0.1 radians for\nangle.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The gyro angle of the robot.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n:param initialPose: The estimated initial pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.DifferentialDrivePoseEstimator3d",
+ "tooltip": "Constructs a DifferentialDrivePoseEstimator3d.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The gyro angle of the robot.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n:param initialPose: The estimated initial pose.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, z position in meters, and angle in\n radians). Increase these numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, z position in\n meters, and angle in radians). Increase these numbers to trust the vision\n pose measurement less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3d",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\n:param gyroAngle: The current gyro angle.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3d",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n\n:returns: The estimated pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3d",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n\n:returns: The estimated pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "tooltip": "Constructs a PoseEstimator3d.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and z position\n in meters, and angle in radians). Increase these numbers to trust the\n vision pose measurement less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "tooltip": "Constructs a PoseEstimator.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.DifferentialDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "h",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurementStdDevs",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "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": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "h",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurementStdDevs",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "residualFuncY",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "addFuncX",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "functionName": "P",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the observer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "P",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "functionName": "setP",
+ "returnType": "None",
+ "tooltip": "Set the current error covariance matrix P.\n\n:param P: The error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "functionName": "setXhat",
+ "returnType": "None",
+ "tooltip": "Set initial state estimate x-hat.\n\n:param xHat: The state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_1_1_1",
+ "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_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "h",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurementStdDevs",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "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": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "h",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurementStdDevs",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "residualFuncY",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]], numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "addFuncX",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "functionName": "P",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the observer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "P",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "functionName": "setP",
+ "returnType": "None",
+ "tooltip": "Set the current error covariance matrix P.\n\n:param P: The error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "functionName": "setXhat",
+ "returnType": "None",
+ "tooltip": "Set initial state estimate x-hat.\n\n:param xHat: The state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_1_1",
+ "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": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "h",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurementStdDevs",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.ExtendedKalmanFilter_2_2_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": null,
+ "name": "f",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "h",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurementStdDevs",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "residualFuncY",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "addFuncX",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]], numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.ExtendedKalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2",
+ "functionName": "P",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the observer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "P",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2",
+ "functionName": "setP",
+ "returnType": "None",
+ "tooltip": "Set the current error covariance matrix P.\n\n:param P: The error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2",
+ "functionName": "setXhat",
+ "returnType": "None",
+ "tooltip": "Set initial state estimate x-hat.\n\n:param xHat: The state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_2",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.ExtendedKalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.ExtendedKalmanFilter_2_2_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_1_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurementStdDevs",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.KalmanFilter_1_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "functionName": "P",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the observer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "P",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "functionName": "setP",
+ "returnType": "None",
+ "tooltip": "Set the current error covariance matrix P.\n\n:param P: The error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "functionName": "setXhat",
+ "returnType": "None",
+ "tooltip": "Set initial state estimate x-hat.\n\n:param xHat: The state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_1_1_1",
+ "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_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurementStdDevs",
+ "type": "Tuple[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.KalmanFilter_2_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "functionName": "P",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the observer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "P",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "functionName": "setP",
+ "returnType": "None",
+ "tooltip": "Set the current error covariance matrix P.\n\n:param P: The error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "functionName": "setXhat",
+ "returnType": "None",
+ "tooltip": "Set initial state estimate x-hat.\n\n:param xHat: The state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_1_1",
+ "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": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurementStdDevs",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.KalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2",
+ "functionName": "P",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the observer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "P",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2",
+ "functionName": "setP",
+ "returnType": "None",
+ "tooltip": "Set the current error covariance matrix P.\n\n:param P: The error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2",
+ "functionName": "setXhat",
+ "returnType": "None",
+ "tooltip": "Set initial state estimate x-hat.\n\n:param xHat: The state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_2",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_2_2_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_3_2_3",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "measurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.KalmanFilter_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "functionName": "P",
+ "returnType": "numpy.ndarray[numpy.float64[3, 3]]",
+ "tooltip": "Returns the error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "R",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the observer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "P",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "functionName": "setP",
+ "returnType": "None",
+ "tooltip": "Set the current error covariance matrix P.\n\n:param P: The error covariance matrix P."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "functionName": "setXhat",
+ "returnType": "None",
+ "tooltip": "Set initial state estimate x-hat.\n\n:param xHat: The state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns the state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.KalmanFilter_3_2_3",
+ "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.MecanumDrivePoseEstimator",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.MecanumDrivePoseEstimator",
+ "tooltip": "Constructs a MecanumDrivePoseEstimator with default standard deviations\nfor the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.1 meters for x, 0.1 meters for y, and 0.1 radians for heading.\nThe default standard deviations of the vision measurements are\n0.45 meters for x, 0.45 meters for y, and 0.45 radians for heading.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distance measured by each wheel.\n:param initialPose: The starting pose estimate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.MecanumDrivePoseEstimator",
+ "tooltip": "Constructs a MecanumDrivePoseEstimator.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distance measured by each wheel.\n:param initialPose: The starting pose estimate.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.MecanumDrivePoseEstimator3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.MecanumDrivePoseEstimator3d",
+ "tooltip": "Constructs a MecanumDrivePoseEstimator3d with default standard deviations\nfor the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.1 meters for x, 0.1 meters for y, 0.1 meters for z, and 0.1 radians for\nangle. The default standard deviations of the vision measurements are 0.45\nmeters for x, 0.45 meters for y, 0.45 meters for z, and 0.45 radians for\nangle.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distance measured by each wheel.\n:param initialPose: The starting pose estimate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.MecanumDrivePoseEstimator3d",
+ "tooltip": "Constructs a MecanumDrivePoseEstimator3d.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distance measured by each wheel.\n:param initialPose: The starting pose estimate.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, z position in meters, and angle in\n radians). Increase these numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, z position in\n meters, and angle in radians). Increase these numbers to trust the vision\n pose measurement less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "tooltip": "Constructs a PoseEstimator3d.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and z position\n in meters, and angle in radians). Increase these numbers to trust the\n vision pose measurement less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "tooltip": "Constructs a PoseEstimator.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.MecanumDrivePoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive2PoseEstimator",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive2PoseEstimator",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator with default standard deviations\nfor the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.1 meters for x, 0.1 meters for y, and 0.1 radians for heading.\nThe default standard deviations of the vision measurements are\n0.9 meters for x, 0.9 meters for y, and 0.9 radians for heading.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive2PoseEstimator",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive2PoseEstimator3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive2PoseEstimator3d",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator3d with default standard deviations\nfor the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.1 meters for x, 0.1 meters for y, 0.1 meters for z, and 0.1 radians for\nangle. The default standard deviations of the vision measurements are 0.9\nmeters for x, 0.9 meters for y, 0.9 meters for z, and 0.9 radians for\nangle.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive2PoseEstimator3d",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator3d.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "tooltip": "Constructs a PoseEstimator3d.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and z position\n in meters, and angle in radians). Increase these numbers to trust the\n vision pose measurement less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "tooltip": "Constructs a PoseEstimator.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive2PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive3PoseEstimator",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive3PoseEstimator",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator with default standard deviations\nfor the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.1 meters for x, 0.1 meters for y, and 0.1 radians for heading.\nThe default standard deviations of the vision measurements are\n0.9 meters for x, 0.9 meters for y, and 0.9 radians for heading.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive3PoseEstimator",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive3PoseEstimator3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive3PoseEstimator3d",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator3d with default standard deviations\nfor the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.1 meters for x, 0.1 meters for y, 0.1 meters for z, and 0.1 radians for\nangle. The default standard deviations of the vision measurements are 0.9\nmeters for x, 0.9 meters for y, 0.9 meters for z, and 0.9 radians for\nangle.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive3PoseEstimator3d",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator3d.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "tooltip": "Constructs a PoseEstimator3d.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and z position\n in meters, and angle in radians). Increase these numbers to trust the\n vision pose measurement less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "tooltip": "Constructs a PoseEstimator.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive3PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive4PoseEstimator",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive4PoseEstimator",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator with default standard deviations\nfor the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.1 meters for x, 0.1 meters for y, and 0.1 radians for heading.\nThe default standard deviations of the vision measurements are\n0.9 meters for x, 0.9 meters for y, and 0.9 radians for heading.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive4PoseEstimator",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive4PoseEstimator3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive4PoseEstimator3d",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator3d with default standard deviations\nfor the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.1 meters for x, 0.1 meters for y, 0.1 meters for z, and 0.1 radians for\nangle. The default standard deviations of the vision measurements are 0.9\nmeters for x, 0.9 meters for y, 0.9 meters for z, and 0.9 radians for\nangle.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive4PoseEstimator3d",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator3d.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "tooltip": "Constructs a PoseEstimator3d.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and z position\n in meters, and angle in radians). Increase these numbers to trust the\n vision pose measurement less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "tooltip": "Constructs a PoseEstimator.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive4PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive6PoseEstimator",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive6PoseEstimator",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator with default standard deviations\nfor the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.1 meters for x, 0.1 meters for y, and 0.1 radians for heading.\nThe default standard deviations of the vision measurements are\n0.9 meters for x, 0.9 meters for y, and 0.9 radians for heading.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive6PoseEstimator",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive6PoseEstimator3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive6PoseEstimator3d",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator3d with default standard deviations\nfor the model and vision measurements.\n\nThe default standard deviations of the model states are\n0.1 meters for x, 0.1 meters for y, 0.1 meters for z, and 0.1 radians for\nangle. The default standard deviations of the vision measurements are 0.9\nmeters for x, 0.9 meters for y, 0.9 meters for z, and 0.9 radians for\nangle.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive6PoseEstimator3d",
+ "tooltip": "Constructs a SwerveDrivePoseEstimator3d.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param gyroAngle: The current gyro angle.\n:param modulePositions: The current distance and rotation measurements of\n the swerve modules.\n:param initialPose: The starting pose estimate.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "tooltip": "Constructs a PoseEstimator3d.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and z position\n in meters, and angle in radians). Increase these numbers to trust the\n vision pose measurement less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetFPGATimestamp(). This means that you should use\n frc::Timer::GetFPGATimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "odometry",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "stateStdDevs",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "tooltip": "Constructs a PoseEstimator.\n\n@warning The initial pose estimate will always be the default pose,\nregardless of the odometry's current pose.\n\n:param kinematics: A correctly-configured kinematics object for your\n drivetrain.\n:param odometry: A correctly-configured odometry object for your drivetrain.\n:param stateStdDevs: Standard deviations of the pose estimate (x position in\n meters, y position in meters, and heading in radians). Increase these\n numbers to trust your state estimate less.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionRobotPose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "addVisionMeasurement",
+ "returnType": "None",
+ "tooltip": "Adds a vision measurement to the Kalman Filter. This will correct\nthe odometry pose estimate while still accounting for measurement noise.\n\nThis method can be called as infrequently as you want, as long as you are\ncalling Update() every loop.\n\nTo promote stability of the pose estimate and make it robust to bad vision\ndata, we recommend only adding vision measurements that are already within\none meter or so of the current pose estimate.\n\nNote that the vision measurement standard deviations passed into this\nmethod will continue to apply to future measurements until a subsequent\ncall to SetVisionMeasurementStdDevs() or this method.\n\n:param visionRobotPose: The pose of the robot as measured by the vision\n camera.\n:param timestamp: The timestamp of the vision measurement in seconds. Note\n that if you don't use your own time source by calling UpdateWithTime(),\n then you must use a timestamp with an epoch since FPGA startup (i.e.,\n the epoch of this timestamp is the same epoch as\n frc::Timer::GetTimestamp(). This means that you should use\n frc::Timer::GetTimestamp() as your time source in this case.\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "getEstimatedPosition",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Gets the estimated robot pose.\n\n:returns: The estimated robot pose in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the robot's pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset in the user's robot code.\nThe library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n:param pose: The estimated pose of the robot on the field."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's rotation.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the robot's translation.\n\n:param translation: The pose to translation to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "timestamp",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "sampleAt",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Return the pose at a given timestamp, if the buffer is not empty.\n\n:param timestamp: The pose's timestamp.\n\n:returns: The pose at the given timestamp (or std::nullopt if the buffer is\n empty)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "visionMeasurementStdDevs",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "setVisionMeasurementStdDevs",
+ "returnType": "None",
+ "tooltip": "Sets the pose estimator's trust in vision measurements. This might be used\nto change trust in vision measurements after the autonomous period, or to\nchange trust as distance to a vision target increases.\n\n:param visionMeasurementStdDevs: Standard deviations of the vision pose\n measurement (x position in meters, y position in meters, and heading in\n radians). Increase these numbers to trust the vision pose measurement\n less."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.estimator.SwerveDrive6PoseEstimatorBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "functionName": "updateWithTime",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the pose estimator with wheel encoder and gyro information. This\nshould be called every loop.\n\n:param currentTime: The time at which this method was called.\n:param gyroAngle: The current gyro angle.\n:param wheelPositions: The distances traveled by the encoders.\n\n:returns: The estimated pose of the robot in meters."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.estimator",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.filter.Debouncer",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "debounceTime",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": "",
+ "name": "type",
+ "type": "wpimath.filter.Debouncer.DebounceType"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.Debouncer",
+ "functionName": "__init__",
+ "returnType": "wpimath.filter.Debouncer",
+ "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."
+ }
+ ],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.Debouncer"
+ },
+ {
+ "defaultValue": null,
+ "name": "input",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.Debouncer",
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.filter",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.filter.LinearFilter",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "ffGains",
+ "type": "List[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "fbGains",
+ "type": "List[float]"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.LinearFilter",
+ "functionName": "__init__",
+ "returnType": "wpimath.filter.LinearFilter",
+ "tooltip": "Create a linear FIR or IIR filter.\n\n:param ffGains: The \"feedforward\" or FIR gains.\n:param fbGains: The \"feedback\" or IIR gains."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.LinearFilter"
+ },
+ {
+ "defaultValue": null,
+ "name": "input",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.LinearFilter",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Calculates the next value of the filter.\n\n:param input: Current input value.\n\n:returns: The filtered value at this step"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.LinearFilter"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.LinearFilter",
+ "functionName": "lastValue",
+ "returnType": "float",
+ "tooltip": "Returns the last value calculated by the LinearFilter.\n\n:returns: The last value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.LinearFilter"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.LinearFilter",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Reset the filter state."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.LinearFilter"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputBuffer",
+ "type": "List[float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputBuffer",
+ "type": "List[float]"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.LinearFilter",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the filter state, initializing internal buffers to the provided\nvalues.\n\nThese are the expected lengths of the buffers, depending on what type of\nlinear filter used:\n\n\n\n| Type | \nInput Buffer Size | \nOutput Buffer Size | \n
\n\n| Unspecified | \nsize of ``ffGains`` | \nsize of ``fbGains`` | \n
\n\n| Single Pole IIR | \n1 | \n1 | \n
\n\n| High-Pass | \n2 | \n1 | \n
\n\n| Moving Average | \n``taps`` | \n0 | \n
\n\n| Finite Difference | \nsize of ``stencil`` | \n0 | \n
\n\n| Backward Finite Difference | \n``Samples`` | \n0 | \n
\n
\n\n:param inputBuffer: Values to initialize input buffer.\n:param outputBuffer: Values to initialize output buffer.\n @throws std::runtime_error if size of inputBuffer or outputBuffer does not\n match the size of ffGains and fbGains provided in the constructor."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.filter",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "timeConstant",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.LinearFilter",
+ "functionName": "highPass",
+ "returnType": "wpimath.filter.LinearFilter",
+ "tooltip": "Creates a first-order high-pass filter of the form:\ny[n] = gain x[n] + (-gain) x[n-1] + gain y[n-1]\nwhere gain = e:sup:`-dt / T`, T is the time constant in seconds\n\nNote: T = 1 / (2\u03c0f) where f is the cutoff frequency in Hz, the frequency\nbelow which the input starts to attenuate.\n\nThis filter is stable for time constants greater than zero.\n\n:param timeConstant: The discrete-time time constant in seconds.\n:param period: The period in seconds between samples taken by the\n user."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "taps",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.LinearFilter",
+ "functionName": "movingAverage",
+ "returnType": "wpimath.filter.LinearFilter",
+ "tooltip": "Creates a K-tap FIR moving average filter of the form:\ny[n] = 1/k (x[k] + x[k-1] + \u2026 + x[0])\n\nThis filter is always stable.\n\n:param taps: The number of samples to average over. Higher = smoother but\n slower\n @throws std::runtime_error if number of taps is less than 1."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "timeConstant",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.LinearFilter",
+ "functionName": "singlePoleIIR",
+ "returnType": "wpimath.filter.LinearFilter",
+ "tooltip": "Creates a one-pole IIR low-pass filter of the form:\ny[n] = (1 - gain) x[n] + gain y[n-1]\nwhere gain = e:sup:`-dt / T`, T is the time constant in seconds\n\nNote: T = 1 / (2\u03c0f) where f is the cutoff frequency in Hz, the frequency\nabove which the input starts to attenuate.\n\nThis filter is stable for time constants greater than zero.\n\n:param timeConstant: The discrete-time time constant in seconds.\n:param period: The period in seconds between samples taken by the\n user."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.filter.MedianFilter",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "size",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.MedianFilter",
+ "functionName": "__init__",
+ "returnType": "wpimath.filter.MedianFilter",
+ "tooltip": "Creates a new MedianFilter.\n\n:param size: The number of samples in the moving window."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.MedianFilter"
+ },
+ {
+ "defaultValue": null,
+ "name": "next",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.MedianFilter",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Calculates the moving-window median for the next value of the input stream.\n\n:param next: The next input value.\n\n:returns: The median of the moving window, updated to include the next value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.MedianFilter"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.MedianFilter",
+ "functionName": "lastValue",
+ "returnType": "float",
+ "tooltip": "Returns the last value calculated by the MedianFilter.\n\n:returns: The last value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.MedianFilter"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.MedianFilter",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the filter, clearing the window of all elements."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.filter",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.filter.SlewRateLimiter",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "positiveRateLimit",
+ "type": "wpimath.units.units_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "negativeRateLimit",
+ "type": "wpimath.units.units_per_second"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "initialValue",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.SlewRateLimiter",
+ "functionName": "__init__",
+ "returnType": "wpimath.filter.SlewRateLimiter",
+ "tooltip": "Creates a new SlewRateLimiter with the given positive and negative rate\nlimits and initial value.\n\n:param positiveRateLimit: The rate-of-change limit in the positive\n direction, in units per second. This is expected\n to be positive.\n:param negativeRateLimit: The rate-of-change limit in the negative\n direction, in units per second. This is expected\n to be negative.\n:param initialValue: The initial value of the input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "rateLimit",
+ "type": "wpimath.units.units_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.SlewRateLimiter",
+ "functionName": "__init__",
+ "returnType": "wpimath.filter.SlewRateLimiter",
+ "tooltip": "Creates a new SlewRateLimiter with the given positive rate limit and\nnegative rate limit of -rateLimit.\n\n:param rateLimit: The rate-of-change limit."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.SlewRateLimiter"
+ },
+ {
+ "defaultValue": null,
+ "name": "input",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.SlewRateLimiter",
+ "functionName": "calculate",
+ "returnType": "float",
+ "tooltip": "Filters the input to limit its slew rate.\n\n:param input: The input value whose slew rate is to be limited.\n\n:returns: The filtered value, which will not change faster than the slew\n rate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.SlewRateLimiter"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.SlewRateLimiter",
+ "functionName": "lastValue",
+ "returnType": "float",
+ "tooltip": "Returns the value last calculated by the SlewRateLimiter.\n\n:returns: The last value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.filter.SlewRateLimiter"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.filter.SlewRateLimiter",
+ "functionName": "reset",
+ "returnType": "None",
+ "tooltip": "Resets the slew rate limiter to the specified value; ignores the rate limit\nwhen doing so.\n\n:param value: The value to reset to."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.filter",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.geometry.CoordinateAxis",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "z",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.CoordinateAxis",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.CoordinateAxis",
+ "tooltip": "Constructs a coordinate system axis within the NWU coordinate system and\nnormalizes it.\n\n:param x: The x component.\n:param y: The y component.\n:param z: The z component."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.CoordinateAxis",
+ "functionName": "D",
+ "returnType": "wpimath.geometry.CoordinateAxis",
+ "tooltip": "Returns a coordinate axis corresponding to -Z in the NWU coordinate system."
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.CoordinateAxis",
+ "functionName": "E",
+ "returnType": "wpimath.geometry.CoordinateAxis",
+ "tooltip": "Returns a coordinate axis corresponding to -Y in the NWU coordinate system."
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.CoordinateAxis",
+ "functionName": "N",
+ "returnType": "wpimath.geometry.CoordinateAxis",
+ "tooltip": "Returns a coordinate axis corresponding to +X in the NWU coordinate system."
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.CoordinateAxis",
+ "functionName": "S",
+ "returnType": "wpimath.geometry.CoordinateAxis",
+ "tooltip": "Returns a coordinate axis corresponding to -X in the NWU coordinate system."
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.CoordinateAxis",
+ "functionName": "U",
+ "returnType": "wpimath.geometry.CoordinateAxis",
+ "tooltip": "Returns a coordinate axis corresponding to +Z in the NWU coordinate system."
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.CoordinateAxis",
+ "functionName": "W",
+ "returnType": "wpimath.geometry.CoordinateAxis",
+ "tooltip": "Returns a coordinate axis corresponding to +Y in the NWU coordinate system."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.CoordinateSystem",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "positiveX",
+ "type": "wpimath.geometry.CoordinateAxis"
+ },
+ {
+ "defaultValue": null,
+ "name": "positiveY",
+ "type": "wpimath.geometry.CoordinateAxis"
+ },
+ {
+ "defaultValue": null,
+ "name": "positiveZ",
+ "type": "wpimath.geometry.CoordinateAxis"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.CoordinateSystem",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.CoordinateSystem",
+ "tooltip": "Constructs a coordinate system with the given cardinal directions for each\naxis.\n\n:param positiveX: The cardinal direction of the positive x-axis.\n:param positiveY: The cardinal direction of the positive y-axis.\n:param positiveZ: The cardinal direction of the positive z-axis.\n @throws std::domain_error if the coordinate system isn't special orthogonal"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.CoordinateSystem",
+ "functionName": "EDN",
+ "returnType": "wpimath.geometry.CoordinateSystem",
+ "tooltip": "Returns an instance of the East-Down-North (EDN) coordinate system.\n\nThe +X axis is east, the +Y axis is down, and the +Z axis is north."
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.CoordinateSystem",
+ "functionName": "NED",
+ "returnType": "wpimath.geometry.CoordinateSystem",
+ "tooltip": "Returns an instance of the NED coordinate system.\n\nThe +X axis is north, the +Y axis is east, and the +Z axis is down."
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.CoordinateSystem",
+ "functionName": "NWU",
+ "returnType": "wpimath.geometry.CoordinateSystem",
+ "tooltip": "Returns an instance of the North-West-Up (NWU) coordinate system.\n\nThe +X axis is north, the +Y axis is west, and the +Z axis is up."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "from_",
+ "type": "wpimath.geometry.CoordinateSystem"
+ },
+ {
+ "defaultValue": null,
+ "name": "to",
+ "type": "wpimath.geometry.CoordinateSystem"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.CoordinateSystem",
+ "functionName": "convert",
+ "returnType": "wpimath.geometry.Translation3d",
+ "tooltip": "Converts the given translation from one coordinate system to another.\n\n:param translation: The translation to convert.\n:param from_: The coordinate system the translation starts in.\n:param to: The coordinate system to which to convert.\n\n:returns: The given translation in the desired coordinate system."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "from_",
+ "type": "wpimath.geometry.CoordinateSystem"
+ },
+ {
+ "defaultValue": null,
+ "name": "to",
+ "type": "wpimath.geometry.CoordinateSystem"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.CoordinateSystem",
+ "functionName": "convert",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Converts the given rotation from one coordinate system to another.\n\n:param rotation: The rotation to convert.\n:param from_: The coordinate system the rotation starts in.\n:param to: The coordinate system to which to convert.\n\n:returns: The given rotation in the desired coordinate system."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "from_",
+ "type": "wpimath.geometry.CoordinateSystem"
+ },
+ {
+ "defaultValue": null,
+ "name": "to",
+ "type": "wpimath.geometry.CoordinateSystem"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.CoordinateSystem",
+ "functionName": "convert",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Converts the given pose from one coordinate system to another.\n\n:param pose: The pose to convert.\n:param from_: The coordinate system the pose starts in.\n:param to: The coordinate system to which to convert.\n\n:returns: The given pose in the desired coordinate system."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "transform",
+ "type": "wpimath.geometry.Transform3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "from_",
+ "type": "wpimath.geometry.CoordinateSystem"
+ },
+ {
+ "defaultValue": null,
+ "name": "to",
+ "type": "wpimath.geometry.CoordinateSystem"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.CoordinateSystem",
+ "functionName": "convert",
+ "returnType": "wpimath.geometry.Transform3d",
+ "tooltip": "Converts the given transform from one coordinate system to another.\n\n:param transform: The transform to convert.\n:param from_: The coordinate system the transform starts in.\n:param to: The coordinate system to which to convert.\n\n:returns: The given transform in the desired coordinate system."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Ellipse2d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "xSemiAxis",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "ySemiAxis",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Ellipse2d",
+ "tooltip": "Constructs an ellipse around a center point and two semi-axes, a horizontal\nand vertical one.\n\n:param center: The center of the ellipse.\n:param xSemiAxis: The x semi-axis.\n:param ySemiAxis: The y semi-axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "radius",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Ellipse2d",
+ "tooltip": "Constructs a perfectly circular ellipse with the specified radius.\n\n:param center: The center of the circle.\n:param radius: The radius of the circle."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Ellipse2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "center",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the center of the ellipse.\n\n:returns: The center of the ellipse."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Ellipse2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "point",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "contains",
+ "returnType": "bool",
+ "tooltip": "Checks if a point is contained within this ellipse. This is inclusive, if\nthe point lies on the circumference this will return ``true``.\n\n:param point: The point to check.\n\n:returns: True, if the point is within or on the ellipse."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Ellipse2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "point",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "distance",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the distance between the perimeter of the ellipse and the point.\n\n:param point: The point to check.\n\n:returns: The distance (0, if the point is contained by the ellipse)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Ellipse2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "focalPoints",
+ "returnType": "Tuple[wpimath.geometry.Translation2d, wpimath.geometry.Translation2d]",
+ "tooltip": "Returns the focal points of the ellipse. In a perfect circle, this will\nalways return the center.\n\n:returns: The focal points."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Ellipse2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "point",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "intersects",
+ "returnType": "bool",
+ "tooltip": "Checks if a point is intersected by this ellipse's circumference.\n\n:param point: The point to check.\n\n:returns: True, if this ellipse's circumference intersects the point."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Ellipse2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "point",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "nearest",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Returns the nearest point that is contained within the ellipse.\n\n:param point: The point that this will find the nearest point to.\n\n:returns: A new point that is nearest to ``point`` and contained in the\n ellipse."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Ellipse2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "rotateBy",
+ "returnType": "wpimath.geometry.Ellipse2d",
+ "tooltip": "Rotates the center of the ellipse and returns the new ellipse.\n\n:param other: The rotation to transform by.\n\n:returns: The rotated ellipse."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Ellipse2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "rotation",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Returns the rotational component of the ellipse.\n\n:returns: The rotational component of the ellipse."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Ellipse2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "transformBy",
+ "returnType": "wpimath.geometry.Ellipse2d",
+ "tooltip": "Transforms the center of the ellipse and returns the new ellipse.\n\n:param other: The transform to transform by.\n\n:returns: The transformed ellipse."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "xsemiaxis",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "xsemiaxis_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "ysemiaxis",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "ysemiaxis_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "xSemiAxis",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "ySemiAxis",
+ "type": "wpimath.units.feet"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Ellipse2d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Ellipse2d",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Pose2d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Constructs a pose at the origin facing toward the positive X axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Constructs a pose with the specified translation and rotation.\n\n:param translation: The translational component of the pose.\n:param rotation: The rotational component of the pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Constructs a pose with x and y translations instead of a separate\nTranslation2d.\n\n:param x: The x component of the translational component of the pose.\n:param y: The y component of the translational component of the pose.\n:param rotation: The rotational component of the pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "X",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the X component of the pose's translation.\n\n:returns: The x component of the pose's translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "Y",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the Y component of the pose's translation.\n\n:returns: The y component of the pose's translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "twist",
+ "type": "wpimath.geometry.Twist2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "exp",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Obtain a new Pose2d from a (constant curvature) velocity.\n\nSee https://file.tavsys.net/control/controls-engineering-in-frc.pdf section\n10.2 \"Pose exponential\" for a derivation.\n\nThe twist is a change in pose in the robot's coordinate frame since the\nprevious pose update. When the user runs exp() on the previous known\nfield-relative pose with the argument being the twist, the user will\nreceive the new field-relative pose.\n\n\"Exp\" represents the pose exponential, which is solving a differential\nequation moving the pose forward in time.\n\n:param twist: The change in pose in the robot's coordinate frame since the\n previous pose update. For example, if a non-holonomic robot moves forward\n 0.01 meters and changes angle by 0.5 degrees since the previous pose\n update, the twist would be Twist2d{0.01_m, 0_m, 0.5_deg}.\n\n:returns: The new pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "log",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Returns a Twist2d 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": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "poses",
+ "type": "List[wpimath.geometry.Pose2d]"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "relativeTo",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "rotateBy",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Rotates the pose around the origin and returns the new pose.\n\n:param other: The rotation to transform the pose by.\n\n:returns: The rotated pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "rotation",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Returns the underlying rotation.\n\n:returns: Reference to the rotational component of the pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "toMatrix",
+ "returnType": "numpy.ndarray[numpy.float64[3, 3]]",
+ "tooltip": "Returns an affine transformation matrix representation of this pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "transformBy",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Transforms the pose by the given transformation and returns the new pose.\nSee + operator for the matrix multiplication performed.\n\n:param other: The transform to transform the pose by.\n\n:returns: The transformed pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "translation",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Returns the underlying translation.\n\n:returns: Reference to the translational component of the pose."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "x",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "x_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "y",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "y_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "matrix",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose2d",
+ "functionName": "fromMatrix",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Constructs a pose with the specified affine transformation matrix.\n\n:param matrix: The affine transformation matrix.\n @throws std::domain_error if the affine transformation matrix is invalid."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Pose3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Constructs a pose at the origin facing toward the positive X axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Constructs a pose with the specified translation and rotation.\n\n:param translation: The translational component of the pose.\n:param rotation: The rotational component of the pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "z",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Constructs a pose with x, y, and z translations instead of a separate\nTranslation3d.\n\n:param x: The x component of the translational component of the pose.\n:param y: The y component of the translational component of the pose.\n:param z: The z component of the translational component of the pose.\n:param rotation: The rotational component of the pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Constructs a 3D pose from a 2D pose in the X-Y plane.\n\n:param pose: The 2D pose.\n @see Rotation3d(Rotation2d)\n @see Translation3d(Translation2d)"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "X",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the X component of the pose's translation.\n\n:returns: The x component of the pose's translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "Y",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the Y component of the pose's translation.\n\n:returns: The y component of the pose's translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "Z",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the Z component of the pose's translation.\n\n:returns: The z component of the pose's translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "twist",
+ "type": "wpimath.geometry.Twist3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "exp",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Obtain a new Pose3d from a (constant curvature) velocity.\n\nThe twist is a change in pose in the robot's coordinate frame since the\nprevious pose update. When the user runs exp() on the previous known\nfield-relative pose with the argument being the twist, the user will\nreceive the new field-relative pose.\n\n\"Exp\" represents the pose exponential, which is solving a differential\nequation moving the pose forward in time.\n\n:param twist: The change in pose in the robot's coordinate frame since the\n previous pose update. For example, if a non-holonomic robot moves forward\n 0.01 meters and changes angle by 0.5 degrees since the previous pose\n update, the twist would be Twist3d{0.01_m, 0_m, 0_m, Rotation3d{0.0, 0.0,\n 0.5_deg}}.\n\n:returns: The new pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "log",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "relativeTo",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "rotateBy",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Rotates the pose around the origin and returns the new pose.\n\n:param other: The rotation to transform the pose by, which is applied\n extrinsically (from the global frame).\n\n:returns: The rotated pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "rotation",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Returns the underlying rotation.\n\n:returns: Reference to the rotational component of the pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "toMatrix",
+ "returnType": "numpy.ndarray[numpy.float64[4, 4]]",
+ "tooltip": "Returns an affine transformation matrix representation of this pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "toPose2d",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns a Pose2d representing this Pose3d projected into the X-Y plane."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Transform3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "transformBy",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Transforms the pose by the given transformation and returns the new\ntransformed pose. The transform is applied relative to the pose's frame.\nNote that this differs from Pose3d::RotateBy(const Rotation3d&), which is\napplied relative to the global frame and around the origin.\n\n:param other: The transform to transform the pose by.\n\n:returns: The transformed pose."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "translation",
+ "returnType": "wpimath.geometry.Translation3d",
+ "tooltip": "Returns the underlying translation.\n\n:returns: Reference to the translational component of the pose."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "x",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "x_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "y",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "y_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "z",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "z_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "z",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "matrix",
+ "type": "numpy.ndarray[numpy.float64[4, 4]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Pose3d",
+ "functionName": "fromMatrix",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Constructs a pose with the specified affine transformation matrix.\n\n:param matrix: The affine transformation matrix.\n @throws std::domain_error if the affine transformation matrix is invalid."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Quaternion",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Constructs a quaternion with a default angle of 0 degrees."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "w",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "z",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Constructs a quaternion with the given components.\n\n:param w: W component of the quaternion.\n:param x: X component of the quaternion.\n:param y: Y component of the quaternion.\n:param z: Z component of the quaternion."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "W",
+ "returnType": "float",
+ "tooltip": "Returns W component of the quaternion."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "X",
+ "returnType": "float",
+ "tooltip": "Returns X component of the quaternion."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "Y",
+ "returnType": "float",
+ "tooltip": "Returns Y component of the quaternion."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "Z",
+ "returnType": "float",
+ "tooltip": "Returns Z component of the quaternion."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "conjugate",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Returns the conjugate of the quaternion."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "dot",
+ "returnType": "float",
+ "tooltip": "Returns the elementwise product of two quaternions."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "exp",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Matrix exponential of a quaternion.\n\n:param other: the \"Twist\" that will be applied to this quaternion."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "exp",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Matrix exponential of a quaternion.\n\nsource: wpimath/algorithms.md\n\nIf this quaternion is in \ud835\udd98\ud835\udd94(3) and you are looking for an element of\nSO(3), use FromRotationVector"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "inverse",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Returns the inverse of the quaternion."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "log",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Log operator of a quaternion.\n\n:param other: The quaternion to map this quaternion onto"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "log",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Log operator of a quaternion.\n\nsource: wpimath/algorithms.md\n\nIf this quaternion is in SO(3) and you are looking for an element of \ud835\udd98\ud835\udd94(3),\nuse ToRotationVector"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "norm",
+ "returnType": "float",
+ "tooltip": "Calculates the L2 norm of the quaternion."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "normalize",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Normalizes the quaternion."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "pow",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Calculates this quaternion raised to a power.\n\n:param t: the power to raise this quaternion to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "toRotationVector",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns the rotation vector representation of this quaternion.\n\nThis is also the log operator of SO(3)."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "rvec",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Quaternion",
+ "functionName": "fromRotationVector",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Returns the quaternion representation of this rotation vector.\n\nThis is also the exp operator of \ud835\udd98\ud835\udd94(3).\n\nsource: wpimath/algorithms.md"
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Rectangle2d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "xWidth",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "yWidth",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rectangle2d",
+ "tooltip": "Constructs a rectangle at the specified position with the specified width\nand height.\n\n:param center: The position (translation and rotation) of the rectangle.\n:param xWidth: The x size component of the rectangle, in unrotated\n coordinate frame.\n:param yWidth: The y size component of the rectangle, in unrotated\n coordinate frame."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "cornerA",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "cornerB",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rectangle2d",
+ "tooltip": "Creates an unrotated rectangle from the given corners. The corners should\nbe diagonally opposite of each other.\n\n:param cornerA: The first corner of the rectangle.\n:param cornerB: The second corner of the rectangle."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rectangle2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "center",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the center of the rectangle.\n\n:returns: The center of the rectangle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rectangle2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "point",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "contains",
+ "returnType": "bool",
+ "tooltip": "Checks if a point is contained within the rectangle. This is inclusive, if\nthe point lies on the perimeter it will return true.\n\n:param point: The point to check.\n\n:returns: True, if the rectangle contains the point or the perimeter\n intersects the point."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rectangle2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "point",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "distance",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the distance between the perimeter of the rectangle and the point.\n\n:param point: The point to check.\n\n:returns: The distance (0, if the point is contained by the rectangle)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rectangle2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "point",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "intersects",
+ "returnType": "bool",
+ "tooltip": "Checks if a point is intersected by the rectangle's perimeter.\n\n:param point: The point to check.\n\n:returns: True, if the rectangle's perimeter intersects the point."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rectangle2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "point",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "nearest",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Returns the nearest point that is contained within the rectangle.\n\n:param point: The point that this will find the nearest point to.\n\n:returns: A new point that is nearest to ``point`` and contained in the\n rectangle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rectangle2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "rotateBy",
+ "returnType": "wpimath.geometry.Rectangle2d",
+ "tooltip": "Rotates the center of the rectangle and returns the new rectangle.\n\n:param other: The rotation to transform by.\n\n:returns: The rotated rectangle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rectangle2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "rotation",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Returns the rotational component of the rectangle.\n\n:returns: The rotational component of the rectangle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rectangle2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "transformBy",
+ "returnType": "wpimath.geometry.Rectangle2d",
+ "tooltip": "Transforms the center of the rectangle and returns the new rectangle.\n\n:param other: The transform to transform by.\n\n:returns: The transformed rectangle"
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "xwidth",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "xwidth_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "ywidth",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "ywidth_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "xWidth",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "yWidth",
+ "type": "wpimath.units.feet"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rectangle2d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Rectangle2d",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Rotation2d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Constructs a Rotation2d with a default angle of 0 degrees."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Constructs a Rotation2d with the given radian value.\n:param value: The value of the angle in radians."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Constructs a Rotation2d with the given x and y (cosine and sine)\ncomponents. The x and y don't have to be normalized.\n\n:param x: The x component or cosine of the rotation.\n:param y: The y component or sine of the rotation."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "cos",
+ "returnType": "float",
+ "tooltip": "Returns the cosine of the rotation.\n\n:returns: The cosine of the rotation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "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]"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "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]"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "rotateBy",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Adds the new rotation to the current rotation using a rotation matrix.\n\n::\n\n [cos_new] [other.cos, -other.sin][cos]\n [sin_new] = [other.sin, other.cos][sin]\n value_new = std::atan2(sin_new, cos_new)\n\n:param other: The rotation to rotate by.\n\n:returns: The new rotated Rotation2d."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "sin",
+ "returnType": "float",
+ "tooltip": "Returns the sine of the rotation.\n\n:returns: The sine of the rotation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "tan",
+ "returnType": "float",
+ "tooltip": "Returns the tangent of the rotation.\n\n:returns: The tangent of the rotation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "toMatrix",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns matrix representation of this rotation."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "fromDegrees",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "rotationMatrix",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "fromMatrix",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Constructs a Rotation2d from a rotation matrix.\n\n:param rotationMatrix: The rotation matrix.\n @throws std::domain_error if the rotation matrix isn't special orthogonal."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.units.turns"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation2d",
+ "functionName": "fromRotations",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Rotation3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Constructs a Rotation3d representing no rotation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "q",
+ "type": "wpimath.geometry.Quaternion"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Constructs a Rotation3d from a quaternion.\n\n:param q: The quaternion."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "roll",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "pitch",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": null,
+ "name": "yaw",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Constructs a Rotation3d from extrinsic roll, pitch, and yaw.\n\nExtrinsic rotations occur in that order around the axes in the fixed global\nframe rather than the body frame.\n\nAngles are measured counterclockwise with the rotation axis pointing \"out\nof the page\". If you point your right thumb along the positive axis\ndirection, your fingers curl in the direction of positive rotation.\n\n:param roll: The counterclockwise rotation angle around the X axis (roll).\n:param pitch: The counterclockwise rotation angle around the Y axis (pitch).\n:param yaw: The counterclockwise rotation angle around the Z axis (yaw)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Constructs a Rotation3d with the given axis-angle representation. The axis\ndoesn't have to be normalized.\n\n:param axis: The rotation axis.\n:param angle: The rotation around the axis."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "rvec",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Constructs a Rotation3d with the given rotation vector representation. This\nrepresentation is equivalent to axis-angle, where the normalized axis is\nmultiplied by the rotation around the axis in radians.\n\n:param rvec: The rotation vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "rotationMatrix",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Constructs a Rotation3d from a rotation matrix.\n\n:param rotationMatrix: The rotation matrix.\n @throws std::domain_error if the rotation matrix isn't special orthogonal."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "initial",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "final",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Constructs a Rotation3d that rotates the initial vector onto the final\nvector.\n\nThis is useful for turning a 3D vector (final) into an orientation relative\nto a coordinate system vector (initial).\n\n:param initial: The initial vector.\n:param final: The final vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Constructs a 3D rotation from a 2D rotation in the X-Y plane.\n\n:param rotation: The 2D rotation.\n @see Pose3d(Pose2d)\n @see Transform3d(Transform2d)"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "X",
+ "returnType": "wpimath.units.radians",
+ "tooltip": "Returns the counterclockwise rotation angle around the X axis (roll)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "Y",
+ "returnType": "wpimath.units.radians",
+ "tooltip": "Returns the counterclockwise rotation angle around the Y axis (pitch)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "Z",
+ "returnType": "wpimath.units.radians",
+ "tooltip": "Returns the counterclockwise rotation angle around the Z axis (yaw)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "axis",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns the axis in the axis-angle representation of this rotation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "getQuaternion",
+ "returnType": "wpimath.geometry.Quaternion",
+ "tooltip": "Returns the quaternion representation of the Rotation3d."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "rotateBy",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Adds the new rotation to the current rotation. The other rotation is\napplied extrinsically, which means that it rotates around the global axes.\nFor example, Rotation3d{90_deg, 0, 0}.RotateBy(Rotation3d{0, 45_deg, 0})\nrotates by 90 degrees around the +X axis and then by 45 degrees around the\nglobal +Y axis. (This is equivalent to Rotation3d{90_deg, 45_deg, 0})\n\n:param other: The extrinsic rotation to rotate by.\n\n:returns: The new rotated Rotation3d."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "toMatrix",
+ "returnType": "numpy.ndarray[numpy.float64[3, 3]]",
+ "tooltip": "Returns rotation matrix representation of this rotation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "toRotation2d",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Returns a Rotation2d representing this Rotation3d projected into the X-Y\nplane."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "toVector",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns rotation vector representation of this rotation.\n\n:returns: Rotation vector representation of this rotation."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "angle",
+ "tooltip": "",
+ "type": "wpimath.units.radians",
+ "writable": null
+ },
+ {
+ "name": "angle_degrees",
+ "tooltip": "",
+ "type": "wpimath.units.degrees",
+ "writable": null
+ },
+ {
+ "name": "x",
+ "tooltip": "",
+ "type": "wpimath.units.radians",
+ "writable": null
+ },
+ {
+ "name": "x_degrees",
+ "tooltip": "",
+ "type": "wpimath.units.degrees",
+ "writable": null
+ },
+ {
+ "name": "y",
+ "tooltip": "",
+ "type": "wpimath.units.radians",
+ "writable": null
+ },
+ {
+ "name": "y_degrees",
+ "tooltip": "",
+ "type": "wpimath.units.degrees",
+ "writable": null
+ },
+ {
+ "name": "z",
+ "tooltip": "",
+ "type": "wpimath.units.radians",
+ "writable": null
+ },
+ {
+ "name": "z_degrees",
+ "tooltip": "",
+ "type": "wpimath.units.degrees",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "roll",
+ "type": "wpimath.units.degrees"
+ },
+ {
+ "defaultValue": null,
+ "name": "pitch",
+ "type": "wpimath.units.degrees"
+ },
+ {
+ "defaultValue": null,
+ "name": "yaw",
+ "type": "wpimath.units.degrees"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Rotation3d",
+ "functionName": "fromDegrees",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Transform2d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "initial",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "final",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Transform2d",
+ "tooltip": "Constructs the transform that maps the initial pose to the final pose.\n\n:param initial: The initial pose for the transformation.\n:param final: The final pose for the transformation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Transform2d",
+ "tooltip": "Constructs a transform with the given translation and rotation components.\n\n:param translation: Translational component of the transform.\n:param rotation: Rotational component of the transform."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Transform2d",
+ "tooltip": "Constructs a transform with x and y translations instead of a separate\nTranslation2d.\n\n:param x: The x component of the translational component of the transform.\n:param y: The y component of the translational component of the transform.\n:param rotation: The rotational component of the transform."
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Transform2d",
+ "tooltip": "Constructs the identity transform -- maps an initial pose to itself."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Transform2d",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "X",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the X component of the transformation's translation.\n\n:returns: The x component of the transformation's translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "Y",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the Y component of the transformation's translation.\n\n:returns: The y component of the transformation's translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "inverse",
+ "returnType": "wpimath.geometry.Transform2d",
+ "tooltip": "Invert the transformation. This is useful for undoing a transformation.\n\n:returns: The inverted transformation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "rotation",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Returns the rotational component of the transformation.\n\n:returns: Reference to the rotational component of the transform."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "toMatrix",
+ "returnType": "numpy.ndarray[numpy.float64[3, 3]]",
+ "tooltip": "Returns an affine transformation matrix representation of this\ntransformation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "translation",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Returns the translation component of the transformation.\n\n:returns: Reference to the translational component of the transform."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "x",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "x_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "y",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "y_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Transform2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "matrix",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform2d",
+ "functionName": "fromMatrix",
+ "returnType": "wpimath.geometry.Transform2d",
+ "tooltip": "Constructs a pose with the specified affine transformation matrix.\n\n:param matrix: The affine transformation matrix.\n @throws std::domain_error if the affine transformation matrix is invalid."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Transform3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "initial",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "final",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Transform3d",
+ "tooltip": "Constructs the transform that maps the initial pose to the final pose.\n\n:param initial: The initial pose for the transformation.\n:param final: The final pose for the transformation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Transform3d",
+ "tooltip": "Constructs a transform with the given translation and rotation components.\n\n:param translation: Translational component of the transform.\n:param rotation: Rotational component of the transform."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "z",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Transform3d",
+ "tooltip": "Constructs a transform with x, y, and z translations instead of a separate\nTranslation3d.\n\n:param x: The x component of the translational component of the transform.\n:param y: The y component of the translational component of the transform.\n:param z: The z component of the translational component of the transform.\n:param rotation: The rotational component of the transform."
+ },
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Transform3d",
+ "tooltip": "Constructs the identity transform -- maps an initial pose to itself."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "transform",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Transform3d",
+ "tooltip": "Constructs a 3D transform from a 2D transform in the X-Y plane.\n**\n\n:param transform: The 2D transform.\n @see Rotation3d(Rotation2d)\n @see Translation3d(Translation2d)"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "X",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the X component of the transformation's translation.\n\n:returns: The x component of the transformation's translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "Y",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the Y component of the transformation's translation.\n\n:returns: The y component of the transformation's translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "Z",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the Z component of the transformation's translation.\n\n:returns: The z component of the transformation's translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "inverse",
+ "returnType": "wpimath.geometry.Transform3d",
+ "tooltip": "Invert the transformation. This is useful for undoing a transformation.\n\n:returns: The inverted transformation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "rotation",
+ "returnType": "wpimath.geometry.Rotation3d",
+ "tooltip": "Returns the rotational component of the transformation.\n\n:returns: Reference to the rotational component of the transform."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "toMatrix",
+ "returnType": "numpy.ndarray[numpy.float64[4, 4]]",
+ "tooltip": "Returns an affine transformation matrix representation of this\ntransformation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Transform3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "translation",
+ "returnType": "wpimath.geometry.Translation3d",
+ "tooltip": "Returns the translation component of the transformation.\n\n:returns: Reference to the translational component of the transform."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "x",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "x_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "y",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "y_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "z",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "z_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "matrix",
+ "type": "numpy.ndarray[numpy.float64[4, 4]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Transform3d",
+ "functionName": "fromMatrix",
+ "returnType": "wpimath.geometry.Transform3d",
+ "tooltip": "Constructs a transform with the specified affine transformation matrix.\n\n:param matrix: The affine transformation matrix.\n @throws std::domain_error if the affine transformation matrix is invalid."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Translation2d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Constructs a Translation2d with X and Y components equal to zero."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Constructs a Translation2d with the X and Y components equal to the\nprovided values.\n\n:param x: The x component of the translation.\n:param y: The y component of the translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "distance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Constructs a Translation2d with the provided distance and angle. This is\nessentially converting from polar coordinates to Cartesian coordinates.\n\n:param distance: The distance from the origin to the end of the translation.\n:param angle: The angle between the x-axis and the translation vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "vector",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Constructs a Translation2d from a 2D translation vector. The values are\nassumed to be in meters.\n\n:param vector: The translation vector."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "X",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the X component of the translation.\n\n:returns: The X component of the translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "Y",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the Y component of the translation.\n\n:returns: The Y component of the translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "angle",
+ "returnType": "wpimath.geometry.Rotation2d",
+ "tooltip": "Returns the angle this translation forms with the positive X axis.\n\n:returns: The angle of the translation"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "distance",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Calculates the distance between two translations in 2D space.\n\nThe distance between translations is defined as \u221a((x\u2082\u2212x\u2081)\u00b2+(y\u2082\u2212y\u2081)\u00b2).\n\n:param other: The translation to compute the distance to.\n\n:returns: The distance between the two translations."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "distanceFeet",
+ "returnType": "wpimath.units.feet",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "translations",
+ "type": "List[wpimath.geometry.Translation2d]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "nearest",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Returns the nearest Translation2d from a collection of translations\n\n:param translations: The collection of translations.\n\n:returns: The nearest Translation2d from the collection."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "norm",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the norm, or distance from the origin to the translation.\n\n:returns: The norm of the translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "normFeet",
+ "returnType": "wpimath.units.feet",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "rot",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "rotateAround",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Rotates this translation around another translation in 2D space.\n\n::\n\n [x_new] [rot.cos, -rot.sin][x - other.x] [other.x]\n [y_new] = [rot.sin, rot.cos][y - other.y] + [other.y]\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": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "rotateBy",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Applies a rotation to the translation in 2D space.\n\nThis multiplies the translation vector by a counterclockwise rotation\nmatrix of the given angle.\n\n::\n\n [x_new] [other.cos, -other.sin][x]\n [y_new] = [other.sin, other.cos][y]\n\nFor example, rotating a Translation2d of <2, 0> by 90 degrees will\nreturn a Translation2d of <0, 2>.\n\n:param other: The rotation to rotate the translation by.\n\n:returns: The new rotated translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "toVector",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "x",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "x_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "y",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "y_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.feet"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "distance",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation2d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Translation3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Translation3d",
+ "tooltip": "Constructs a Translation3d with X, Y, and Z components equal to zero."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "z",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Translation3d",
+ "tooltip": "Constructs a Translation3d with the X, Y, and Z components equal to the\nprovided values.\n\n:param x: The x component of the translation.\n:param y: The y component of the translation.\n:param z: The z component of the translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "distance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Translation3d",
+ "tooltip": "Constructs a Translation3d with the provided distance and angle. This is\nessentially converting from polar coordinates to Cartesian coordinates.\n\n:param distance: The distance from the origin to the end of the translation.\n:param angle: The angle between the x-axis and the translation vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "vector",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Translation3d",
+ "tooltip": "Constructs a Translation3d from a 3D translation vector. The values are\nassumed to be in meters.\n\n:param vector: The translation vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Translation3d",
+ "tooltip": "Constructs a 3D translation from a 2D translation in the X-Y plane.\n\n:param translation: The 2D translation.\n @see Pose3d(Pose2d)\n @see Transform3d(Transform2d)"
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "X",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the X component of the translation.\n\n:returns: The Z component of the translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "Y",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the Y component of the translation.\n\n:returns: The Y component of the translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "Z",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the Z component of the translation.\n\n:returns: The Z component of the translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "distance",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Calculates the distance between two translations in 3D space.\n\nThe distance between translations is defined as\n\u221a((x\u2082\u2212x\u2081)\u00b2+(y\u2082\u2212y\u2081)\u00b2+(z\u2082\u2212z\u2081)\u00b2).\n\n:param other: The translation to compute the distance to.\n\n:returns: The distance between the two translations."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "distanceFeet",
+ "returnType": "wpimath.units.feet",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "norm",
+ "returnType": "wpimath.units.meters",
+ "tooltip": "Returns the norm, or distance from the origin to the translation.\n\n:returns: The norm of the translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "normFeet",
+ "returnType": "wpimath.units.feet",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "other",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "rotateBy",
+ "returnType": "wpimath.geometry.Translation3d",
+ "tooltip": "Applies a rotation to the translation in 3D space.\n\nFor example, rotating a Translation3d of <2, 0, 0> by 90 degrees\naround the Z axis will return a Translation3d of <0, 2, 0>.\n\n:param other: The rotation to rotate the translation by.\n\n:returns: The new rotated translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "toTranslation2d",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Returns a Translation2d representing this Translation3d projected into the\nX-Y plane."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "toVector",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "x",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "x_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "y",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "y_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ },
+ {
+ "name": "z",
+ "tooltip": "",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "z_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "z",
+ "type": "wpimath.units.feet"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Translation3d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Translation3d",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Twist2d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "dx",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": "0",
+ "name": "dy",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": "0",
+ "name": "dtheta",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Twist2d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "dtheta",
+ "tooltip": "Angular \"dtheta\" component (radians)",
+ "type": "wpimath.units.radians",
+ "writable": true
+ },
+ {
+ "name": "dtheta_degrees",
+ "tooltip": "",
+ "type": "wpimath.units.degrees",
+ "writable": true
+ },
+ {
+ "name": "dx",
+ "tooltip": "Linear \"dx\" component",
+ "type": "wpimath.units.meters",
+ "writable": true
+ },
+ {
+ "name": "dx_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": true
+ },
+ {
+ "name": "dy",
+ "tooltip": "Linear \"dy\" component",
+ "type": "wpimath.units.meters",
+ "writable": true
+ },
+ {
+ "name": "dy_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "dx",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": "0",
+ "name": "dy",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": "0",
+ "name": "dtheta",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Twist2d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.geometry.Twist3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "dx",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": "0",
+ "name": "dy",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": "0",
+ "name": "dz",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": "0",
+ "name": "rx",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": "0",
+ "name": "ry",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": "0",
+ "name": "rz",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Twist3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.geometry.Twist3d",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "dx",
+ "tooltip": "Linear \"dx\" component",
+ "type": "wpimath.units.meters",
+ "writable": true
+ },
+ {
+ "name": "dx_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": true
+ },
+ {
+ "name": "dy",
+ "tooltip": "Linear \"dy\" component",
+ "type": "wpimath.units.meters",
+ "writable": true
+ },
+ {
+ "name": "dy_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": true
+ },
+ {
+ "name": "dz",
+ "tooltip": "Linear \"dz\" component",
+ "type": "wpimath.units.meters",
+ "writable": true
+ },
+ {
+ "name": "dz_feet",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": true
+ },
+ {
+ "name": "rx",
+ "tooltip": "Rotation vector x component.",
+ "type": "wpimath.units.radians",
+ "writable": true
+ },
+ {
+ "name": "rx_degrees",
+ "tooltip": "",
+ "type": "wpimath.units.degrees",
+ "writable": true
+ },
+ {
+ "name": "ry",
+ "tooltip": "Rotation vector y component.",
+ "type": "wpimath.units.radians",
+ "writable": true
+ },
+ {
+ "name": "ry_degrees",
+ "tooltip": "",
+ "type": "wpimath.units.degrees",
+ "writable": true
+ },
+ {
+ "name": "rz",
+ "tooltip": "Rotation vector z component.",
+ "type": "wpimath.units.radians",
+ "writable": true
+ },
+ {
+ "name": "rz_degrees",
+ "tooltip": "",
+ "type": "wpimath.units.degrees",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "dx",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": "0",
+ "name": "dy",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": "0",
+ "name": "dz",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": "0",
+ "name": "rx",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": "0",
+ "name": "ry",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": "0",
+ "name": "rz",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "declaringClassName": "wpimath.geometry.Twist3d",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.geometry.Twist3d",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.interpolation.TimeInterpolatableFloatBuffer",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[float, float, float], float]"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableFloatBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatableFloatBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer.\n\n:param historySize: The history size of the buffer.\n:param func: The function used to interpolate between values."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableFloatBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatableFloatBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer. By default, the interpolation\nfunction is wpi::Lerp except for Pose2d, which uses the pose exponential.\n\n:param historySize: The history size of the buffer."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableFloatBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "sample",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableFloatBuffer",
+ "functionName": "addSample",
+ "returnType": "None",
+ "tooltip": "Add a sample to the buffer.\n\n:param time: The timestamp of the sample.\n:param sample: The sample object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableFloatBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableFloatBuffer",
+ "functionName": "clear",
+ "returnType": "None",
+ "tooltip": "Clear all old samples."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableFloatBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableFloatBuffer",
+ "functionName": "getInternalBuffer",
+ "returnType": "list[tuple[wpimath.units.seconds, float]]",
+ "tooltip": "Grant access to the internal sample buffer. Used in Pose Estimation to\nreplay odometry inputs stored within this buffer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableFloatBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableFloatBuffer",
+ "functionName": "sample",
+ "returnType": "Optional[float]",
+ "tooltip": "Sample the buffer at the given time. If the buffer is empty, an empty\noptional is returned.\n\n:param time: The time at which to sample the buffer."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.interpolation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.interpolation.TimeInterpolatablePose2dBuffer",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[wpimath.geometry.Pose2d, wpimath.geometry.Pose2d, float], wpimath.geometry.Pose2d]"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose2dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatablePose2dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer.\n\n:param historySize: The history size of the buffer.\n:param func: The function used to interpolate between values."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose2dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatablePose2dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer. By default, the interpolation\nfunction is wpi::Lerp except for Pose2d, which uses the pose exponential.\n\n:param historySize: The history size of the buffer."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatablePose2dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "sample",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose2dBuffer",
+ "functionName": "addSample",
+ "returnType": "None",
+ "tooltip": "Add a sample to the buffer.\n\n:param time: The timestamp of the sample.\n:param sample: The sample object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatablePose2dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose2dBuffer",
+ "functionName": "clear",
+ "returnType": "None",
+ "tooltip": "Clear all old samples."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatablePose2dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose2dBuffer",
+ "functionName": "getInternalBuffer",
+ "returnType": "list[tuple[wpimath.units.seconds, wpimath.geometry.Pose2d]]",
+ "tooltip": "Grant access to the internal sample buffer. Used in Pose Estimation to\nreplay odometry inputs stored within this buffer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatablePose2dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose2dBuffer",
+ "functionName": "sample",
+ "returnType": "Optional[wpimath.geometry.Pose2d]",
+ "tooltip": "Sample the buffer at the given time. If the buffer is empty, an empty\noptional is returned.\n\n:param time: The time at which to sample the buffer."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.interpolation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.interpolation.TimeInterpolatablePose3dBuffer",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[wpimath.geometry.Pose3d, wpimath.geometry.Pose3d, float], wpimath.geometry.Pose3d]"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose3dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatablePose3dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer.\n\n:param historySize: The history size of the buffer.\n:param func: The function used to interpolate between values."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose3dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatablePose3dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer. By default, the interpolation\nfunction is wpi::Lerp except for Pose2d, which uses the pose exponential.\n\n:param historySize: The history size of the buffer."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatablePose3dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "sample",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose3dBuffer",
+ "functionName": "addSample",
+ "returnType": "None",
+ "tooltip": "Add a sample to the buffer.\n\n:param time: The timestamp of the sample.\n:param sample: The sample object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatablePose3dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose3dBuffer",
+ "functionName": "clear",
+ "returnType": "None",
+ "tooltip": "Clear all old samples."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatablePose3dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose3dBuffer",
+ "functionName": "getInternalBuffer",
+ "returnType": "list[tuple[wpimath.units.seconds, wpimath.geometry.Pose3d]]",
+ "tooltip": "Grant access to the internal sample buffer. Used in Pose Estimation to\nreplay odometry inputs stored within this buffer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatablePose3dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatablePose3dBuffer",
+ "functionName": "sample",
+ "returnType": "Optional[wpimath.geometry.Pose3d]",
+ "tooltip": "Sample the buffer at the given time. If the buffer is empty, an empty\noptional is returned.\n\n:param time: The time at which to sample the buffer."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.interpolation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d, float], wpimath.geometry.Rotation2d]"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer.\n\n:param historySize: The history size of the buffer.\n:param func: The function used to interpolate between values."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer. By default, the interpolation\nfunction is wpi::Lerp except for Pose2d, which uses the pose exponential.\n\n:param historySize: The history size of the buffer."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "sample",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer",
+ "functionName": "addSample",
+ "returnType": "None",
+ "tooltip": "Add a sample to the buffer.\n\n:param time: The timestamp of the sample.\n:param sample: The sample object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer",
+ "functionName": "clear",
+ "returnType": "None",
+ "tooltip": "Clear all old samples."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer",
+ "functionName": "getInternalBuffer",
+ "returnType": "list[tuple[wpimath.units.seconds, wpimath.geometry.Rotation2d]]",
+ "tooltip": "Grant access to the internal sample buffer. Used in Pose Estimation to\nreplay odometry inputs stored within this buffer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation2dBuffer",
+ "functionName": "sample",
+ "returnType": "Optional[wpimath.geometry.Rotation2d]",
+ "tooltip": "Sample the buffer at the given time. If the buffer is empty, an empty\noptional is returned.\n\n:param time: The time at which to sample the buffer."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.interpolation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[wpimath.geometry.Rotation3d, wpimath.geometry.Rotation3d, float], wpimath.geometry.Rotation3d]"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer.\n\n:param historySize: The history size of the buffer.\n:param func: The function used to interpolate between values."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer. By default, the interpolation\nfunction is wpi::Lerp except for Pose2d, which uses the pose exponential.\n\n:param historySize: The history size of the buffer."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "sample",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer",
+ "functionName": "addSample",
+ "returnType": "None",
+ "tooltip": "Add a sample to the buffer.\n\n:param time: The timestamp of the sample.\n:param sample: The sample object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer",
+ "functionName": "clear",
+ "returnType": "None",
+ "tooltip": "Clear all old samples."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer",
+ "functionName": "getInternalBuffer",
+ "returnType": "list[tuple[wpimath.units.seconds, wpimath.geometry.Rotation3d]]",
+ "tooltip": "Grant access to the internal sample buffer. Used in Pose Estimation to\nreplay odometry inputs stored within this buffer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableRotation3dBuffer",
+ "functionName": "sample",
+ "returnType": "Optional[wpimath.geometry.Rotation3d]",
+ "tooltip": "Sample the buffer at the given time. If the buffer is empty, an empty\noptional is returned.\n\n:param time: The time at which to sample the buffer."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.interpolation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[wpimath.geometry.Translation2d, wpimath.geometry.Translation2d, float], wpimath.geometry.Translation2d]"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer.\n\n:param historySize: The history size of the buffer.\n:param func: The function used to interpolate between values."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer. By default, the interpolation\nfunction is wpi::Lerp except for Pose2d, which uses the pose exponential.\n\n:param historySize: The history size of the buffer."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "sample",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer",
+ "functionName": "addSample",
+ "returnType": "None",
+ "tooltip": "Add a sample to the buffer.\n\n:param time: The timestamp of the sample.\n:param sample: The sample object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer",
+ "functionName": "clear",
+ "returnType": "None",
+ "tooltip": "Clear all old samples."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer",
+ "functionName": "getInternalBuffer",
+ "returnType": "list[tuple[wpimath.units.seconds, wpimath.geometry.Translation2d]]",
+ "tooltip": "Grant access to the internal sample buffer. Used in Pose Estimation to\nreplay odometry inputs stored within this buffer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation2dBuffer",
+ "functionName": "sample",
+ "returnType": "Optional[wpimath.geometry.Translation2d]",
+ "tooltip": "Sample the buffer at the given time. If the buffer is empty, an empty\noptional is returned.\n\n:param time: The time at which to sample the buffer."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.interpolation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[wpimath.geometry.Translation3d, wpimath.geometry.Translation3d, float], wpimath.geometry.Translation3d]"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer.\n\n:param historySize: The history size of the buffer.\n:param func: The function used to interpolate between values."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "historySize",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer",
+ "functionName": "__init__",
+ "returnType": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer",
+ "tooltip": "Create a new TimeInterpolatableBuffer. By default, the interpolation\nfunction is wpi::Lerp except for Pose2d, which uses the pose exponential.\n\n:param historySize: The history size of the buffer."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "sample",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer",
+ "functionName": "addSample",
+ "returnType": "None",
+ "tooltip": "Add a sample to the buffer.\n\n:param time: The timestamp of the sample.\n:param sample: The sample object."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer",
+ "functionName": "clear",
+ "returnType": "None",
+ "tooltip": "Clear all old samples."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer",
+ "functionName": "getInternalBuffer",
+ "returnType": "list[tuple[wpimath.units.seconds, wpimath.geometry.Translation3d]]",
+ "tooltip": "Grant access to the internal sample buffer. Used in Pose Estimation to\nreplay odometry inputs stored within this buffer."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "time",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.interpolation.TimeInterpolatableTranslation3dBuffer",
+ "functionName": "sample",
+ "returnType": "Optional[wpimath.geometry.Translation3d]",
+ "tooltip": "Sample the buffer at the given time. If the buffer is empty, an empty\noptional is returned.\n\n:param time: The time at which to sample the buffer."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.interpolation",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.ChassisSpeeds",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "vx",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": "0",
+ "name": "vy",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": "0",
+ "name": "omega",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.ChassisSpeeds",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.ChassisSpeeds",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Creates a Twist2d from ChassisSpeeds.\n\n:param dt: The duration of the timestep.\n\n:returns: Twist2d."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "omega",
+ "tooltip": "Represents the angular velocity of the robot frame. (CCW is +)",
+ "type": "wpimath.units.radians_per_second",
+ "writable": true
+ },
+ {
+ "name": "omega_dps",
+ "tooltip": "",
+ "type": "wpimath.units.degrees_per_second",
+ "writable": true
+ },
+ {
+ "name": "vx",
+ "tooltip": "Velocity along the x-axis. (Fwd is +)",
+ "type": "wpimath.units.meters_per_second",
+ "writable": true
+ },
+ {
+ "name": "vx_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second",
+ "writable": true
+ },
+ {
+ "name": "vy",
+ "tooltip": "Velocity along the y-axis. (Left is +)",
+ "type": "wpimath.units.meters_per_second",
+ "writable": true
+ },
+ {
+ "name": "vy_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "vx",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "vy",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "omega",
+ "type": "wpimath.units.radians_per_second"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "continuousSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "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": [
+ {
+ "defaultValue": "0",
+ "name": "vx",
+ "type": "wpimath.units.feet_per_second"
+ },
+ {
+ "defaultValue": "0",
+ "name": "vy",
+ "type": "wpimath.units.feet_per_second"
+ },
+ {
+ "defaultValue": "0",
+ "name": "omega",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.ChassisSpeeds",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "vx",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "vy",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "omega",
+ "type": "wpimath.units.radians_per_second"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "fieldRelativeSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "vx",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "vy",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "omega",
+ "type": "wpimath.units.radians_per_second"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "robotRelativeSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "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."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.kinematics.DifferentialDriveKinematics",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematics",
+ "functionName": "interpolate",
+ "returnType": "wpimath.kinematics.DifferentialDriveWheelPositions",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelSpeeds",
+ "type": "wpimath.kinematics.DifferentialDriveWheelSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematics",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Returns a chassis speed from left and right component velocities using\nforward kinematics.\n\n:param wheelSpeeds: The left and right velocities.\n\n:returns: The chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Returns a twist from left and right distance deltas using\nforward kinematics.\n\n:param leftDistance: The distance measured by the left encoder.\n:param rightDistance: The distance measured by the right encoder.\n\n:returns: The resulting Twist2d."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematics",
+ "functionName": "toWheelSpeeds",
+ "returnType": "wpimath.kinematics.DifferentialDriveWheelSpeeds",
+ "tooltip": "Returns left and right component velocities from a chassis speed using\ninverse kinematics.\n\n:param chassisSpeeds: The linear and angular (dx and dtheta) components that\n represent the chassis' speed.\n\n:returns: The left and right velocities."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "trackWidth",
+ "tooltip": "Differential drive trackwidth.",
+ "type": "wpimath.units.meters",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.DifferentialDriveKinematicsBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematicsBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.DifferentialDriveKinematicsBase",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematicsBase",
+ "functionName": "interpolate",
+ "returnType": "wpimath.kinematics.DifferentialDriveWheelPositions",
+ "tooltip": "Performs interpolation between two values.\n\n:param start: The value to start at.\n:param end: The value to end at.\n:param t: How far between the two values to interpolate. This should be\n bounded to [0, 1].\n\n:returns: The interpolated value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelSpeeds",
+ "type": "wpimath.kinematics.DifferentialDriveWheelSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematicsBase",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis speed from the\nwheel speeds. This method is often used for odometry -- determining the\nrobot's position on the field using data from the real-world speed of each\nwheel on the robot.\n\n:param wheelSpeeds: The speeds of the wheels.\n\n:returns: The chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematicsBase",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the given\nchange in wheel positions. This method is often used for odometry --\ndetermining the robot's position on the field using changes in the distance\ndriven by each wheel on the robot.\n\n:param start: The starting distances driven by the wheels.\n:param end: The ending distances driven by the wheels.\n\n:returns: The resulting Twist2d in the robot's movement."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveKinematicsBase",
+ "functionName": "toWheelSpeeds",
+ "returnType": "wpimath.kinematics.DifferentialDriveWheelSpeeds",
+ "tooltip": "Performs inverse kinematics to return the wheel speeds from a desired\nchassis velocity. This method is often used to convert joystick values into\nwheel speeds.\n\n:param chassisSpeeds: The desired chassis speed.\n\n:returns: The wheel speeds."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.DifferentialDriveOdometry",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.DifferentialDriveOdometry",
+ "tooltip": "Constructs a DifferentialDriveOdometry object.\n\nIF leftDistance and rightDistance are unspecified,\nYou NEED to reset your encoders (to zero).\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nIF leftDistance and rightDistance are unspecified,\nYou NEED to reset your encoders (to zero).\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param pose: The position on the field that your robot is at.\n:param gyroAngle: The angle reported by the gyroscope.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot position on the field using distance measurements from\nencoders. This method is more numerically accurate than using velocities to\nintegrate the pose and is also advantageous for teams that are using lower\nCPR encoders.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.DifferentialDriveOdometry3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.DifferentialDriveOdometry3d",
+ "tooltip": "Constructs a DifferentialDriveOdometry3d object.\n\nIF leftDistance and rightDistance are unspecified,\nYou NEED to reset your encoders (to zero).\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3d",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nIF leftDistance and rightDistance are unspecified,\nYou NEED to reset your encoders (to zero).\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param pose: The position on the field that your robot is at.\n:param gyroAngle: The angle reported by the gyroscope.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftDistance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightDistance",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3d",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot position on the field using distance measurements from\nencoders. This method is more numerically accurate than using velocities to\nintegrate the pose and is also advantageous for teams that are using lower\nCPR encoders.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param leftDistance: The distance traveled by the left encoder.\n:param rightDistance: The distance traveled by the right encoder.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "tooltip": "Constructs an Odometry3d object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "tooltip": "Constructs an Odometry object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.DifferentialDriveWheelPositions",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveWheelPositions",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.DifferentialDriveWheelPositions",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "endValue",
+ "type": "wpimath.kinematics.DifferentialDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveWheelPositions",
+ "functionName": "interpolate",
+ "returnType": "wpimath.kinematics.DifferentialDriveWheelPositions",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "left",
+ "tooltip": "Distance driven by the left side.",
+ "type": "wpimath.units.meters",
+ "writable": true
+ },
+ {
+ "name": "right",
+ "tooltip": "Distance driven by the right side.",
+ "type": "wpimath.units.meters",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.DifferentialDriveWheelSpeeds",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "left",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": "0",
+ "name": "right",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveWheelSpeeds",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.DifferentialDriveWheelSpeeds",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.DifferentialDriveWheelSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveWheelSpeeds",
+ "functionName": "desaturate",
+ "returnType": "None",
+ "tooltip": "Renormalizes the wheel speeds if either side is above the specified\nmaximum.\n\nSometimes, after inverse kinematics, the requested speed from one or more\nwheels may be above the max attainable speed for the driving motor on that\nwheel. To fix this issue, one can reduce all the wheel speeds to make sure\nthat all requested module speeds are at-or-below the absolute threshold,\nwhile maintaining the ratio of speeds between wheels.\n\n:param attainableMaxSpeed: The absolute max speed that a wheel can reach."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "left",
+ "tooltip": "Speed of the left side of the robot.",
+ "type": "wpimath.units.meters_per_second",
+ "writable": true
+ },
+ {
+ "name": "left_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second",
+ "writable": true
+ },
+ {
+ "name": "right",
+ "tooltip": "Speed of the right side of the robot.",
+ "type": "wpimath.units.meters_per_second",
+ "writable": true
+ },
+ {
+ "name": "right_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "left",
+ "type": "wpimath.units.feet_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "right",
+ "type": "wpimath.units.feet_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.DifferentialDriveWheelSpeeds",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.kinematics.DifferentialDriveWheelSpeeds",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.kinematics.MecanumDriveKinematics",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "frontLeftWheel",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "frontRightWheel",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "rearLeftWheel",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "rearRightWheel",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.MecanumDriveKinematics",
+ "tooltip": "Constructs a mecanum drive kinematics object.\n\n:param frontLeftWheel: The location of the front-left wheel relative to the\n physical center of the robot.\n:param frontRightWheel: The location of the front-right wheel relative to\n the physical center of the robot.\n:param rearLeftWheel: The location of the rear-left wheel relative to the\n physical center of the robot.\n:param rearRightWheel: The location of the rear-right wheel relative to the\n physical center of the robot."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "getFrontLeft",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Returns the front-left wheel translation.\n\n:returns: The front-left wheel translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "getFrontRight",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Returns the front-right wheel translation.\n\n:returns: The front-right wheel translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "getRearLeft",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Returns the rear-left wheel translation.\n\n:returns: The rear-left wheel translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "getRearRight",
+ "returnType": "wpimath.geometry.Translation2d",
+ "tooltip": "Returns the rear-right wheel translation.\n\n:returns: The rear-right wheel translation."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "interpolate",
+ "returnType": "wpimath.kinematics.MecanumDriveWheelPositions",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelSpeeds",
+ "type": "wpimath.kinematics.MecanumDriveWheelSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis state from the\ngiven wheel speeds. This method is often used for odometry -- determining\nthe robot's position on the field using data from the real-world speed of\neach wheel on the robot.\n\n:param wheelSpeeds: The current mecanum drive wheel speeds.\n\n:returns: The resulting chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelDeltas",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the\ngiven wheel position deltas. This method is often used for odometry --\ndetermining the robot's position on the field using data from the\ndistance driven by each wheel on the robot.\n\n:param wheelDeltas: The change in distance driven by each wheel.\n\n:returns: The resulting chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "name": "centerOfRotation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "toWheelSpeeds",
+ "returnType": "wpimath.kinematics.MecanumDriveWheelSpeeds",
+ "tooltip": "Performs inverse kinematics to return the wheel speeds from a desired\nchassis velocity. This method is often used to convert joystick values into\nwheel speeds.\n\nThis function also supports variable centers of rotation. During normal\noperations, the center of rotation is usually the same as the physical\ncenter of the robot; therefore, the argument is defaulted to that use case.\nHowever, if you wish to change the center of rotation for evasive\nmaneuvers, vision alignment, or for any other use case, you can do so.\n\n:param chassisSpeeds: The desired chassis speed.\n:param centerOfRotation: The center of rotation. For example, if you set the\n center of rotation at one corner of the robot and\n provide a chassis speed that only has a dtheta\n component, the robot will rotate around that\n corner.\n\n:returns: The wheel speeds. Use caution because they are not normalized.\n Sometimes, a user input may cause one of the wheel speeds to go\n above the attainable max velocity. Use the\n :meth:`MecanumDriveWheelSpeeds.normalize` method to rectify\n this issue. In addition, you can use Python unpacking syntax\n to directly assign the wheel speeds to variables::\n\n fl, fr, bl, br = kinematics.toWheelSpeeds(chassisSpeeds)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematics",
+ "functionName": "toWheelSpeeds",
+ "returnType": "wpimath.kinematics.MecanumDriveWheelSpeeds",
+ "tooltip": "Performs inverse kinematics to return the wheel speeds from a desired\nchassis velocity. This method is often used to convert joystick values into\nwheel speeds.\n\nThis function also supports variable centers of rotation. During normal\noperations, the center of rotation is usually the same as the physical\ncenter of the robot; therefore, the argument is defaulted to that use case.\nHowever, if you wish to change the center of rotation for evasive\nmaneuvers, vision alignment, or for any other use case, you can do so.\n\n:param chassisSpeeds: The desired chassis speed.\n:param centerOfRotation: The center of rotation. For example, if you set the\n center of rotation at one corner of the robot and\n provide a chassis speed that only has a dtheta\n component, the robot will rotate around that\n corner.\n\n:returns: The wheel speeds. Use caution because they are not normalized.\n Sometimes, a user input may cause one of the wheel speeds to go\n above the attainable max velocity. Use the\n :meth:`MecanumDriveWheelSpeeds.normalize` method to rectify\n this issue. In addition, you can use Python unpacking syntax\n to directly assign the wheel speeds to variables::\n\n fl, fr, bl, br = kinematics.toWheelSpeeds(chassisSpeeds)"
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.MecanumDriveKinematicsBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematicsBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.MecanumDriveKinematicsBase",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematicsBase",
+ "functionName": "interpolate",
+ "returnType": "wpimath.kinematics.MecanumDriveWheelPositions",
+ "tooltip": "Performs interpolation between two values.\n\n:param start: The value to start at.\n:param end: The value to end at.\n:param t: How far between the two values to interpolate. This should be\n bounded to [0, 1].\n\n:returns: The interpolated value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelSpeeds",
+ "type": "wpimath.kinematics.MecanumDriveWheelSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematicsBase",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis speed from the\nwheel speeds. This method is often used for odometry -- determining the\nrobot's position on the field using data from the real-world speed of each\nwheel on the robot.\n\n:param wheelSpeeds: The speeds of the wheels.\n\n:returns: The chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematicsBase",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the given\nchange in wheel positions. This method is often used for odometry --\ndetermining the robot's position on the field using changes in the distance\ndriven by each wheel on the robot.\n\n:param start: The starting distances driven by the wheels.\n:param end: The ending distances driven by the wheels.\n\n:returns: The resulting Twist2d in the robot's movement."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveKinematicsBase",
+ "functionName": "toWheelSpeeds",
+ "returnType": "wpimath.kinematics.MecanumDriveWheelSpeeds",
+ "tooltip": "Performs inverse kinematics to return the wheel speeds from a desired\nchassis velocity. This method is often used to convert joystick values into\nwheel speeds.\n\n:param chassisSpeeds: The desired chassis speed.\n\n:returns: The wheel speeds."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.MecanumDriveOdometry",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.MecanumDriveOdometry",
+ "tooltip": "Constructs a MecanumDriveOdometry object.\n\n:param kinematics: The mecanum drive kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.MecanumDriveOdometry3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.MecanumDriveOdometry3d",
+ "tooltip": "Constructs a MecanumDriveOdometry3d object.\n\n:param kinematics: The mecanum drive kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "tooltip": "Constructs an Odometry3d object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "tooltip": "Constructs an Odometry object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveOdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveOdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.MecanumDriveWheelPositions",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveWheelPositions",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.MecanumDriveWheelPositions",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "endValue",
+ "type": "wpimath.kinematics.MecanumDriveWheelPositions"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveWheelPositions",
+ "functionName": "interpolate",
+ "returnType": "wpimath.kinematics.MecanumDriveWheelPositions",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "frontLeft",
+ "tooltip": "Distance driven by the front-left wheel.",
+ "type": "wpimath.units.meters",
+ "writable": true
+ },
+ {
+ "name": "frontRight",
+ "tooltip": "Distance driven by the front-right wheel.",
+ "type": "wpimath.units.meters",
+ "writable": true
+ },
+ {
+ "name": "rearLeft",
+ "tooltip": "Distance driven by the rear-left wheel.",
+ "type": "wpimath.units.meters",
+ "writable": true
+ },
+ {
+ "name": "rearRight",
+ "tooltip": "Distance driven by the rear-right wheel.",
+ "type": "wpimath.units.meters",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.MecanumDriveWheelSpeeds",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "frontLeft",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": "0",
+ "name": "frontRight",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": "0",
+ "name": "rearLeft",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": "0",
+ "name": "rearRight",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveWheelSpeeds",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.MecanumDriveWheelSpeeds",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.MecanumDriveWheelSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "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."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "frontLeft",
+ "tooltip": "Speed of the front-left wheel.",
+ "type": "wpimath.units.meters_per_second",
+ "writable": true
+ },
+ {
+ "name": "frontLeft_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second",
+ "writable": true
+ },
+ {
+ "name": "frontRight",
+ "tooltip": "Speed of the front-right wheel.",
+ "type": "wpimath.units.meters_per_second",
+ "writable": true
+ },
+ {
+ "name": "frontRight_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second",
+ "writable": true
+ },
+ {
+ "name": "rearLeft",
+ "tooltip": "Speed of the rear-left wheel.",
+ "type": "wpimath.units.meters_per_second",
+ "writable": true
+ },
+ {
+ "name": "rearLeft_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second",
+ "writable": true
+ },
+ {
+ "name": "rearRight",
+ "tooltip": "Speed of the rear-right wheel.",
+ "type": "wpimath.units.meters_per_second",
+ "writable": true
+ },
+ {
+ "name": "rearRight_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "frontLeft",
+ "type": "wpimath.units.feet_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "frontRight",
+ "type": "wpimath.units.feet_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "rearLeft",
+ "type": "wpimath.units.feet_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "rearRight",
+ "type": "wpimath.units.feet_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.MecanumDriveWheelSpeeds",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.kinematics.MecanumDriveWheelSpeeds",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "functionName": "getModules",
+ "returnType": "Tuple[wpimath.geometry.Translation2d, wpimath.geometry.Translation2d]",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "functionName": "interpolate",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleHeadings",
+ "type": "Tuple[wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "functionName": "resetHeadings",
+ "returnType": "None",
+ "tooltip": "Reset the internal swerve module headings.\n\n:param moduleHeadings: The swerve module headings. The order of the module\n headings should be same as passed into the constructor of this class."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis state from the\ngiven module states. This method is often used for odometry -- determining\nthe robot's position on the field using data from the real-world speed and\nangle of each module on the robot.\n\n:param moduleStates: The state of the modules as an wpi::array of type\n SwerveModuleState, NumModules long as measured from respective encoders\n and gyros. The order of the swerve module states should be same as passed\n into the constructor of this class.\n\n:returns: The resulting chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": "Translation2d(x=0.000000, y=0.000000)",
+ "name": "centerOfRotation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "functionName": "toSwerveModuleStates",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": "Performs inverse kinematics to return the module states from a desired\nchassis velocity. This method is often used to convert joystick values into\nmodule speeds and angles.\n\nThis function also supports variable centers of rotation. During normal\noperations, the center of rotation is usually the same as the physical\ncenter of the robot; therefore, the argument is defaulted to that use case.\nHowever, if you wish to change the center of rotation for evasive\nmaneuvers, vision alignment, or for any other use case, you can do so.\n\n:param chassisSpeeds: The desired chassis speed.\n:param centerOfRotation: The center of rotation. For example, if you set the\n center of rotation at one corner of the robot and provide a chassis speed\n that only has a dtheta component, the robot will rotate around that corner.\n\n:returns: An array containing the module states. Use caution because these\n module states are not normalized. Sometimes, a user input may cause one of\n the module speeds to go above the attainable max velocity. Use the\n :meth:`desaturateWheelSpeeds` function to rectify this issue.\n In addition, you can use Python unpacking syntax\n to directly assign the module states to variables::\n\n fl, fr, bl, br = kinematics.toSwerveModuleStates(chassisSpeeds)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleDeltas",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the\ngiven module position deltas. This method is often used for odometry --\ndetermining the robot's position on the field using data from the\nreal-world position delta and angle of each module on the robot.\n\n:param moduleDeltas: The latest change in position of the modules (as a\n SwerveModulePosition type) as measured from respective encoders and gyros.\n The order of the swerve module states should be same as passed into the\n constructor of this class.\n\n:returns: The resulting Twist2d."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Kinematics",
+ "functionName": "toWheelSpeeds",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ },
+ {
+ "defaultValue": null,
+ "name": "desiredChassisSpeed",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxModuleSpeed",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxRobotTranslationSpeed",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxRobotRotationSpeed",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "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"
+ }
+ ]
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive2KinematicsBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2KinematicsBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive2KinematicsBase",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2KinematicsBase",
+ "functionName": "interpolate",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]",
+ "tooltip": "Performs interpolation between two values.\n\n:param start: The value to start at.\n:param end: The value to end at.\n:param t: How far between the two values to interpolate. This should be\n bounded to [0, 1].\n\n:returns: The interpolated value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelSpeeds",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2KinematicsBase",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis speed from the\nwheel speeds. This method is often used for odometry -- determining the\nrobot's position on the field using data from the real-world speed of each\nwheel on the robot.\n\n:param wheelSpeeds: The speeds of the wheels.\n\n:returns: The chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2KinematicsBase",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the given\nchange in wheel positions. This method is often used for odometry --\ndetermining the robot's position on the field using changes in the distance\ndriven by each wheel on the robot.\n\n:param start: The starting distances driven by the wheels.\n:param end: The ending distances driven by the wheels.\n\n:returns: The resulting Twist2d in the robot's movement."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2KinematicsBase",
+ "functionName": "toWheelSpeeds",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": "Performs inverse kinematics to return the wheel speeds from a desired\nchassis velocity. This method is often used to convert joystick values into\nwheel speeds.\n\n:param chassisSpeeds: The desired chassis speed.\n\n:returns: The wheel speeds."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive2Odometry",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive2Odometry",
+ "tooltip": "Constructs a SwerveDriveOdometry object.\n\n:param kinematics: The swerve drive kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param modulePositions: The wheel positions reported by each module.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive2Odometry3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive2Odometry3d",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "tooltip": "Constructs an Odometry3d object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "tooltip": "Constructs an Odometry object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive2OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "functionName": "getModules",
+ "returnType": "Tuple[wpimath.geometry.Translation2d, wpimath.geometry.Translation2d, wpimath.geometry.Translation2d]",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "functionName": "interpolate",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleHeadings",
+ "type": "Tuple[wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "functionName": "resetHeadings",
+ "returnType": "None",
+ "tooltip": "Reset the internal swerve module headings.\n\n:param moduleHeadings: The swerve module headings. The order of the module\n headings should be same as passed into the constructor of this class."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis state from the\ngiven module states. This method is often used for odometry -- determining\nthe robot's position on the field using data from the real-world speed and\nangle of each module on the robot.\n\n:param moduleStates: The state of the modules as an wpi::array of type\n SwerveModuleState, NumModules long as measured from respective encoders\n and gyros. The order of the swerve module states should be same as passed\n into the constructor of this class.\n\n:returns: The resulting chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": "Translation2d(x=0.000000, y=0.000000)",
+ "name": "centerOfRotation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "functionName": "toSwerveModuleStates",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": "Performs inverse kinematics to return the module states from a desired\nchassis velocity. This method is often used to convert joystick values into\nmodule speeds and angles.\n\nThis function also supports variable centers of rotation. During normal\noperations, the center of rotation is usually the same as the physical\ncenter of the robot; therefore, the argument is defaulted to that use case.\nHowever, if you wish to change the center of rotation for evasive\nmaneuvers, vision alignment, or for any other use case, you can do so.\n\n:param chassisSpeeds: The desired chassis speed.\n:param centerOfRotation: The center of rotation. For example, if you set the\n center of rotation at one corner of the robot and provide a chassis speed\n that only has a dtheta component, the robot will rotate around that corner.\n\n:returns: An array containing the module states. Use caution because these\n module states are not normalized. Sometimes, a user input may cause one of\n the module speeds to go above the attainable max velocity. Use the\n :meth:`desaturateWheelSpeeds` function to rectify this issue.\n In addition, you can use Python unpacking syntax\n to directly assign the module states to variables::\n\n fl, fr, bl, br = kinematics.toSwerveModuleStates(chassisSpeeds)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleDeltas",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the\ngiven module position deltas. This method is often used for odometry --\ndetermining the robot's position on the field using data from the\nreal-world position delta and angle of each module on the robot.\n\n:param moduleDeltas: The latest change in position of the modules (as a\n SwerveModulePosition type) as measured from respective encoders and gyros.\n The order of the swerve module states should be same as passed into the\n constructor of this class.\n\n:returns: The resulting Twist2d."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Kinematics",
+ "functionName": "toWheelSpeeds",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ },
+ {
+ "defaultValue": null,
+ "name": "desiredChassisSpeed",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxModuleSpeed",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxRobotTranslationSpeed",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxRobotRotationSpeed",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "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"
+ }
+ ]
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive3KinematicsBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3KinematicsBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive3KinematicsBase",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3KinematicsBase",
+ "functionName": "interpolate",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]",
+ "tooltip": "Performs interpolation between two values.\n\n:param start: The value to start at.\n:param end: The value to end at.\n:param t: How far between the two values to interpolate. This should be\n bounded to [0, 1].\n\n:returns: The interpolated value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelSpeeds",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3KinematicsBase",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis speed from the\nwheel speeds. This method is often used for odometry -- determining the\nrobot's position on the field using data from the real-world speed of each\nwheel on the robot.\n\n:param wheelSpeeds: The speeds of the wheels.\n\n:returns: The chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3KinematicsBase",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the given\nchange in wheel positions. This method is often used for odometry --\ndetermining the robot's position on the field using changes in the distance\ndriven by each wheel on the robot.\n\n:param start: The starting distances driven by the wheels.\n:param end: The ending distances driven by the wheels.\n\n:returns: The resulting Twist2d in the robot's movement."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3KinematicsBase",
+ "functionName": "toWheelSpeeds",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": "Performs inverse kinematics to return the wheel speeds from a desired\nchassis velocity. This method is often used to convert joystick values into\nwheel speeds.\n\n:param chassisSpeeds: The desired chassis speed.\n\n:returns: The wheel speeds."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive3Odometry",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive3Odometry",
+ "tooltip": "Constructs a SwerveDriveOdometry object.\n\n:param kinematics: The swerve drive kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param modulePositions: The wheel positions reported by each module.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive3Odometry3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive3Odometry3d",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "tooltip": "Constructs an Odometry3d object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "tooltip": "Constructs an Odometry object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive3OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "functionName": "getModules",
+ "returnType": "Tuple[wpimath.geometry.Translation2d, wpimath.geometry.Translation2d, wpimath.geometry.Translation2d, wpimath.geometry.Translation2d]",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "functionName": "interpolate",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleHeadings",
+ "type": "Tuple[wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "functionName": "resetHeadings",
+ "returnType": "None",
+ "tooltip": "Reset the internal swerve module headings.\n\n:param moduleHeadings: The swerve module headings. The order of the module\n headings should be same as passed into the constructor of this class."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis state from the\ngiven module states. This method is often used for odometry -- determining\nthe robot's position on the field using data from the real-world speed and\nangle of each module on the robot.\n\n:param moduleStates: The state of the modules as an wpi::array of type\n SwerveModuleState, NumModules long as measured from respective encoders\n and gyros. The order of the swerve module states should be same as passed\n into the constructor of this class.\n\n:returns: The resulting chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": "Translation2d(x=0.000000, y=0.000000)",
+ "name": "centerOfRotation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "functionName": "toSwerveModuleStates",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": "Performs inverse kinematics to return the module states from a desired\nchassis velocity. This method is often used to convert joystick values into\nmodule speeds and angles.\n\nThis function also supports variable centers of rotation. During normal\noperations, the center of rotation is usually the same as the physical\ncenter of the robot; therefore, the argument is defaulted to that use case.\nHowever, if you wish to change the center of rotation for evasive\nmaneuvers, vision alignment, or for any other use case, you can do so.\n\n:param chassisSpeeds: The desired chassis speed.\n:param centerOfRotation: The center of rotation. For example, if you set the\n center of rotation at one corner of the robot and provide a chassis speed\n that only has a dtheta component, the robot will rotate around that corner.\n\n:returns: An array containing the module states. Use caution because these\n module states are not normalized. Sometimes, a user input may cause one of\n the module speeds to go above the attainable max velocity. Use the\n :meth:`desaturateWheelSpeeds` function to rectify this issue.\n In addition, you can use Python unpacking syntax\n to directly assign the module states to variables::\n\n fl, fr, bl, br = kinematics.toSwerveModuleStates(chassisSpeeds)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleDeltas",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the\ngiven module position deltas. This method is often used for odometry --\ndetermining the robot's position on the field using data from the\nreal-world position delta and angle of each module on the robot.\n\n:param moduleDeltas: The latest change in position of the modules (as a\n SwerveModulePosition type) as measured from respective encoders and gyros.\n The order of the swerve module states should be same as passed into the\n constructor of this class.\n\n:returns: The resulting Twist2d."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Kinematics",
+ "functionName": "toWheelSpeeds",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ },
+ {
+ "defaultValue": null,
+ "name": "desiredChassisSpeed",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxModuleSpeed",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxRobotTranslationSpeed",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxRobotRotationSpeed",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "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"
+ }
+ ]
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive4KinematicsBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4KinematicsBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive4KinematicsBase",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4KinematicsBase",
+ "functionName": "interpolate",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]",
+ "tooltip": "Performs interpolation between two values.\n\n:param start: The value to start at.\n:param end: The value to end at.\n:param t: How far between the two values to interpolate. This should be\n bounded to [0, 1].\n\n:returns: The interpolated value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelSpeeds",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4KinematicsBase",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis speed from the\nwheel speeds. This method is often used for odometry -- determining the\nrobot's position on the field using data from the real-world speed of each\nwheel on the robot.\n\n:param wheelSpeeds: The speeds of the wheels.\n\n:returns: The chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4KinematicsBase",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the given\nchange in wheel positions. This method is often used for odometry --\ndetermining the robot's position on the field using changes in the distance\ndriven by each wheel on the robot.\n\n:param start: The starting distances driven by the wheels.\n:param end: The ending distances driven by the wheels.\n\n:returns: The resulting Twist2d in the robot's movement."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4KinematicsBase",
+ "functionName": "toWheelSpeeds",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": "Performs inverse kinematics to return the wheel speeds from a desired\nchassis velocity. This method is often used to convert joystick values into\nwheel speeds.\n\n:param chassisSpeeds: The desired chassis speed.\n\n:returns: The wheel speeds."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive4Odometry",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive4Odometry",
+ "tooltip": "Constructs a SwerveDriveOdometry object.\n\n:param kinematics: The swerve drive kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param modulePositions: The wheel positions reported by each module.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive4Odometry3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive4Odometry3d",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "tooltip": "Constructs an Odometry3d object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "tooltip": "Constructs an Odometry object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive4OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg2",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg3",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg4",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg5",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "functionName": "getModules",
+ "returnType": "Tuple[wpimath.geometry.Translation2d, wpimath.geometry.Translation2d, wpimath.geometry.Translation2d, wpimath.geometry.Translation2d, wpimath.geometry.Translation2d, wpimath.geometry.Translation2d]",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "functionName": "interpolate",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleHeadings",
+ "type": "Tuple[wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d, wpimath.geometry.Rotation2d]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "functionName": "resetHeadings",
+ "returnType": "None",
+ "tooltip": "Reset the internal swerve module headings.\n\n:param moduleHeadings: The swerve module headings. The order of the module\n headings should be same as passed into the constructor of this class."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis state from the\ngiven module states. This method is often used for odometry -- determining\nthe robot's position on the field using data from the real-world speed and\nangle of each module on the robot.\n\n:param moduleStates: The state of the modules as an wpi::array of type\n SwerveModuleState, NumModules long as measured from respective encoders\n and gyros. The order of the swerve module states should be same as passed\n into the constructor of this class.\n\n:returns: The resulting chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": "Translation2d(x=0.000000, y=0.000000)",
+ "name": "centerOfRotation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "functionName": "toSwerveModuleStates",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": "Performs inverse kinematics to return the module states from a desired\nchassis velocity. This method is often used to convert joystick values into\nmodule speeds and angles.\n\nThis function also supports variable centers of rotation. During normal\noperations, the center of rotation is usually the same as the physical\ncenter of the robot; therefore, the argument is defaulted to that use case.\nHowever, if you wish to change the center of rotation for evasive\nmaneuvers, vision alignment, or for any other use case, you can do so.\n\n:param chassisSpeeds: The desired chassis speed.\n:param centerOfRotation: The center of rotation. For example, if you set the\n center of rotation at one corner of the robot and provide a chassis speed\n that only has a dtheta component, the robot will rotate around that corner.\n\n:returns: An array containing the module states. Use caution because these\n module states are not normalized. Sometimes, a user input may cause one of\n the module speeds to go above the attainable max velocity. Use the\n :meth:`desaturateWheelSpeeds` function to rectify this issue.\n In addition, you can use Python unpacking syntax\n to directly assign the module states to variables::\n\n fl, fr, bl, br = kinematics.toSwerveModuleStates(chassisSpeeds)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "moduleDeltas",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the\ngiven module position deltas. This method is often used for odometry --\ndetermining the robot's position on the field using data from the\nreal-world position delta and angle of each module on the robot.\n\n:param moduleDeltas: The latest change in position of the modules (as a\n SwerveModulePosition type) as measured from respective encoders and gyros.\n The order of the swerve module states should be same as passed into the\n constructor of this class.\n\n:returns: The resulting Twist2d."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Kinematics",
+ "functionName": "toWheelSpeeds",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleStates",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ },
+ {
+ "defaultValue": null,
+ "name": "desiredChassisSpeed",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxModuleSpeed",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxRobotTranslationSpeed",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "attainableMaxRobotRotationSpeed",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "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"
+ }
+ ]
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive6KinematicsBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6KinematicsBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive6KinematicsBase",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6KinematicsBase",
+ "functionName": "interpolate",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]",
+ "tooltip": "Performs interpolation between two values.\n\n:param start: The value to start at.\n:param end: The value to end at.\n:param t: How far between the two values to interpolate. This should be\n bounded to [0, 1].\n\n:returns: The interpolated value."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelSpeeds",
+ "type": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6KinematicsBase",
+ "functionName": "toChassisSpeeds",
+ "returnType": "wpimath.kinematics.ChassisSpeeds",
+ "tooltip": "Performs forward kinematics to return the resulting chassis speed from the\nwheel speeds. This method is often used for odometry -- determining the\nrobot's position on the field using data from the real-world speed of each\nwheel on the robot.\n\n:param wheelSpeeds: The speeds of the wheels.\n\n:returns: The chassis speed."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6KinematicsBase",
+ "functionName": "toTwist2d",
+ "returnType": "wpimath.geometry.Twist2d",
+ "tooltip": "Performs forward kinematics to return the resulting Twist2d from the given\nchange in wheel positions. This method is often used for odometry --\ndetermining the robot's position on the field using changes in the distance\ndriven by each wheel on the robot.\n\n:param start: The starting distances driven by the wheels.\n:param end: The ending distances driven by the wheels.\n\n:returns: The resulting Twist2d in the robot's movement."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "chassisSpeeds",
+ "type": "wpimath.kinematics.ChassisSpeeds"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6KinematicsBase",
+ "functionName": "toWheelSpeeds",
+ "returnType": "Tuple[wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState, wpimath.kinematics.SwerveModuleState]",
+ "tooltip": "Performs inverse kinematics to return the wheel speeds from a desired\nchassis velocity. This method is often used to convert joystick values into\nwheel speeds.\n\n:param chassisSpeeds: The desired chassis speed.\n\n:returns: The wheel speeds."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive6Odometry",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive6Odometry",
+ "tooltip": "Constructs a SwerveDriveOdometry object.\n\n:param kinematics: The swerve drive kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param modulePositions: The wheel positions reported by each module.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive6Odometry3d",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "modulePositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3d",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive6Odometry3d",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose3d(Translation3d(x=0.000000, y=0.000000, z=0.000000), Rotation3d(x=0.000000, y=0.000000, z=0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "tooltip": "Constructs an Odometry3d object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation3d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6Odometry3dBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6KinematicsBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "initialPose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "tooltip": "Constructs an Odometry object.\n\n:param kinematics: The kinematics for your drivetrain.\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param initialPose: The starting position of the robot on the field."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "getPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the position of the robot on the field.\n\n:returns: The pose of the robot."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "resetPose",
+ "returnType": "None",
+ "tooltip": "Resets the pose.\n\n:param pose: The pose to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "resetPosition",
+ "returnType": "None",
+ "tooltip": "Resets the robot's position on the field.\n\nThe gyroscope angle does not need to be reset here on the user's robot\ncode. The library automatically takes care of offsetting the gyro angle.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n:param pose: The position on the field that your robot is at."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "resetRotation",
+ "returnType": "None",
+ "tooltip": "Resets the rotation of the pose.\n\n:param rotation: The rotation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "translation",
+ "type": "wpimath.geometry.Translation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "resetTranslation",
+ "returnType": "None",
+ "tooltip": "Resets the translation of the pose.\n\n:param translation: The translation to reset to."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveDrive6OdometryBase"
+ },
+ {
+ "defaultValue": null,
+ "name": "gyroAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "wheelPositions",
+ "type": "Tuple[wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition, wpimath.kinematics.SwerveModulePosition]"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "functionName": "update",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Updates the robot's position on the field using forward kinematics and\nintegration of the pose over time. This method takes in an angle parameter\nwhich is used instead of the angular rate that is calculated from forward\nkinematics, in addition to the current distance measurement at each wheel.\n\n:param gyroAngle: The angle reported by the gyroscope.\n:param wheelPositions: The current distances measured by each wheel.\n\n:returns: The new pose of the robot."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveModulePosition",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "distance",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": "Rotation2d(0.000000)",
+ "name": "angle",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveModulePosition",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveModulePosition",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveModulePosition"
+ },
+ {
+ "defaultValue": null,
+ "name": "endValue",
+ "type": "wpimath.kinematics.SwerveModulePosition"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveModulePosition",
+ "functionName": "interpolate",
+ "returnType": "wpimath.kinematics.SwerveModulePosition",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "angle",
+ "tooltip": "Angle of the module.",
+ "type": "wpimath.geometry.Rotation2d",
+ "writable": true
+ },
+ {
+ "name": "distance",
+ "tooltip": "Distance the wheel of a module has traveled",
+ "type": "wpimath.units.meters",
+ "writable": true
+ },
+ {
+ "name": "distance_ft",
+ "tooltip": "",
+ "type": "wpimath.units.feet",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.kinematics.SwerveModuleState",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": "Rotation2d(0.000000)",
+ "name": "angle",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveModuleState",
+ "functionName": "__init__",
+ "returnType": "wpimath.kinematics.SwerveModuleState",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveModuleState"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveModuleState",
+ "functionName": "cosineScale",
+ "returnType": "None",
+ "tooltip": "Scales speed by cosine of angle error. This scales down movement\nperpendicular to the desired direction of travel that can occur when\nmodules change directions. This results in smoother driving.\n\n:param currentAngle: The current module angle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.kinematics.SwerveModuleState"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentAngle",
+ "type": "wpimath.geometry.Rotation2d"
+ }
+ ],
+ "declaringClassName": "wpimath.kinematics.SwerveModuleState",
+ "functionName": "optimize",
+ "returnType": "None",
+ "tooltip": "Minimize the change in the heading this swerve module state would\nrequire by potentially reversing the direction the wheel spins. If this is\nused with the PIDController class's continuous input functionality, the\nfurthest a wheel will ever rotate is 90 degrees.\n\n:param currentAngle: The current module angle."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "angle",
+ "tooltip": "Angle of the module.",
+ "type": "wpimath.geometry.Rotation2d",
+ "writable": true
+ },
+ {
+ "name": "speed",
+ "tooltip": "Speed of the wheel of the module.",
+ "type": "wpimath.units.meters_per_second",
+ "writable": true
+ },
+ {
+ "name": "speed_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.kinematics",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.optimization.SimulatedAnnealing",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "initialTemperature",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "neighbor",
+ "type": "Callable[[object], object]"
+ },
+ {
+ "defaultValue": null,
+ "name": "cost",
+ "type": "Callable[[object], float]"
+ }
+ ],
+ "declaringClassName": "wpimath.optimization.SimulatedAnnealing",
+ "functionName": "__init__",
+ "returnType": "wpimath.optimization.SimulatedAnnealing",
+ "tooltip": "Constructor for Simulated Annealing that can be used for the same functions\nbut with different initial states.\n\n:param initialTemperature: The initial temperature. Higher temperatures make\n it more likely a worse state will be accepted during iteration, helping\n to avoid local minima. The temperature is decreased over time.\n:param neighbor: Function that generates a random neighbor of the current\n state.\n:param cost: Function that returns the scalar cost of a state."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.optimization.SimulatedAnnealing"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialGuess",
+ "type": "object"
+ },
+ {
+ "defaultValue": null,
+ "name": "iterations",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.optimization.SimulatedAnnealing",
+ "functionName": "solve",
+ "returnType": "object",
+ "tooltip": "Runs the Simulated Annealing algorithm.\n\n:param initialGuess: The initial state.\n:param iterations: Number of iterations to run the solver.\n\n:returns: The optimized state."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.optimization",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.path.TravelingSalesman",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.path.TravelingSalesman",
+ "functionName": "__init__",
+ "returnType": "wpimath.path.TravelingSalesman",
+ "tooltip": "Constructs a traveling salesman problem solver with a cost function defined\nas the 2D distance between poses."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "cost",
+ "type": "Callable[[wpimath.geometry.Pose2d, wpimath.geometry.Pose2d], float]"
+ }
+ ],
+ "declaringClassName": "wpimath.path.TravelingSalesman",
+ "functionName": "__init__",
+ "returnType": "wpimath.path.TravelingSalesman",
+ "tooltip": "Constructs a traveling salesman problem solver with a user-provided cost\nfunction.\n\n:param cost: Function that returns the cost between two poses. The sum of\n the costs for every pair of poses is minimized."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.path.TravelingSalesman"
+ },
+ {
+ "defaultValue": null,
+ "name": "poses",
+ "type": "List[wpimath.geometry.Pose2d]"
+ },
+ {
+ "defaultValue": null,
+ "name": "iterations",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.path.TravelingSalesman",
+ "functionName": "solve",
+ "returnType": "list[wpimath.geometry.Pose2d]",
+ "tooltip": "Finds the path through every pose that minimizes the cost. The first pose\nin the returned array is the first pose that was passed in.\n\nThis overload supports a dynamically-sized list of poses for Python to use.\n\n:param poses: An array of Pose2ds the path must pass through.\n:param iterations: The number of times the solver attempts to find a better\n random neighbor.\n\n:returns: The optimized path as an array of Pose2ds."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.path",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.spline.CubicHermiteSpline",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "xInitialControlVector",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "xFinalControlVector",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "yInitialControlVector",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "yFinalControlVector",
+ "type": "Tuple[float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.CubicHermiteSpline",
+ "functionName": "__init__",
+ "returnType": "wpimath.spline.CubicHermiteSpline",
+ "tooltip": "Constructs a cubic hermite spline with the specified control vectors. Each\ncontrol vector contains info about the location of the point and its first\nderivative.\n\n:param xInitialControlVector: The control vector for the initial point in\n the x dimension.\n:param xFinalControlVector: The control vector for the final point in\n the x dimension.\n:param yInitialControlVector: The control vector for the initial point in\n the y dimension.\n:param yFinalControlVector: The control vector for the final point in\n the y dimension."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline3"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline3",
+ "functionName": "coefficients",
+ "returnType": "numpy.ndarray[numpy.float64[6, 4]]",
+ "tooltip": "Returns the coefficients of the spline.\n\n:returns: The coefficients of the spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.CubicHermiteSpline"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.CubicHermiteSpline",
+ "functionName": "getFinalControlVector",
+ "returnType": "wpimath.spline.Spline3.ControlVector",
+ "tooltip": "Returns the final control vector that created this spline.\n\n:returns: The final control vector that created this spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.CubicHermiteSpline"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.CubicHermiteSpline",
+ "functionName": "getInitialControlVector",
+ "returnType": "wpimath.spline.Spline3.ControlVector",
+ "tooltip": "Returns the initial control vector that created this spline.\n\n:returns: The initial control vector that created this spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline3"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline3",
+ "functionName": "getPoint",
+ "returnType": "Optional[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]",
+ "tooltip": "Gets the pose and curvature at some point t on the spline.\n\n:param t: The point t\n\n:returns: The pose and curvature at that point."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.spline",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.spline.QuinticHermiteSpline",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "xInitialControlVector",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "xFinalControlVector",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "yInitialControlVector",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "yFinalControlVector",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.QuinticHermiteSpline",
+ "functionName": "__init__",
+ "returnType": "wpimath.spline.QuinticHermiteSpline",
+ "tooltip": "Constructs a quintic hermite spline with the specified control vectors.\nEach control vector contains into about the location of the point, its\nfirst derivative, and its second derivative.\n\n:param xInitialControlVector: The control vector for the initial point in\n the x dimension.\n:param xFinalControlVector: The control vector for the final point in\n the x dimension.\n:param yInitialControlVector: The control vector for the initial point in\n the y dimension.\n:param yFinalControlVector: The control vector for the final point in\n the y dimension."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline5"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline5",
+ "functionName": "coefficients",
+ "returnType": "numpy.ndarray[numpy.float64[6, 6]]",
+ "tooltip": "Returns the coefficients of the spline.\n\n:returns: The coefficients of the spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.QuinticHermiteSpline"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.QuinticHermiteSpline",
+ "functionName": "getFinalControlVector",
+ "returnType": "wpimath.spline.Spline5.ControlVector",
+ "tooltip": "Returns the final control vector that created this spline.\n\n:returns: The final control vector that created this spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.QuinticHermiteSpline"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.QuinticHermiteSpline",
+ "functionName": "getInitialControlVector",
+ "returnType": "wpimath.spline.Spline5.ControlVector",
+ "tooltip": "Returns the initial control vector that created this spline.\n\n:returns: The initial control vector that created this spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline5"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline5",
+ "functionName": "getPoint",
+ "returnType": "Optional[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]",
+ "tooltip": "Gets the pose and curvature at some point t on the spline.\n\n:param t: The point t\n\n:returns: The pose and curvature at that point."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.spline",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.spline.Spline3",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.spline.Spline3",
+ "functionName": "__init__",
+ "returnType": "wpimath.spline.Spline3",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline3"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline3",
+ "functionName": "coefficients",
+ "returnType": "numpy.ndarray[numpy.float64[6, 4]]",
+ "tooltip": "Returns the coefficients of the spline.\n\n:returns: The coefficients of the spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline3"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline3",
+ "functionName": "getFinalControlVector",
+ "returnType": "wpimath.spline.Spline3.ControlVector",
+ "tooltip": "Returns the final control vector that created this spline.\n\n:returns: The final control vector that created this spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline3"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline3",
+ "functionName": "getInitialControlVector",
+ "returnType": "wpimath.spline.Spline3.ControlVector",
+ "tooltip": "Returns the initial control vector that created this spline.\n\n:returns: The initial control vector that created this spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline3"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline3",
+ "functionName": "getPoint",
+ "returnType": "Optional[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]",
+ "tooltip": "Gets the pose and curvature at some point t on the spline.\n\n:param t: The point t\n\n:returns: The pose and curvature at that point."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.spline",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.spline.Spline3.ControlVector",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "Tuple[float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "Tuple[float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline3.ControlVector",
+ "functionName": "__init__",
+ "returnType": "wpimath.spline.Spline3.ControlVector",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "x",
+ "tooltip": "The x components of the control vector.",
+ "type": "Tuple[float, float]",
+ "writable": true
+ },
+ {
+ "name": "y",
+ "tooltip": "The y components of the control vector.",
+ "type": "Tuple[float, float]",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.spline",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.spline.Spline5",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.spline.Spline5",
+ "functionName": "__init__",
+ "returnType": "wpimath.spline.Spline5",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline5"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline5",
+ "functionName": "coefficients",
+ "returnType": "numpy.ndarray[numpy.float64[6, 6]]",
+ "tooltip": "Returns the coefficients of the spline.\n\n:returns: The coefficients of the spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline5"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline5",
+ "functionName": "getFinalControlVector",
+ "returnType": "wpimath.spline.Spline5.ControlVector",
+ "tooltip": "Returns the final control vector that created this spline.\n\n:returns: The final control vector that created this spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline5"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline5",
+ "functionName": "getInitialControlVector",
+ "returnType": "wpimath.spline.Spline5.ControlVector",
+ "tooltip": "Returns the initial control vector that created this spline.\n\n:returns: The initial control vector that created this spline."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.spline.Spline5"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline5",
+ "functionName": "getPoint",
+ "returnType": "Optional[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]",
+ "tooltip": "Gets the pose and curvature at some point t on the spline.\n\n:param t: The point t\n\n:returns: The pose and curvature at that point."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.spline",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.spline.Spline5.ControlVector",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "Tuple[float, float, float]"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "Tuple[float, float, float]"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.Spline5.ControlVector",
+ "functionName": "__init__",
+ "returnType": "wpimath.spline.Spline5.ControlVector",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "x",
+ "tooltip": "The x components of the control vector.",
+ "type": "Tuple[float, float, float]",
+ "writable": true
+ },
+ {
+ "name": "y",
+ "tooltip": "The y components of the control vector.",
+ "type": "Tuple[float, float, float]",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.spline",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.spline.SplineHelper",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.spline.SplineHelper",
+ "functionName": "__init__",
+ "returnType": "wpimath.spline.SplineHelper",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpimath.spline",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "interiorWaypoints",
+ "type": "list[wpimath.geometry.Translation2d]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.SplineHelper",
+ "functionName": "cubicControlVectorsFromWaypoints",
+ "returnType": "Tuple[wpimath.spline.Spline3.ControlVector, wpimath.spline.Spline3.ControlVector]",
+ "tooltip": "Returns 2 cubic control vectors from a set of exterior waypoints and\ninterior translations.\n\n:param start: The starting pose.\n:param interiorWaypoints: The interior waypoints.\n:param end: The ending pose.\n\n:returns: 2 cubic control vectors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.spline.Spline3.ControlVector"
+ },
+ {
+ "defaultValue": null,
+ "name": "waypoints",
+ "type": "list[wpimath.geometry.Translation2d]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.spline.Spline3.ControlVector"
+ }
+ ],
+ "declaringClassName": "wpimath.spline.SplineHelper",
+ "functionName": "cubicSplinesFromControlVectors",
+ "returnType": "list[wpimath.spline.CubicHermiteSpline]",
+ "tooltip": "Returns a set of cubic splines corresponding to the provided control\nvectors. The user is free to set the direction of the start and end\npoint. The directions for the middle waypoints are determined\nautomatically to ensure continuous curvature throughout the path.\n\nThe derivation for the algorithm used can be found here:\n\n\n:param start: The starting control vector.\n:param waypoints: The middle waypoints. This can be left blank if you\n only wish to create a path with two waypoints.\n:param end: The ending control vector.\n\n:returns: A vector of cubic hermite splines that interpolate through the\n provided waypoints."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "splines",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": [],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpimath.spline",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "spline",
+ "type": "wpimath.spline.Spline3"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "t0",
+ "type": "float"
+ },
+ {
+ "defaultValue": "1.0",
+ "name": "t1",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "spline",
+ "type": "wpimath.spline.Spline5"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "t0",
+ "type": "float"
+ },
+ {
+ "defaultValue": "1.0",
+ "name": "t1",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampFunction",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "feedforward",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "feedforward",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampFunction",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]]], numpy.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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the controller's calculated control input u."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1",
+ "functionName": "clampInput",
+ "returnType": "numpy.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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1",
+ "functionName": "error",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns difference between reference r and current state x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1",
+ "functionName": "nextR",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the controller's next reference r."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_1_1_1",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the observer's state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "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_2_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1",
+ "functionName": "__init__",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampFunction",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1",
+ "functionName": "__init__",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "feedforward",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1",
+ "functionName": "__init__",
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "feedforward",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampFunction",
+ "type": "Callable[[numpy.ndarray[numpy.float64[1, 1]]], numpy.ndarray[numpy.float64[1, 1]]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1",
+ "functionName": "__init__",
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the controller's calculated control input u."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1",
+ "functionName": "clampInput",
+ "returnType": "numpy.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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1",
+ "functionName": "error",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns difference between reference r and current state x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1",
+ "functionName": "nextR",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the controller's next reference r."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[2, 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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1",
+ "functionName": "setNextR",
+ "returnType": "None",
+ "tooltip": "Set the next reference r.\n\n:param nextR: Next reference."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[2, 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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_1_1",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the observer's state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystemLoop_2_2_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystemLoop_2_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampFunction",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystemLoop_2_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "feedforward",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystemLoop_2_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "feedforward",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampFunction",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystemLoop_2_2_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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the controller's calculated control input u."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "clampInput",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "correct",
+ "returnType": "None",
+ "tooltip": "Correct the state estimate x-hat using the measurements in y.\n\n:param y: Measurement vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "error",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns difference between reference r and current state x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "nextR",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the controller's next reference r."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "nextR",
+ "returnType": "float",
+ "tooltip": "Returns an element of the controller's next reference r.\n\n:param i: Row of r."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "setNextR",
+ "returnType": "None",
+ "tooltip": "Set the next reference r.\n\n:param nextR: Next reference."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "setXhat",
+ "returnType": "None",
+ "tooltip": "Set the initial state estimate x-hat.\n\n:param xHat: The initial state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_2",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the observer's state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_2_2_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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystemLoop_3_2_3",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystemLoop_3_2_3",
+ "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": null,
+ "name": "plant",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampFunction",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystemLoop_3_2_3",
+ "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": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "feedforward",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystemLoop_3_2_3",
+ "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": null,
+ "name": "controller",
+ "type": "wpimath.controller.LinearQuadraticRegulator_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "feedforward",
+ "type": "wpimath.controller.LinearPlantInversionFeedforward_3_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "observer",
+ "type": "wpimath.estimator.KalmanFilter_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampFunction",
+ "type": "Callable[[numpy.ndarray[numpy.float64[2, 1]]], numpy.ndarray[numpy.float64[2, 1]]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystemLoop_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "U",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the controller's calculated control input u."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "u",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "clampInput",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "correct",
+ "returnType": "None",
+ "tooltip": "Correct the state estimate x-hat using the measurements in y.\n\n:param y: Measurement vector."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "error",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns difference between reference r and current state x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "nextR",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns the controller's next reference r."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "nextR",
+ "returnType": "float",
+ "tooltip": "Returns an element of the controller's next reference r.\n\n:param i: Row of r."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialState",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "nextR",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "setNextR",
+ "returnType": "None",
+ "tooltip": "Set the next reference r.\n\n:param nextR: Next reference."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "xHat",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "setXhat",
+ "returnType": "None",
+ "tooltip": "Set the initial state estimate x-hat.\n\n:param xHat: The initial state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "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": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "functionName": "xhat",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns the observer's state estimate x-hat."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystemLoop_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystemLoop_3_2_3",
+ "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.LinearSystem_1_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_1_1_1",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_1",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_1_1_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_1_1_2",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_2",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_1_1_3",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_1_1_3",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_1_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_1_1_3",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_2_1_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[1, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_2_1_1",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[1, 2]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[1, 1]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_1",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_2_1_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_2_1_2",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_2",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_2_1_3",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_2_1_3",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[2, 1]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[3, 2]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[3, 1]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_1_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[1, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_1_3",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_2_2_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[1, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[1, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_2_2_1",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[1, 2]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[1, 2]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_1",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_2_2_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_2_2_2",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_2",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_2_2_3",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_2_2_3",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[3, 2]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[3, 2]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_2_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_2_2_3",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_3_2_1",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[1, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[1, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_3_2_1",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[3, 3]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[3, 2]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[1, 3]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[1, 2]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_1"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_1",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_3_2_2",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[2, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[2, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_3_2_2",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[3, 3]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[3, 2]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[2, 3]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[2, 2]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_2"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_2",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.LinearSystem_3_2_3",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "A",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "B",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "C",
+ "type": "numpy.ndarray[numpy.float64[3, 3]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "D",
+ "type": "numpy.ndarray[numpy.float64[3, 2]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.LinearSystem_3_2_3",
+ "tooltip": "Constructs a discrete plant with the given continuous system coefficients.\n\n:param A: System matrix.\n:param B: Input matrix.\n:param C: Output matrix.\n:param D: Feedthrough matrix.\n @throws std::domain_error if any matrix element isn't finite."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "A",
+ "returnType": "numpy.ndarray[numpy.float64[3, 3]]",
+ "tooltip": "Returns the system matrix A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "A",
+ "returnType": "float",
+ "tooltip": "Returns an element of the system matrix A.\n\n:param i: Row of A.\n:param j: Column of A."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "B",
+ "returnType": "numpy.ndarray[numpy.float64[3, 2]]",
+ "tooltip": "Returns the input matrix B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "B",
+ "returnType": "float",
+ "tooltip": "Returns an element of the input matrix B.\n\n:param i: Row of B.\n:param j: Column of B."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "C",
+ "returnType": "numpy.ndarray[numpy.float64[3, 3]]",
+ "tooltip": "Returns the output matrix C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "C",
+ "returnType": "float",
+ "tooltip": "Returns an element of the output matrix C.\n\n:param i: Row of C.\n:param j: Column of C."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "D",
+ "returnType": "numpy.ndarray[numpy.float64[3, 2]]",
+ "tooltip": "Returns the feedthrough matrix D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "j",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "D",
+ "returnType": "float",
+ "tooltip": "Returns an element of the feedthrough matrix D.\n\n:param i: Row of D.\n:param j: Column of D."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "dt",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "calculateX",
+ "returnType": "numpy.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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.LinearSystem_3_2_3"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "clampedU",
+ "type": "numpy.ndarray[numpy.float64[2, 1]]"
+ }
+ ],
+ "declaringClassName": "wpimath.system.LinearSystem_3_2_3",
+ "functionName": "calculateY",
+ "returnType": "numpy.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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.system.plant.DCMotor",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "nominalVoltage",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "stallTorque",
+ "type": "wpimath.units.newton_meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "stallCurrent",
+ "type": "wpimath.units.amperes"
+ },
+ {
+ "defaultValue": null,
+ "name": "freeCurrent",
+ "type": "wpimath.units.amperes"
+ },
+ {
+ "defaultValue": null,
+ "name": "freeSpeed",
+ "type": "wpimath.units.radians_per_second"
+ },
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Constructs a DC motor.\n\n:param nominalVoltage: Voltage at which the motor constants were measured.\n:param stallTorque: Torque when stalled.\n:param stallCurrent: Current draw when stalled.\n:param freeCurrent: Current draw under no load.\n:param freeSpeed: Angular velocity under no load.\n:param numMotors: Number of motors in a gearbox."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.radians_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "current",
+ "returnType": "wpimath.units.amperes",
+ "tooltip": "Returns current drawn by motor with given speed and input voltage.\n\n:param speed: The current angular velocity of the motor.\n:param inputVoltage: The voltage being applied to the motor."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "torque",
+ "type": "wpimath.units.newton_meters"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "current",
+ "returnType": "wpimath.units.amperes",
+ "tooltip": "Returns current drawn by motor for a given torque.\n\n:param torque: The torque produced by the motor."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "torque",
+ "type": "wpimath.units.newton_meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "inputVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "speed",
+ "returnType": "wpimath.units.radians_per_second",
+ "tooltip": "Returns the angular speed produced by the motor at a given torque and input\nvoltage.\n\n:param torque: The torque produced by the motor.\n:param inputVoltage: The input voltage provided to the motor."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "current",
+ "type": "wpimath.units.amperes"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "torque",
+ "returnType": "wpimath.units.newton_meters",
+ "tooltip": "Returns torque produced by the motor with a given current.\n\n:param current: The current drawn by the motor."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "torque",
+ "type": "wpimath.units.newton_meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "voltage",
+ "returnType": "wpimath.units.volts",
+ "tooltip": "Returns the voltage provided to the motor for a given torque and\nangular velocity.\n\n:param torque: The torque produced by the motor.\n:param speed: The current angular velocity of the motor."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearboxReduction",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "withReduction",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a copy of this motor with the given gearbox reduction applied.\n\n:param gearboxReduction: The gearbox reduction."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "Kt",
+ "tooltip": "Motor torque constant.",
+ "type": "wpimath.units.volt_seconds",
+ "writable": null
+ },
+ {
+ "name": "Kv",
+ "tooltip": "Motor velocity constant.",
+ "type": "wpimath.units.radians_per_second_per_volt",
+ "writable": null
+ },
+ {
+ "name": "R",
+ "tooltip": "Motor internal resistance.",
+ "type": "wpimath.units.ohms",
+ "writable": null
+ },
+ {
+ "name": "freeCurrent",
+ "tooltip": "Current draw under no load.",
+ "type": "wpimath.units.amperes",
+ "writable": null
+ },
+ {
+ "name": "freeSpeed",
+ "tooltip": "Angular velocity under no load.",
+ "type": "wpimath.units.radians_per_second",
+ "writable": null
+ },
+ {
+ "name": "nominalVoltage",
+ "tooltip": "Voltage at which the motor constants were measured.",
+ "type": "wpimath.units.volts",
+ "writable": null
+ },
+ {
+ "name": "stallCurrent",
+ "tooltip": "Current draw when stalled.",
+ "type": "wpimath.units.amperes",
+ "writable": null
+ },
+ {
+ "name": "stallTorque",
+ "tooltip": "Torque when stalled.",
+ "type": "wpimath.units.newton_meters",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.system.plant",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "CIM",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of CIM motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "NEO",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of NEO brushless motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "NEO550",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of NEO 550 brushless motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "RS775_125",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of Andymark RS 775-125 motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "andymark9015",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of Andymark 9015 motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "bag",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of Bag motor motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "banebotsRS550",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of Banebots RS 550 motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "banebotsRS775",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of Banebots RS 775 motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "falcon500",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of Falcon 500 brushless motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "falcon500FOC",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Return a gearbox of Falcon 500 motors with FOC (Field-Oriented Control)\nenabled."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "krakenX60",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Return a gearbox of Kraken X60 brushless motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "krakenX60FOC",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Return a gearbox of Kraken X60 brushless motors with FOC (Field-Oriented\nControl) enabled."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "miniCIM",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of MiniCIM motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "neoVortex",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Return a gearbox of Neo Vortex brushless motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "romiBuiltIn",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Return a gearbox of Romi/TI_RSLK MAX motors."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": "1",
+ "name": "numMotors",
+ "type": "int"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.DCMotor",
+ "functionName": "vex775Pro",
+ "returnType": "wpimath.system.plant.DCMotor",
+ "tooltip": "Returns a gearbox of Vex 775 Pro motors."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.system.plant.LinearSystemId",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.system.plant.LinearSystemId",
+ "functionName": "__init__",
+ "returnType": "wpimath.system.plant.LinearSystemId",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpimath.system.plant",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "motor",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "J",
+ "type": "wpimath.units.kilogram_square_meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ }
+ ],
+ "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"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_meter"
+ }
+ ],
+ "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)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_radian"
+ },
+ {
+ "defaultValue": null,
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_radian"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.LinearSystemId",
+ "functionName": "DCMotorSystemRadians",
+ "returnType": "wpimath.system.LinearSystem_2_1_2",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "motor",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "mass",
+ "type": "wpimath.units.kilograms"
+ },
+ {
+ "defaultValue": null,
+ "name": "r",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rb",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "J",
+ "type": "wpimath.units.kilogram_square_meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "motor",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "mass",
+ "type": "wpimath.units.kilograms"
+ },
+ {
+ "defaultValue": null,
+ "name": "radius",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "motor",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "J",
+ "type": "wpimath.units.kilogram_square_meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.LinearSystemId",
+ "functionName": "flywheelSystem",
+ "returnType": "wpimath.system.LinearSystem_1_1_1",
+ "tooltip": "Create a state-space model of a flywheel system, the states of the system\nare [angular velocity], inputs are [voltage], and outputs are [angular\nvelocity].\n\n:param motor: The motor (or gearbox) attached to the flywheel.\n:param J: The moment of inertia J of the flywheel.\n:param gearing: Gear ratio from motor to flywheel.\n @throws std::domain_error if J <= 0 or gearing <= 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kVLinear",
+ "type": "wpimath.units.volt_seconds_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "kALinear",
+ "type": "wpimath.units.volt_seconds_squared_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "kVAngular",
+ "type": "wpimath.units.volt_seconds_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "kAAngular",
+ "type": "wpimath.units.volt_seconds_squared_per_meter"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.LinearSystemId",
+ "functionName": "identifyDrivetrainSystem",
+ "returnType": "wpimath.system.LinearSystem_2_2_2",
+ "tooltip": "Identify a differential drive drivetrain given the drivetrain's kV and kA\nin both linear {(volts/(meter/sec), (volts/(meter/sec\u00b2))} and angular\n{(volts/(radian/sec), (volts/(radian/sec\u00b2))} cases. These constants can be\nfound using SysId.\n\nStates: [[left velocity], [right velocity]]\nInputs: [[left voltage], [right voltage]]\nOutputs: [[left velocity], [right velocity]]\n\n:param kVLinear: The linear velocity gain in volts per (meters per second).\n:param kALinear: The linear acceleration gain in volts per (meters per\n second squared).\n:param kVAngular: The angular velocity gain in volts per (meters per\n second).\n:param kAAngular: The angular acceleration gain in volts per (meters per\n second squared).\n @throws domain_error if kVLinear <= 0, kALinear <= 0, kVAngular <= 0,\n or kAAngular <= 0.\n @see https://github.com/wpilibsuite/sysid"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kVLinear",
+ "type": "wpimath.units.volt_seconds_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "kALinear",
+ "type": "wpimath.units.volt_seconds_squared_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "kVAngular",
+ "type": "wpimath.units.volt_seconds_per_radian"
+ },
+ {
+ "defaultValue": null,
+ "name": "kAAngular",
+ "type": "wpimath.units.volt_seconds_squared_per_radian"
+ },
+ {
+ "defaultValue": null,
+ "name": "trackwidth",
+ "type": "wpimath.units.meters"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.LinearSystemId",
+ "functionName": "identifyDrivetrainSystem",
+ "returnType": "wpimath.system.LinearSystem_2_2_2",
+ "tooltip": "Identify a differential drive drivetrain given the drivetrain's kV and kA\nin both linear {(volts/(meter/sec)), (volts/(meter/sec\u00b2))} and angular\n{(volts/(radian/sec)), (volts/(radian/sec\u00b2))} cases. This can be found\nusing SysId.\n\nStates: [[left velocity], [right velocity]]\nInputs: [[left voltage], [right voltage]]\nOutputs: [[left velocity], [right velocity]]\n\n:param kVLinear: The linear velocity gain in volts per (meters per\n second).\n:param kALinear: The linear acceleration gain in volts per (meters per\n second squared).\n:param kVAngular: The angular velocity gain in volts per (radians per\n second).\n:param kAAngular: The angular acceleration gain in volts per (radians per\n second squared).\n:param trackwidth: The distance between the differential drive's left and\n right wheels, in meters.\n @throws domain_error if kVLinear <= 0, kALinear <= 0, kVAngular <= 0,\n kAAngular <= 0, or trackwidth <= 0.\n @see https://github.com/wpilibsuite/sysid"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_meter"
+ }
+ ],
+ "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)."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_radian"
+ },
+ {
+ "defaultValue": null,
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_radian"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.LinearSystemId",
+ "functionName": "identifyPositionSystemRadians",
+ "returnType": "wpimath.system.LinearSystem_2_1_1",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_meter"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.LinearSystemId",
+ "functionName": "identifyVelocitySystemMeters",
+ "returnType": "wpimath.system.LinearSystem_1_1_1",
+ "tooltip": "Create a state-space model for a 1 DOF velocity 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 [velocity], inputs are\n[voltage], and outputs are [velocity].\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:param kV: The velocity gain, in volts/(unit/sec).\n:param kA: The acceleration gain, in volts/(unit/sec\u00b2).\n @throws std::domain_error if kV < 0 or kA <= 0.\n @see https://github.com/wpilibsuite/sysid"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_radian"
+ },
+ {
+ "defaultValue": null,
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_radian"
+ }
+ ],
+ "declaringClassName": "wpimath.system.plant.LinearSystemId",
+ "functionName": "identifyVelocitySystemRadians",
+ "returnType": "wpimath.system.LinearSystem_1_1_1",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "motor",
+ "type": "wpimath.system.plant.DCMotor"
+ },
+ {
+ "defaultValue": null,
+ "name": "J",
+ "type": "wpimath.units.kilogram_square_meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "gearing",
+ "type": "float"
+ }
+ ],
+ "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."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.ExponentialProfileMeterVolts",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "constraints",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.Constraints"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.ExponentialProfileMeterVolts",
+ "tooltip": "Constructs a ExponentialProfile.\n\n:param constraints: The constraints on the profile, like maximum input."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "current",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.State"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.State"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts",
+ "functionName": "calculate",
+ "returnType": "wpimath.trajectory.ExponentialProfileMeterVolts.State",
+ "tooltip": "Calculates the position and velocity for the profile at a time t where the\ncurrent state is at time t = 0.\n\n:param t: How long to advance from the current state toward the desired\n state.\n:param current: The current state.\n:param goal: The desired state when the profile is complete.\n\n:returns: The position and velocity of the profile at time t."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts"
+ },
+ {
+ "defaultValue": null,
+ "name": "current",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.State"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.State"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts",
+ "functionName": "calculateInflectionPoint",
+ "returnType": "wpimath.trajectory.ExponentialProfileMeterVolts.State",
+ "tooltip": "Calculates the point after which the fastest way to reach the goal state is\nto apply input in the opposite direction.\n\n:param current: The current state.\n:param goal: The desired state when the profile is complete.\n\n:returns: The position and velocity of the profile at the inflection point."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts"
+ },
+ {
+ "defaultValue": null,
+ "name": "current",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.State"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.State"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts",
+ "functionName": "calculateProfileTiming",
+ "returnType": "wpimath.trajectory.ExponentialProfileMeterVolts.ProfileTiming",
+ "tooltip": "Calculates the time it will take for this profile to reach the inflection\npoint, and the time it will take for this profile to reach the goal state.\n\n:param current: The current state.\n:param goal: The desired state when the profile is complete.\n\n:returns: The timing information for this profile."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts"
+ },
+ {
+ "defaultValue": null,
+ "name": "current",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.State"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.State"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts",
+ "functionName": "timeLeftUntil",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": "Calculates the time it will take for this profile to reach the goal state.\n\n:param current: The current state.\n:param goal: The desired state when the profile is complete.\n\n:returns: The total duration of this profile."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.ExponentialProfileMeterVolts.Constraints",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.Constraints"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts.Constraints",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": "Computes the max achievable velocity for an Exponential Profile.\n\n:returns: The steady-state velocity achieved by this profile."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "A",
+ "tooltip": "The State-Space 1x1 system matrix.",
+ "type": "wpimath.units.units_per_second",
+ "writable": null
+ },
+ {
+ "name": "B",
+ "tooltip": "The State-Space 1x1 input matrix.",
+ "type": "wpimath.units.meters_per_second_squared_per_volt",
+ "writable": null
+ },
+ {
+ "name": "maxInput",
+ "tooltip": "Maximum unsigned input voltage.",
+ "type": "wpimath.units.volts",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "maxInput",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "kV",
+ "type": "wpimath.units.volt_seconds_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "kA",
+ "type": "wpimath.units.volt_seconds_squared_per_meter"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts.Constraints",
+ "functionName": "fromCharacteristics",
+ "returnType": "wpimath.trajectory.ExponentialProfileMeterVolts.Constraints",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "maxInput",
+ "type": "wpimath.units.volts"
+ },
+ {
+ "defaultValue": null,
+ "name": "a",
+ "type": "wpimath.units.units_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "b",
+ "type": "wpimath.units.meters_per_second_squared_per_volt"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts.Constraints",
+ "functionName": "fromStateSpace",
+ "returnType": "wpimath.trajectory.ExponentialProfileMeterVolts.Constraints",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.ExponentialProfileMeterVolts.ProfileTiming",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts.ProfileTiming",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.ExponentialProfileMeterVolts.ProfileTiming",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.ExponentialProfileMeterVolts.ProfileTiming"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts.ProfileTiming",
+ "functionName": "isFinished",
+ "returnType": "bool",
+ "tooltip": "Decides if the profile is finished by time t.\n\n:param t: The time since the beginning of the profile.\n\n:returns: if the profile is finished at time t."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "inflectionTime",
+ "tooltip": "Profile inflection time.",
+ "type": "wpimath.units.seconds",
+ "writable": null
+ },
+ {
+ "name": "totalTime",
+ "tooltip": "Total profile time.",
+ "type": "wpimath.units.seconds",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.ExponentialProfileMeterVolts.State",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arg0",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "arg1",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.ExponentialProfileMeterVolts.State",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.ExponentialProfileMeterVolts.State",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "position",
+ "tooltip": "The position at this state.",
+ "type": "wpimath.units.meters",
+ "writable": null
+ },
+ {
+ "name": "velocity",
+ "tooltip": "The velocity at this state.",
+ "type": "wpimath.units.meters_per_second",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.Trajectory",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.trajectory.Trajectory",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.Trajectory",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "states",
+ "type": "list[wpimath.trajectory.Trajectory.State]"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.Trajectory",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.Trajectory",
+ "tooltip": "Constructs a trajectory from a vector of states.\n\n@throws std::invalid_argument if the vector of states is empty."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.Trajectory"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.Trajectory",
+ "functionName": "initialPose",
+ "returnType": "wpimath.geometry.Pose2d",
+ "tooltip": "Returns the initial pose of the trajectory.\n\n:returns: The initial pose of the trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.Trajectory"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.Trajectory",
+ "functionName": "relativeTo",
+ "returnType": "wpimath.trajectory.Trajectory",
+ "tooltip": "Transforms all poses in the trajectory so that they are relative to the\ngiven pose. This is useful for converting a field-relative trajectory\ninto a robot-relative trajectory.\n\n:param pose: The pose that is the origin of the coordinate frame that\n the current trajectory will be transformed into.\n\n:returns: The transformed trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.Trajectory"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.Trajectory",
+ "functionName": "sample",
+ "returnType": "wpimath.trajectory.Trajectory.State",
+ "tooltip": "Sample the trajectory at a point in time.\n\n:param t: The point in time since the beginning of the trajectory to sample.\n\n:returns: The state at that point in time.\n @throws std::runtime_error if the trajectory has no states."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.Trajectory"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.Trajectory",
+ "functionName": "states",
+ "returnType": "list[wpimath.trajectory.Trajectory.State]",
+ "tooltip": "Return the states of the trajectory.\n\n:returns: The states of the trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.Trajectory"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.Trajectory",
+ "functionName": "totalTime",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": "Returns the overall duration of the trajectory.\n\n:returns: The duration of the trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.Trajectory"
+ },
+ {
+ "defaultValue": null,
+ "name": "transform",
+ "type": "wpimath.geometry.Transform2d"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.Trajectory",
+ "functionName": "transformBy",
+ "returnType": "wpimath.trajectory.Trajectory",
+ "tooltip": "Transforms all poses in the trajectory by the given transform. This is\nuseful for converting a robot-relative trajectory into a field-relative\ntrajectory. This works with respect to the first pose in the trajectory.\n\n:param transform: The transform to transform the trajectory by.\n\n:returns: The transformed trajectory."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.Trajectory.State",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0.0",
+ "name": "t",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "acceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ },
+ {
+ "defaultValue": "Pose2d(Translation2d(x=0.000000, y=0.000000), Rotation2d(0.000000))",
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": "0.0",
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.Trajectory.State",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.Trajectory.State",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.Trajectory.State"
+ },
+ {
+ "defaultValue": null,
+ "name": "endValue",
+ "type": "wpimath.trajectory.Trajectory.State"
+ },
+ {
+ "defaultValue": null,
+ "name": "i",
+ "type": "float"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.Trajectory.State",
+ "functionName": "interpolate",
+ "returnType": "wpimath.trajectory.Trajectory.State",
+ "tooltip": "Interpolates between two States.\n\n:param endValue: The end value for the interpolation.\n:param i: The interpolant (fraction).\n\n:returns: The interpolated state."
+ }
+ ],
+ "instanceVariables": [
+ {
+ "name": "acceleration",
+ "tooltip": "The acceleration at that point of the trajectory.",
+ "type": "wpimath.units.meters_per_second_squared",
+ "writable": true
+ },
+ {
+ "name": "acceleration_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second_squared",
+ "writable": null
+ },
+ {
+ "name": "curvature",
+ "tooltip": "",
+ "type": "wpimath.units.radians_per_meter",
+ "writable": true
+ },
+ {
+ "name": "pose",
+ "tooltip": "The pose at that point of the trajectory.",
+ "type": "wpimath.geometry.Pose2d",
+ "writable": true
+ },
+ {
+ "name": "t",
+ "tooltip": "The time elapsed since the beginning of the trajectory.",
+ "type": "wpimath.units.seconds",
+ "writable": true
+ },
+ {
+ "name": "velocity",
+ "tooltip": "The speed at that point of the trajectory.",
+ "type": "wpimath.units.meters_per_second",
+ "writable": true
+ },
+ {
+ "name": "velocity_fps",
+ "tooltip": "",
+ "type": "wpimath.units.feet_per_second",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.TrajectoryConfig",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "maxVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAcceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.TrajectoryConfig",
+ "tooltip": "Constructs a config object.\n\n:param maxVelocity: The max velocity of the trajectory.\n:param maxAcceleration: The max acceleration of the trajectory."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraint",
+ "type": "wpimath.trajectory.constraint.TrajectoryConstraint"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "addConstraint",
+ "returnType": "None",
+ "tooltip": "Adds a user-defined constraint to the trajectory.\n\n:param constraint: The user-defined constraint."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "endVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": "Returns the ending velocity of the trajectory.\n\n:returns: The ending velocity of the trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "isReversed",
+ "returnType": "bool",
+ "tooltip": "Returns whether the trajectory is reversed or not.\n\n:returns: whether the trajectory is reversed or not."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "maxAcceleration",
+ "returnType": "wpimath.units.meters_per_second_squared",
+ "tooltip": "Returns the maximum acceleration of the trajectory.\n\n:returns: The maximum acceleration of the trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": "Returns the maximum velocity of the trajectory.\n\n:returns: The maximum velocity of the trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ },
+ {
+ "defaultValue": null,
+ "name": "endVelocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "setEndVelocity",
+ "returnType": "None",
+ "tooltip": "Sets the end velocity of the trajectory.\n\n:param endVelocity: The end velocity of the trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ },
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "setKinematics",
+ "returnType": "None",
+ "tooltip": "Adds a differential drive kinematics constraint to ensure that\nno wheel velocity of a differential drive goes above the max velocity.\n\n:param kinematics: The differential drive kinematics."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ },
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "setKinematics",
+ "returnType": "None",
+ "tooltip": "Adds a mecanum drive kinematics constraint to ensure that\nno wheel velocity of a mecanum drive goes above the max velocity.\n\n:param kinematics: The mecanum drive kinematics."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ },
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "setKinematics",
+ "returnType": "None",
+ "tooltip": "Adds a swerve drive kinematics constraint to ensure that\nno wheel velocity of a swerve drive goes above the max velocity.\n\n:param kinematics: The swerve drive kinematics."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ },
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "setKinematics",
+ "returnType": "None",
+ "tooltip": "Adds a swerve drive kinematics constraint to ensure that\nno wheel velocity of a swerve drive goes above the max velocity.\n\n:param kinematics: The swerve drive kinematics."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ },
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "setKinematics",
+ "returnType": "None",
+ "tooltip": "Adds a swerve drive kinematics constraint to ensure that\nno wheel velocity of a swerve drive goes above the max velocity.\n\n:param kinematics: The swerve drive kinematics."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ },
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "setKinematics",
+ "returnType": "None",
+ "tooltip": "Adds a swerve drive kinematics constraint to ensure that\nno wheel velocity of a swerve drive goes above the max velocity.\n\n:param kinematics: The swerve drive kinematics."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ },
+ {
+ "defaultValue": null,
+ "name": "reversed",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "setReversed",
+ "returnType": "None",
+ "tooltip": "Sets the reversed flag of the trajectory.\n\n:param reversed: Whether the trajectory should be reversed or not."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ },
+ {
+ "defaultValue": null,
+ "name": "startVelocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "setStartVelocity",
+ "returnType": "None",
+ "tooltip": "Sets the start velocity of the trajectory.\n\n:param startVelocity: The start velocity of the trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "startVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": "Returns the starting velocity of the trajectory.\n\n:returns: The starting velocity of the trajectory."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "maxVelocity",
+ "type": "wpimath.units.feet_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAcceleration",
+ "type": "wpimath.units.feet_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryConfig",
+ "functionName": "fromFps",
+ "returnType": "wpimath.trajectory.TrajectoryConfig",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.TrajectoryGenerator",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.trajectory.TrajectoryGenerator",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.TrajectoryGenerator",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "initial",
+ "type": "wpimath.spline.Spline3.ControlVector"
+ },
+ {
+ "defaultValue": null,
+ "name": "interiorWaypoints",
+ "type": "list[wpimath.geometry.Translation2d]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.spline.Spline3.ControlVector"
+ },
+ {
+ "defaultValue": null,
+ "name": "config",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryGenerator",
+ "functionName": "generateTrajectory",
+ "returnType": "wpimath.trajectory.Trajectory",
+ "tooltip": "Generates a trajectory from the given control vectors and config. This\nmethod uses clamped cubic splines -- a method in which the exterior control\nvectors and interior waypoints are provided. The headings are automatically\ndetermined at the interior points to ensure continuous curvature.\n\n:param initial: The initial control vector.\n:param interiorWaypoints: The interior waypoints.\n:param end: The ending control vector.\n:param config: The configuration for the trajectory.\n\n:returns: The generated trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "start",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "interiorWaypoints",
+ "type": "list[wpimath.geometry.Translation2d]"
+ },
+ {
+ "defaultValue": null,
+ "name": "end",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "config",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryGenerator",
+ "functionName": "generateTrajectory",
+ "returnType": "wpimath.trajectory.Trajectory",
+ "tooltip": "Generates a trajectory from the given waypoints and config. This method\nuses clamped cubic splines -- a method in which the initial pose, final\npose, and interior waypoints are provided. The headings are automatically\ndetermined at the interior points to ensure continuous curvature.\n\n:param start: The starting pose.\n:param interiorWaypoints: The interior waypoints.\n:param end: The ending pose.\n:param config: The configuration for the trajectory.\n\n:returns: The generated trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "controlVectors",
+ "type": "list[wpimath.spline.Spline5.ControlVector]"
+ },
+ {
+ "defaultValue": null,
+ "name": "config",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryGenerator",
+ "functionName": "generateTrajectory",
+ "returnType": "wpimath.trajectory.Trajectory",
+ "tooltip": "Generates a trajectory from the given quintic control vectors and config.\nThis method uses quintic hermite splines -- therefore, all points must be\nrepresented by control vectors. Continuous curvature is guaranteed in this\nmethod.\n\n:param controlVectors: List of quintic control vectors.\n:param config: The configuration for the trajectory.\n\n:returns: The generated trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "waypoints",
+ "type": "list[wpimath.geometry.Pose2d]"
+ },
+ {
+ "defaultValue": null,
+ "name": "config",
+ "type": "wpimath.trajectory.TrajectoryConfig"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryGenerator",
+ "functionName": "generateTrajectory",
+ "returnType": "wpimath.trajectory.Trajectory",
+ "tooltip": "Generates a trajectory from the given waypoints and config. This method\nuses quintic hermite splines -- therefore, all points must be represented\nby Pose2d objects. Continuous curvature is guaranteed in this method.\n\n:param waypoints: List of waypoints..\n:param config: The configuration for the trajectory.\n\n:returns: The generated trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "func",
+ "type": "Callable[[str], None]"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryGenerator",
+ "functionName": "setErrorHandler",
+ "returnType": "None",
+ "tooltip": "Set error reporting function. By default, it is output to stderr.\n\n:param func: Error reporting function."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "splines",
+ "type": "list[wpimath.spline.CubicHermiteSpline]"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryGenerator",
+ "functionName": "splinePointsFromSplines",
+ "returnType": "list[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]",
+ "tooltip": "Generate spline points from a vector of splines by parameterizing the\nsplines.\n\n:param splines: The splines to parameterize.\n\n:returns: The spline points for use in time parameterization of a trajectory."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "splines",
+ "type": "list[wpimath.spline.QuinticHermiteSpline]"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryGenerator",
+ "functionName": "splinePointsFromSplines",
+ "returnType": "list[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]",
+ "tooltip": "Generate spline points from a vector of splines by parameterizing the\nsplines.\n\n:param splines: The splines to parameterize.\n\n:returns: The spline points for use in time parameterization of a trajectory."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.TrajectoryParameterizer",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.trajectory.TrajectoryParameterizer",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.TrajectoryParameterizer",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "points",
+ "type": "list[tuple[wpimath.geometry.Pose2d, wpimath.units.radians_per_meter]]"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraints",
+ "type": "list[wpimath.trajectory.constraint.TrajectoryConstraint]"
+ },
+ {
+ "defaultValue": null,
+ "name": "startVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "endVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVelocity",
+ "type": "wpimath.units.meters_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAcceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ },
+ {
+ "defaultValue": null,
+ "name": "reversed",
+ "type": "bool"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrajectoryParameterizer",
+ "functionName": "timeParameterizeTrajectory",
+ "returnType": "wpimath.trajectory.Trajectory",
+ "tooltip": "Parameterize the trajectory by time. This is where the velocity profile is\ngenerated.\n\nThe derivation of the algorithm used can be found here:\n\n\n:param points: Reference to the spline points.\n:param constraints: A vector of various velocity and acceleration\n constraints.\n:param startVelocity: The start velocity for the trajectory.\n:param endVelocity: The end velocity for the trajectory.\n:param maxVelocity: The max velocity for the trajectory.\n:param maxAcceleration: The max acceleration for the trajectory.\n:param reversed: Whether the robot should move backwards. Note that the\n robot will still move from a -> b -> ... -> z as defined in the waypoints.\n\n:returns: The trajectory."
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.TrajectoryUtil",
+ "classVariables": [],
+ "constructors": [],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "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": null,
+ "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": null,
+ "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": null,
+ "name": "trajectory",
+ "type": "wpimath.trajectory.Trajectory"
+ },
+ {
+ "defaultValue": null,
+ "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": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "constraints",
+ "type": "wpimath.trajectory.TrapezoidProfile.Constraints"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrapezoidProfile",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.TrapezoidProfile",
+ "tooltip": "Constructs a TrapezoidProfile.\n\n:param constraints: The constraints on the profile, like maximum velocity."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrapezoidProfile"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "current",
+ "type": "wpimath.trajectory.TrapezoidProfile.State"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.trajectory.TrapezoidProfile.State"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrapezoidProfile",
+ "functionName": "calculate",
+ "returnType": "wpimath.trajectory.TrapezoidProfile.State",
+ "tooltip": "Calculates the position and velocity for the profile at a time t where the\ncurrent state is at time t = 0.\n\n:param t: How long to advance from the current state toward the desired\n state.\n:param current: The current state.\n:param goal: The desired state when the profile is complete.\n\n:returns: The position and velocity of the profile at time t."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrapezoidProfile"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrapezoidProfile",
+ "functionName": "isFinished",
+ "returnType": "bool",
+ "tooltip": "Returns true if the profile has reached the goal.\n\nThe profile has reached the goal if the time since the profile started has\nexceeded the profile's total time.\n\n:param t: The time since the beginning of the profile.\n\n:returns: True if the profile has reached the goal."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrapezoidProfile"
+ },
+ {
+ "defaultValue": null,
+ "name": "target",
+ "type": "float"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrapezoidProfile"
+ }
+ ],
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.TrapezoidProfile.Constraints",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "maxVelocity",
+ "type": "wpimath.units.units_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAcceleration",
+ "type": "wpimath.units.units_per_second_squared"
+ }
+ ],
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "maxAcceleration",
+ "tooltip": "Maximum acceleration.",
+ "type": "wpimath.units.units_per_second_squared",
+ "writable": null
+ },
+ {
+ "name": "maxVelocity",
+ "tooltip": "Maximum velocity.",
+ "type": "wpimath.units.units_per_second",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.TrapezoidProfile.State",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "position",
+ "type": "float"
+ },
+ {
+ "defaultValue": "0",
+ "name": "velocity",
+ "type": "wpimath.units.units_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrapezoidProfile.State",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.TrapezoidProfile.State",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "position",
+ "tooltip": "The position at this state.",
+ "type": "float",
+ "writable": null
+ },
+ {
+ "name": "velocity",
+ "tooltip": "The velocity at this state.",
+ "type": "wpimath.units.units_per_second",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.TrapezoidProfileRadians",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "constraints",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians.Constraints"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrapezoidProfileRadians",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.TrapezoidProfileRadians",
+ "tooltip": "Constructs a TrapezoidProfile.\n\n:param constraints: The constraints on the profile, like maximum velocity."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "wpimath.units.seconds"
+ },
+ {
+ "defaultValue": null,
+ "name": "current",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians.State"
+ },
+ {
+ "defaultValue": null,
+ "name": "goal",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians.State"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrapezoidProfileRadians",
+ "functionName": "calculate",
+ "returnType": "wpimath.trajectory.TrapezoidProfileRadians.State",
+ "tooltip": "Calculates the position and velocity for the profile at a time t where the\ncurrent state is at time t = 0.\n\n:param t: How long to advance from the current state toward the desired\n state.\n:param current: The current state.\n:param goal: The desired state when the profile is complete.\n\n:returns: The position and velocity of the profile at time t."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "t",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrapezoidProfileRadians",
+ "functionName": "isFinished",
+ "returnType": "bool",
+ "tooltip": "Returns true if the profile has reached the goal.\n\nThe profile has reached the goal if the time since the profile started has\nexceeded the profile's total time.\n\n:param t: The time since the beginning of the profile.\n\n:returns: True if the profile has reached the goal."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians"
+ },
+ {
+ "defaultValue": null,
+ "name": "target",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.TrapezoidProfileRadians"
+ }
+ ],
+ "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."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.TrapezoidProfileRadians.Constraints",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "maxVelocity",
+ "type": "wpimath.units.radians_per_second"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAcceleration",
+ "type": "wpimath.units.radians_per_second_squared"
+ }
+ ],
+ "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."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "maxAcceleration",
+ "tooltip": "Maximum acceleration.",
+ "type": "wpimath.units.radians_per_second_squared",
+ "writable": null
+ },
+ {
+ "name": "maxVelocity",
+ "tooltip": "Maximum velocity.",
+ "type": "wpimath.units.radians_per_second",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.TrapezoidProfileRadians.State",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": "0",
+ "name": "position",
+ "type": "wpimath.units.radians"
+ },
+ {
+ "defaultValue": "0",
+ "name": "velocity",
+ "type": "wpimath.units.radians_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.TrapezoidProfileRadians.State",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.TrapezoidProfileRadians.State",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "position",
+ "tooltip": "The position at this state.",
+ "type": "wpimath.units.radians",
+ "writable": null
+ },
+ {
+ "name": "velocity",
+ "tooltip": "The velocity at this state.",
+ "type": "wpimath.units.radians_per_second",
+ "writable": null
+ }
+ ],
+ "moduleName": "wpimath.trajectory",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "maxCentripetalAcceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "maxCentripetalAcceleration",
+ "type": "wpimath.units.feet_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint",
+ "functionName": "fromFps",
+ "returnType": "wpimath.trajectory.constraint.CentripetalAccelerationConstraint",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.feet_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint",
+ "functionName": "fromFps",
+ "returnType": "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "feedforward",
+ "type": "wpimath.controller.SimpleMotorFeedforwardMeters"
+ },
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.DifferentialDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxVoltage",
+ "type": "wpimath.units.volts"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint",
+ "tooltip": "Creates a new DifferentialDriveVoltageConstraint.\n\n:param feedforward: A feedforward component describing the behavior of the\n drive.\n:param kinematics: A kinematics component describing the drive geometry.\n:param maxVoltage: The maximum voltage available to the motors while\n following the path. Should be somewhat less than the nominal battery\n voltage (12V) to account for \"voltage sag\" due to current draw."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.constraint.EllipticalRegionConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "xWidth",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "yWidth",
+ "type": "wpimath.units.meters"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraint",
+ "type": "wpimath.trajectory.constraint.TrajectoryConstraint"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.EllipticalRegionConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.EllipticalRegionConstraint",
+ "tooltip": "Constructs a new EllipticalRegionConstraint.\n\n:deprecated: Use constructor taking Ellipse2d instead.\n\n:param center: The center of the ellipse in which to enforce the constraint.\n:param xWidth: The width of the ellipse in which to enforce the constraint.\n:param yWidth: The height of the ellipse in which to enforce the constraint.\n:param rotation: The rotation to apply to all radii around the origin.\n:param constraint: The constraint to enforce when the robot is within the\n region."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "ellipse",
+ "type": "wpimath.geometry.Ellipse2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraint",
+ "type": "wpimath.trajectory.constraint.TrajectoryConstraint"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.EllipticalRegionConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.EllipticalRegionConstraint",
+ "tooltip": "Constructs a new EllipticalRegionConstraint.\n\n:param ellipse: The ellipse in which to enforce the constraint.\n:param constraint: The constraint to enforce when the robot is within the\n region."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.EllipticalRegionConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.EllipticalRegionConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.EllipticalRegionConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.EllipticalRegionConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "xWidth",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "yWidth",
+ "type": "wpimath.units.feet"
+ },
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "wpimath.geometry.Rotation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraint",
+ "type": "wpimath.trajectory.constraint.TrajectoryConstraint"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.EllipticalRegionConstraint",
+ "functionName": "fromFeet",
+ "returnType": "wpimath.trajectory.constraint.EllipticalRegionConstraint",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.constraint.MaxVelocityConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "maxVelocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.MaxVelocityConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.MaxVelocityConstraint",
+ "tooltip": "Constructs a new MaxVelocityConstraint.\n\n:param maxVelocity: The max velocity."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.MaxVelocityConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.MaxVelocityConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.MaxVelocityConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.MaxVelocityConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "maxVelocity",
+ "type": "wpimath.units.feet_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.MaxVelocityConstraint",
+ "functionName": "fromFps",
+ "returnType": "wpimath.trajectory.constraint.MaxVelocityConstraint",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.MecanumDriveKinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.feet_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint",
+ "functionName": "fromFps",
+ "returnType": "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.constraint.RectangularRegionConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "bottomLeftPoint",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "topRightPoint",
+ "type": "wpimath.geometry.Translation2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraint",
+ "type": "wpimath.trajectory.constraint.TrajectoryConstraint"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.RectangularRegionConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.RectangularRegionConstraint",
+ "tooltip": "Constructs a new RectangularRegionConstraint.\n\n:deprecated: Use constructor taking Rectangle2d instead.\n\n:param bottomLeftPoint: The bottom left point of the rectangular region in\n which to enforce the constraint.\n:param topRightPoint: The top right point of the rectangular region in which\n to enforce the constraint.\n:param constraint: The constraint to enforce when the robot is within the\n region."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "rectangle",
+ "type": "wpimath.geometry.Rectangle2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "constraint",
+ "type": "wpimath.trajectory.constraint.TrajectoryConstraint"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.RectangularRegionConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.RectangularRegionConstraint",
+ "tooltip": "Constructs a new RectangularRegionConstraint.\n\n:param rectangle: The rectangular region in which to enforce the constraint.\n:param constraint: The constraint to enforce when the robot is within the\n region."
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.RectangularRegionConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.RectangularRegionConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.RectangularRegionConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.RectangularRegionConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive2Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.feet_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint",
+ "functionName": "fromFps",
+ "returnType": "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive3Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.feet_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint",
+ "functionName": "fromFps",
+ "returnType": "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive4Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.feet_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint",
+ "functionName": "fromFps",
+ "returnType": "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "kinematics",
+ "type": "wpimath.kinematics.SwerveDrive6Kinematics"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxSpeed",
+ "type": "wpimath.units.feet_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint",
+ "functionName": "fromFps",
+ "returnType": "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint",
+ "tooltip": ""
+ }
+ ]
+ },
+ {
+ "className": "wpimath.trajectory.constraint.TrajectoryConstraint",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.trajectory.constraint.TrajectoryConstraint",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.TrajectoryConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "velocity",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.TrajectoryConstraint",
+ "functionName": "maxVelocity",
+ "returnType": "wpimath.units.meters_per_second",
+ "tooltip": "Returns the max velocity given the current pose and curvature.\n\n:param pose: The pose at the current point in the trajectory.\n:param curvature: The curvature at the current point in the trajectory.\n:param velocity: The velocity at the current point in the trajectory before\n constraints are applied.\n\n:returns: The absolute maximum velocity."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "self",
+ "type": "wpimath.trajectory.constraint.TrajectoryConstraint"
+ },
+ {
+ "defaultValue": null,
+ "name": "pose",
+ "type": "wpimath.geometry.Pose2d"
+ },
+ {
+ "defaultValue": null,
+ "name": "curvature",
+ "type": "wpimath.units.radians_per_meter"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "wpimath.units.meters_per_second"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.TrajectoryConstraint",
+ "functionName": "minMaxAcceleration",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": "Returns the minimum and maximum allowable acceleration for the trajectory\ngiven pose, curvature, and speed.\n\n:param pose: The pose at the current point in the trajectory.\n:param curvature: The curvature at the current point in the trajectory.\n:param speed: The speed at the current point in the trajectory.\n\n:returns: The min and max acceleration bounds."
+ }
+ ],
+ "instanceVariables": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": []
+ },
+ {
+ "className": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "classVariables": [],
+ "constructors": [
+ {
+ "args": [],
+ "declaringClassName": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "minAcceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAcceleration",
+ "type": "wpimath.units.meters_per_second_squared"
+ }
+ ],
+ "declaringClassName": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "functionName": "__init__",
+ "returnType": "wpimath.trajectory.constraint.TrajectoryConstraint.MinMax",
+ "tooltip": ""
+ }
+ ],
+ "enums": [],
+ "instanceMethods": [],
+ "instanceVariables": [
+ {
+ "name": "maxAcceleration",
+ "tooltip": "The maximum acceleration.",
+ "type": "wpimath.units.meters_per_second_squared",
+ "writable": true
+ },
+ {
+ "name": "minAcceleration",
+ "tooltip": "The minimum acceleration.",
+ "type": "wpimath.units.meters_per_second_squared",
+ "writable": true
+ }
+ ],
+ "moduleName": "wpimath.trajectory.constraint",
+ "staticMethods": []
+ }
+ ],
+ "modules": [
+ {
+ "enums": [
+ {
+ "enumClassName": "hal.AccelerometerRange",
+ "enumValues": [
+ "k2G",
+ "k4G",
+ "k8G"
+ ],
+ "moduleName": "hal",
+ "tooltip": "The acceptable accelerometer ranges.\n\nMembers:\n\n k2G\n\n k4G\n\n k8G"
+ },
+ {
+ "enumClassName": "hal.AllianceStationID",
+ "enumValues": [
+ "kBlue1",
+ "kBlue2",
+ "kBlue3",
+ "kRed1",
+ "kRed2",
+ "kRed3",
+ "kUnknown"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Members:\n\n kUnknown : Unknown Alliance Station\n\n kRed1 : Red Alliance Station 1\n\n kRed2 : Red Alliance Station 2\n\n kRed3 : Red Alliance Station 3\n\n kBlue1 : Blue Alliance Station 1\n\n kBlue2 : Blue Alliance Station 2\n\n kBlue3 : Blue Alliance Station 3"
+ },
+ {
+ "enumClassName": "hal.AnalogTriggerType",
+ "enumValues": [
+ "kFallingPulse",
+ "kInWindow",
+ "kRisingPulse",
+ "kState"
+ ],
+ "moduleName": "hal",
+ "tooltip": "The type of analog trigger to trigger on.\n\nMembers:\n\n kInWindow\n\n kState\n\n kRisingPulse\n\n kFallingPulse"
+ },
+ {
+ "enumClassName": "hal.CANDeviceType",
+ "enumValues": [
+ "kAccelerometer",
+ "kBroadcast",
+ "kFirmwareUpdate",
+ "kGearToothSensor",
+ "kGyroSensor",
+ "kIOBreakout",
+ "kMiscellaneous",
+ "kMotorController",
+ "kPneumatics",
+ "kPowerDistribution",
+ "kRelayController",
+ "kRobotController",
+ "kServoController",
+ "kUltrasonicSensor"
+ ],
+ "moduleName": "hal",
+ "tooltip": "The CAN device type.\n\nTeams should use HAL_CAN_Dev_kMiscellaneous\n\nMembers:\n\n kBroadcast : Broadcast.\n\n kRobotController : Robot controller.\n\n kMotorController : Motor controller.\n\n kRelayController : Relay controller.\n\n kGyroSensor : Gyro sensor.\n\n kAccelerometer : Accelerometer.\n\n kUltrasonicSensor : Ultrasonic sensor.\n\n kGearToothSensor : Gear tooth sensor.\n\n kPowerDistribution : Power distribution.\n\n kPneumatics : Pneumatics.\n\n kMiscellaneous : Miscellaneous.\n\n kIOBreakout : IO breakout.\n\n kServoController\n\n kFirmwareUpdate : Firmware update."
+ },
+ {
+ "enumClassName": "hal.CANManufacturer",
+ "enumValues": [
+ "kAndyMark",
+ "kBroadcast",
+ "kCTRE",
+ "kCopperforge",
+ "kDEKA",
+ "kGrapple",
+ "kKauaiLabs",
+ "kLM",
+ "kMS",
+ "kNI",
+ "kPWF",
+ "kREV",
+ "kReduxRobotics",
+ "kStudica",
+ "kTeamUse",
+ "kTheThriftyBot",
+ "kVividHosting"
+ ],
+ "moduleName": "hal",
+ "tooltip": "The CAN manufacturer ID.\n\nTeams should use HAL_CAN_Man_kTeamUse.\n\nMembers:\n\n kBroadcast : Broadcast.\n\n kNI : National Instruments.\n\n kLM : Luminary Micro.\n\n kDEKA : DEKA Research and Development Corp.\n\n kCTRE : Cross the Road Electronics.\n\n kREV : REV robotics.\n\n kGrapple : Grapple.\n\n kMS : MindSensors.\n\n kTeamUse : Team use.\n\n kKauaiLabs : Kauai Labs.\n\n kCopperforge : Copperforge.\n\n kPWF : Playing With Fusion.\n\n kStudica : Studica.\n\n kTheThriftyBot : TheThriftyBot.\n\n kReduxRobotics : Redux Robotics.\n\n kAndyMark : AndyMark.\n\n kVividHosting : Vivid-Hosting."
+ },
+ {
+ "enumClassName": "hal.CounterMode",
+ "enumValues": [
+ "kExternalDirection",
+ "kPulseLength",
+ "kSemiperiod",
+ "kTwoPulse"
+ ],
+ "moduleName": "hal",
+ "tooltip": "The counter mode.\n\nMembers:\n\n kTwoPulse : Two pulse mode.\n\n kSemiperiod : Semi-period mode.\n\n kPulseLength : Pulse length mode.\n\n kExternalDirection : External direction mode."
+ },
+ {
+ "enumClassName": "hal.EncoderEncodingType",
+ "enumValues": [
+ "Encoder_k1X",
+ "Encoder_k2X",
+ "Encoder_k4X"
+ ],
+ "moduleName": "hal",
+ "tooltip": "The encoding scaling of the encoder.\n\nMembers:\n\n Encoder_k1X\n\n Encoder_k2X\n\n Encoder_k4X"
+ },
+ {
+ "enumClassName": "hal.EncoderIndexingType",
+ "enumValues": [
+ "kResetOnFallingEdge",
+ "kResetOnRisingEdge",
+ "kResetWhileHigh",
+ "kResetWhileLow"
+ ],
+ "moduleName": "hal",
+ "tooltip": "The type of index pulse for the encoder.\n\nMembers:\n\n kResetWhileHigh\n\n kResetWhileLow\n\n kResetOnFallingEdge\n\n kResetOnRisingEdge"
+ },
+ {
+ "enumClassName": "hal.HAL_RadioLEDState",
+ "enumValues": [
+ "HAL_RadioLED_kGreen",
+ "HAL_RadioLED_kOff",
+ "HAL_RadioLED_kOrange",
+ "HAL_RadioLED_kRed"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Members:\n\n HAL_RadioLED_kOff\n\n HAL_RadioLED_kGreen\n\n HAL_RadioLED_kRed\n\n HAL_RadioLED_kOrange"
+ },
+ {
+ "enumClassName": "hal.HandleEnum",
+ "enumValues": [
+ "AddressableLED",
+ "AnalogGyro",
+ "AnalogInput",
+ "AnalogOutput",
+ "AnalogTrigger",
+ "CAN",
+ "CTREPCM",
+ "CTREPDP",
+ "Compressor",
+ "Counter",
+ "DIO",
+ "DMA",
+ "DigitalPWM",
+ "DutyCycle",
+ "Encoder",
+ "FPGAEncoder",
+ "Interrupt",
+ "Notifier",
+ "PWM",
+ "Port",
+ "REVPDH",
+ "REVPH",
+ "Relay",
+ "SerialPort",
+ "SimulationJni",
+ "Solenoid",
+ "Undefined",
+ "Vendor"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Enum of HAL handle types. Vendors/Teams should use Vendor (17).\n\nMembers:\n\n Undefined\n\n DIO\n\n Port\n\n Notifier\n\n Interrupt\n\n AnalogOutput\n\n AnalogInput\n\n AnalogTrigger\n\n Relay\n\n PWM\n\n DigitalPWM\n\n Counter\n\n FPGAEncoder\n\n Encoder\n\n Compressor\n\n Solenoid\n\n AnalogGyro\n\n Vendor\n\n SimulationJni\n\n CAN\n\n SerialPort\n\n DutyCycle\n\n DMA\n\n AddressableLED\n\n CTREPCM\n\n CTREPDP\n\n REVPDH\n\n REVPH"
+ },
+ {
+ "enumClassName": "hal.I2CPort",
+ "enumValues": [
+ "kInvalid",
+ "kMXP",
+ "kOnboard"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Members:\n\n kInvalid\n\n kOnboard\n\n kMXP"
+ },
+ {
+ "enumClassName": "hal.MatchType",
+ "enumValues": [
+ "elimination",
+ "none",
+ "practice",
+ "qualification"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Members:\n\n none\n\n practice\n\n qualification\n\n elimination"
+ },
+ {
+ "enumClassName": "hal.PowerDistributionType",
+ "enumValues": [
+ "kAutomatic",
+ "kCTRE",
+ "kRev"
+ ],
+ "moduleName": "hal",
+ "tooltip": "The types of power distribution devices.\n\nMembers:\n\n kAutomatic : Automatically determines the module type\n\n kCTRE : CTRE (Cross The Road Electronics) Power Distribution Panel (PDP).\n\n kRev : REV Power Distribution Hub (PDH)."
+ },
+ {
+ "enumClassName": "hal.REVPHCompressorConfigType",
+ "enumValues": [
+ "kAnalog",
+ "kDigital",
+ "kDisabled",
+ "kHybrid"
+ ],
+ "moduleName": "hal",
+ "tooltip": "The compressor configuration type\n\nMembers:\n\n kDisabled : Disabled.\n\n kDigital : Digital.\n\n kAnalog : Analog.\n\n kHybrid : Hybrid."
+ },
+ {
+ "enumClassName": "hal.RuntimeType",
+ "enumValues": [
+ "HAL_Runtime_RoboRIO",
+ "HAL_Runtime_RoboRIO2",
+ "HAL_Runtime_Simulation"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Runtime type.\n\nMembers:\n\n HAL_Runtime_RoboRIO : roboRIO 1.0\n\n HAL_Runtime_RoboRIO2 : roboRIO 2.0\n\n HAL_Runtime_Simulation : Simulation runtime"
+ },
+ {
+ "enumClassName": "hal.SPIMode",
+ "enumValues": [
+ "kMode0",
+ "kMode1",
+ "kMode2",
+ "kMode3"
+ ],
+ "moduleName": "hal",
+ "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."
+ },
+ {
+ "enumClassName": "hal.SPIPort",
+ "enumValues": [
+ "kInvalid",
+ "kMXP",
+ "kOnboardCS0",
+ "kOnboardCS1",
+ "kOnboardCS2",
+ "kOnboardCS3"
+ ],
+ "moduleName": "hal",
+ "tooltip": "SPI port.\n\nMembers:\n\n kInvalid : Invalid port number.\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."
+ },
+ {
+ "enumClassName": "hal.SerialPort",
+ "enumValues": [
+ "MXP",
+ "Onboard",
+ "USB1",
+ "USB2"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Members:\n\n Onboard\n\n MXP\n\n USB1\n\n USB2"
+ },
+ {
+ "enumClassName": "hal.SimValueDirection",
+ "enumValues": [
+ "HAL_SimValueBidir",
+ "HAL_SimValueInput",
+ "HAL_SimValueOutput"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Direction of a simulated value (from the perspective of user code).\n\nMembers:\n\n HAL_SimValueInput : input to user code from the simulator\n\n HAL_SimValueOutput : output from user code to the simulator\n\n HAL_SimValueBidir : bidirectional between user code and simulator"
+ },
+ {
+ "enumClassName": "hal.Type",
+ "enumValues": [
+ "BOOLEAN",
+ "DOUBLE",
+ "ENUM",
+ "INT",
+ "LONG",
+ "UNASSIGNED"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Members:\n\n UNASSIGNED\n\n BOOLEAN\n\n DOUBLE\n\n ENUM\n\n INT\n\n LONG"
+ },
+ {
+ "enumClassName": "hal.tInstances",
+ "enumValues": [
+ "kADXL345_I2C",
+ "kADXL345_SPI",
+ "kCANPlugin_2CAN",
+ "kCANPlugin_BlackJagBridge",
+ "kCommand2_Scheduler",
+ "kCommand_Scheduler",
+ "kDashboard_AdvantageScope",
+ "kDashboard_Elastic",
+ "kDashboard_FRCWebComponents",
+ "kDashboard_Glass",
+ "kDashboard_LabVIEW",
+ "kDashboard_QFRCDashboard",
+ "kDashboard_Shuffleboard",
+ "kDashboard_SmartDashboard",
+ "kDashboard_Unknown",
+ "kDataLogLocation_Onboard",
+ "kDataLogLocation_USB",
+ "kDriverStationCIO_Analog",
+ "kDriverStationCIO_DigitalIn",
+ "kDriverStationCIO_DigitalOut",
+ "kDriverStationEIO_Acceleration",
+ "kDriverStationEIO_AnalogIn",
+ "kDriverStationEIO_AnalogOut",
+ "kDriverStationEIO_Button",
+ "kDriverStationEIO_DigitalIn",
+ "kDriverStationEIO_DigitalOut",
+ "kDriverStationEIO_Encoder",
+ "kDriverStationEIO_FixedDigitalOut",
+ "kDriverStationEIO_LED",
+ "kDriverStationEIO_PWM",
+ "kDriverStationEIO_TouchSlider",
+ "kFramework_AdvantageKit",
+ "kFramework_CommandControl",
+ "kFramework_Iterative",
+ "kFramework_MagicBot",
+ "kFramework_ROS",
+ "kFramework_RobotBuilder",
+ "kFramework_Simple",
+ "kFramework_Timed",
+ "kKinematics_DifferentialDrive",
+ "kKinematics_MecanumDrive",
+ "kKinematics_SwerveDrive",
+ "kLanguage_CPlusPlus",
+ "kLanguage_DotNet",
+ "kLanguage_Java",
+ "kLanguage_Kotlin",
+ "kLanguage_LabVIEW",
+ "kLanguage_Python",
+ "kLanguage_Rust",
+ "kLoggingFramework_AdvantageKit",
+ "kLoggingFramework_DogLog",
+ "kLoggingFramework_Epilogue",
+ "kLoggingFramework_Monologue",
+ "kLoggingFramework_Other",
+ "kOdometry_DifferentialDrive",
+ "kOdometry_MecanumDrive",
+ "kOdometry_SwerveDrive",
+ "kPDP_CTRE",
+ "kPDP_REV",
+ "kPDP_Unknown",
+ "kRobotDrive2_DifferentialArcade",
+ "kRobotDrive2_DifferentialCurvature",
+ "kRobotDrive2_DifferentialTank",
+ "kRobotDrive2_KilloughCartesian",
+ "kRobotDrive2_KilloughPolar",
+ "kRobotDrive2_MecanumCartesian",
+ "kRobotDrive2_MecanumPolar",
+ "kRobotDriveSwerve_AdvantageKit",
+ "kRobotDriveSwerve_CTRE",
+ "kRobotDriveSwerve_MaxSwerve",
+ "kRobotDriveSwerve_Other",
+ "kRobotDriveSwerve_YAGSL",
+ "kRobotDrive_ArcadeButtonSpin",
+ "kRobotDrive_ArcadeRatioCurve",
+ "kRobotDrive_ArcadeStandard",
+ "kRobotDrive_MecanumCartesian",
+ "kRobotDrive_MecanumPolar",
+ "kRobotDrive_Tank",
+ "kSmartDashboard_Instance",
+ "kSmartDashboard_LiveWindow"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Members:\n\n kLanguage_LabVIEW\n\n kLanguage_CPlusPlus\n\n kLanguage_Java\n\n kLanguage_Python\n\n kLanguage_DotNet\n\n kLanguage_Kotlin\n\n kLanguage_Rust\n\n kCANPlugin_BlackJagBridge\n\n kCANPlugin_2CAN\n\n kFramework_Iterative\n\n kFramework_Simple\n\n kFramework_CommandControl\n\n kFramework_Timed\n\n kFramework_ROS\n\n kFramework_RobotBuilder\n\n kFramework_AdvantageKit\n\n kFramework_MagicBot\n\n kRobotDrive_ArcadeStandard\n\n kRobotDrive_ArcadeButtonSpin\n\n kRobotDrive_ArcadeRatioCurve\n\n kRobotDrive_Tank\n\n kRobotDrive_MecanumPolar\n\n kRobotDrive_MecanumCartesian\n\n kRobotDrive2_DifferentialArcade\n\n kRobotDrive2_DifferentialTank\n\n kRobotDrive2_DifferentialCurvature\n\n kRobotDrive2_MecanumCartesian\n\n kRobotDrive2_MecanumPolar\n\n kRobotDrive2_KilloughCartesian\n\n kRobotDrive2_KilloughPolar\n\n kRobotDriveSwerve_Other\n\n kRobotDriveSwerve_YAGSL\n\n kRobotDriveSwerve_CTRE\n\n kRobotDriveSwerve_MaxSwerve\n\n kRobotDriveSwerve_AdvantageKit\n\n kDriverStationCIO_Analog\n\n kDriverStationCIO_DigitalIn\n\n kDriverStationCIO_DigitalOut\n\n kDriverStationEIO_Acceleration\n\n kDriverStationEIO_AnalogIn\n\n kDriverStationEIO_AnalogOut\n\n kDriverStationEIO_Button\n\n kDriverStationEIO_LED\n\n kDriverStationEIO_DigitalIn\n\n kDriverStationEIO_DigitalOut\n\n kDriverStationEIO_FixedDigitalOut\n\n kDriverStationEIO_PWM\n\n kDriverStationEIO_Encoder\n\n kDriverStationEIO_TouchSlider\n\n kADXL345_SPI\n\n kADXL345_I2C\n\n kCommand_Scheduler\n\n kCommand2_Scheduler\n\n kSmartDashboard_Instance\n\n kSmartDashboard_LiveWindow\n\n kKinematics_DifferentialDrive\n\n kKinematics_MecanumDrive\n\n kKinematics_SwerveDrive\n\n kOdometry_DifferentialDrive\n\n kOdometry_MecanumDrive\n\n kOdometry_SwerveDrive\n\n kDashboard_Unknown\n\n kDashboard_Glass\n\n kDashboard_SmartDashboard\n\n kDashboard_Shuffleboard\n\n kDashboard_Elastic\n\n kDashboard_LabVIEW\n\n kDashboard_AdvantageScope\n\n kDashboard_QFRCDashboard\n\n kDashboard_FRCWebComponents\n\n kDataLogLocation_Onboard\n\n kDataLogLocation_USB\n\n kLoggingFramework_Other\n\n kLoggingFramework_Epilogue\n\n kLoggingFramework_Monologue\n\n kLoggingFramework_AdvantageKit\n\n kLoggingFramework_DogLog\n\n kPDP_CTRE\n\n kPDP_REV\n\n kPDP_Unknown"
+ },
+ {
+ "enumClassName": "hal.tResourceType",
+ "enumValues": [
+ "kResourceType_ADIS16448",
+ "kResourceType_ADIS16470",
+ "kResourceType_ADXL345",
+ "kResourceType_ADXL362",
+ "kResourceType_ADXRS450",
+ "kResourceType_Accelerometer",
+ "kResourceType_AddressableLEDs",
+ "kResourceType_AnalogChannel",
+ "kResourceType_AnalogOutput",
+ "kResourceType_AnalogTrigger",
+ "kResourceType_AnalogTriggerOutput",
+ "kResourceType_AxisCamera",
+ "kResourceType_BangBangController",
+ "kResourceType_Button",
+ "kResourceType_CAN",
+ "kResourceType_CANJaguar",
+ "kResourceType_CANPlugin",
+ "kResourceType_CANTalonSRX",
+ "kResourceType_CANifier",
+ "kResourceType_CTRE_future1",
+ "kResourceType_CTRE_future10",
+ "kResourceType_CTRE_future11",
+ "kResourceType_CTRE_future12",
+ "kResourceType_CTRE_future13",
+ "kResourceType_CTRE_future14",
+ "kResourceType_CTRE_future2",
+ "kResourceType_CTRE_future3",
+ "kResourceType_CTRE_future4",
+ "kResourceType_CTRE_future5",
+ "kResourceType_CTRE_future6",
+ "kResourceType_CTRE_future7",
+ "kResourceType_CTRE_future8",
+ "kResourceType_CTRE_future9",
+ "kResourceType_ChoreoTrajectory",
+ "kResourceType_ChoreoTrigger",
+ "kResourceType_Command",
+ "kResourceType_Compressor",
+ "kResourceType_Controller",
+ "kResourceType_Counter",
+ "kResourceType_Dashboard",
+ "kResourceType_DataLogManager",
+ "kResourceType_DigilentDMC60",
+ "kResourceType_DigitalGlitchFilter",
+ "kResourceType_DigitalInput",
+ "kResourceType_DigitalOutput",
+ "kResourceType_DriverStationCIO",
+ "kResourceType_DriverStationEIO",
+ "kResourceType_DriverStationLCD",
+ "kResourceType_DutyCycle",
+ "kResourceType_Encoder",
+ "kResourceType_ExponentialProfile",
+ "kResourceType_Framework",
+ "kResourceType_FusionVenom",
+ "kResourceType_GearTooth",
+ "kResourceType_Gyro",
+ "kResourceType_HiTechnicAccel",
+ "kResourceType_HiTechnicColorSensor",
+ "kResourceType_HiTechnicCompass",
+ "kResourceType_I2C",
+ "kResourceType_Jaguar",
+ "kResourceType_Joystick",
+ "kResourceType_Kinect",
+ "kResourceType_KinectStick",
+ "kResourceType_Kinematics",
+ "kResourceType_Koors40",
+ "kResourceType_Language",
+ "kResourceType_LaserShark",
+ "kResourceType_LinearFilter",
+ "kResourceType_LoggingFramework",
+ "kResourceType_MindsensorsSD540",
+ "kResourceType_Module",
+ "kResourceType_NavX",
+ "kResourceType_NidecBrushless",
+ "kResourceType_Odometry",
+ "kResourceType_PCM",
+ "kResourceType_PCVideoServer",
+ "kResourceType_PDP",
+ "kResourceType_PIDController",
+ "kResourceType_PIDController2",
+ "kResourceType_PS4Controller",
+ "kResourceType_PWFSEN36005",
+ "kResourceType_PWM",
+ "kResourceType_PWMTalonSRX",
+ "kResourceType_PWMVictorSPX",
+ "kResourceType_PathFindingCommand",
+ "kResourceType_PathPlannerAuto",
+ "kResourceType_PathPlannerPath",
+ "kResourceType_PathWeaverTrajectory",
+ "kResourceType_PhotonCamera",
+ "kResourceType_PhotonPoseEstimator",
+ "kResourceType_PigeonIMU",
+ "kResourceType_Pixy",
+ "kResourceType_Pixy2",
+ "kResourceType_Preferences",
+ "kResourceType_ProfiledPIDController",
+ "kResourceType_Redux_future1",
+ "kResourceType_Redux_future2",
+ "kResourceType_Redux_future3",
+ "kResourceType_Redux_future4",
+ "kResourceType_Redux_future5",
+ "kResourceType_Relay",
+ "kResourceType_RevSPARK",
+ "kResourceType_RevServoHub",
+ "kResourceType_RevSparkFlexCAN",
+ "kResourceType_RevSparkFlexPWM",
+ "kResourceType_RevSparkMaxCAN",
+ "kResourceType_RevSparkMaxPWM",
+ "kResourceType_RobotDrive",
+ "kResourceType_SPI",
+ "kResourceType_SRF08",
+ "kResourceType_ScanseSweep",
+ "kResourceType_SerialPort",
+ "kResourceType_Servo",
+ "kResourceType_Shuffleboard",
+ "kResourceType_SmartDashboard",
+ "kResourceType_Solenoid",
+ "kResourceType_Talon",
+ "kResourceType_TalonFX",
+ "kResourceType_Task",
+ "kResourceType_ThriftyNova",
+ "kResourceType_TrapezoidProfile",
+ "kResourceType_Ultrasonic",
+ "kResourceType_Units",
+ "kResourceType_UsbCamera",
+ "kResourceType_Victor",
+ "kResourceType_VictorSP",
+ "kResourceType_XboxController"
+ ],
+ "moduleName": "hal",
+ "tooltip": "Members:\n\n kResourceType_Controller\n\n kResourceType_Module\n\n kResourceType_Language\n\n kResourceType_CANPlugin\n\n kResourceType_Accelerometer\n\n kResourceType_ADXL345\n\n kResourceType_AnalogChannel\n\n kResourceType_AnalogTrigger\n\n kResourceType_AnalogTriggerOutput\n\n kResourceType_CANJaguar\n\n kResourceType_Compressor\n\n kResourceType_Counter\n\n kResourceType_Dashboard\n\n kResourceType_DigitalInput\n\n kResourceType_DigitalOutput\n\n kResourceType_DriverStationCIO\n\n kResourceType_DriverStationEIO\n\n kResourceType_DriverStationLCD\n\n kResourceType_Encoder\n\n kResourceType_GearTooth\n\n kResourceType_Gyro\n\n kResourceType_I2C\n\n kResourceType_Framework\n\n kResourceType_Jaguar\n\n kResourceType_Joystick\n\n kResourceType_Kinect\n\n kResourceType_KinectStick\n\n kResourceType_PIDController\n\n kResourceType_Preferences\n\n kResourceType_PWM\n\n kResourceType_Relay\n\n kResourceType_RobotDrive\n\n kResourceType_SerialPort\n\n kResourceType_Servo\n\n kResourceType_Solenoid\n\n kResourceType_SPI\n\n kResourceType_Task\n\n kResourceType_Ultrasonic\n\n kResourceType_Victor\n\n kResourceType_Button\n\n kResourceType_Command\n\n kResourceType_AxisCamera\n\n kResourceType_PCVideoServer\n\n kResourceType_SmartDashboard\n\n kResourceType_Talon\n\n kResourceType_HiTechnicColorSensor\n\n kResourceType_HiTechnicAccel\n\n kResourceType_HiTechnicCompass\n\n kResourceType_SRF08\n\n kResourceType_AnalogOutput\n\n kResourceType_VictorSP\n\n kResourceType_PWMTalonSRX\n\n kResourceType_CANTalonSRX\n\n kResourceType_ADXL362\n\n kResourceType_ADXRS450\n\n kResourceType_RevSPARK\n\n kResourceType_MindsensorsSD540\n\n kResourceType_DigitalGlitchFilter\n\n kResourceType_ADIS16448\n\n kResourceType_PDP\n\n kResourceType_PCM\n\n kResourceType_PigeonIMU\n\n kResourceType_NidecBrushless\n\n kResourceType_CANifier\n\n kResourceType_TalonFX\n\n kResourceType_CTRE_future1\n\n kResourceType_CTRE_future2\n\n kResourceType_CTRE_future3\n\n kResourceType_CTRE_future4\n\n kResourceType_CTRE_future5\n\n kResourceType_CTRE_future6\n\n kResourceType_LinearFilter\n\n kResourceType_XboxController\n\n kResourceType_UsbCamera\n\n kResourceType_NavX\n\n kResourceType_Pixy\n\n kResourceType_Pixy2\n\n kResourceType_ScanseSweep\n\n kResourceType_Shuffleboard\n\n kResourceType_CAN\n\n kResourceType_DigilentDMC60\n\n kResourceType_PWMVictorSPX\n\n kResourceType_RevSparkMaxPWM\n\n kResourceType_RevSparkMaxCAN\n\n kResourceType_ADIS16470\n\n kResourceType_PIDController2\n\n kResourceType_ProfiledPIDController\n\n kResourceType_Kinematics\n\n kResourceType_Odometry\n\n kResourceType_Units\n\n kResourceType_TrapezoidProfile\n\n kResourceType_DutyCycle\n\n kResourceType_AddressableLEDs\n\n kResourceType_FusionVenom\n\n kResourceType_CTRE_future7\n\n kResourceType_CTRE_future8\n\n kResourceType_CTRE_future9\n\n kResourceType_CTRE_future10\n\n kResourceType_CTRE_future11\n\n kResourceType_CTRE_future12\n\n kResourceType_CTRE_future13\n\n kResourceType_CTRE_future14\n\n kResourceType_ExponentialProfile\n\n kResourceType_PS4Controller\n\n kResourceType_PhotonCamera\n\n kResourceType_PhotonPoseEstimator\n\n kResourceType_PathPlannerPath\n\n kResourceType_PathPlannerAuto\n\n kResourceType_PathFindingCommand\n\n kResourceType_Redux_future1\n\n kResourceType_Redux_future2\n\n kResourceType_Redux_future3\n\n kResourceType_Redux_future4\n\n kResourceType_Redux_future5\n\n kResourceType_RevSparkFlexCAN\n\n kResourceType_RevSparkFlexPWM\n\n kResourceType_BangBangController\n\n kResourceType_DataLogManager\n\n kResourceType_LoggingFramework\n\n kResourceType_ChoreoTrajectory\n\n kResourceType_ChoreoTrigger\n\n kResourceType_PathWeaverTrajectory\n\n kResourceType_Koors40\n\n kResourceType_ThriftyNova\n\n kResourceType_RevServoHub\n\n kResourceType_PWFSEN36005\n\n kResourceType_LaserShark"
+ }
+ ],
+ "functions": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "sessionHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "CAN_CloseStreamSession",
+ "returnType": "None",
+ "tooltip": "Closes a CAN stream.\n\n:param sessionHandle: the session to close"
+ },
+ {
+ "args": [],
+ "functionName": "CAN_GetCANStatus",
+ "returnType": "tuple[float, int, int, int, int, int]",
+ "tooltip": "Gets CAN status information.\n\n:param out: percentBusUtilization the bus utilization\n:param out: busOffCount the number of bus off errors\n:param out: txFullCount the number of tx full errors\n:param out: receiveErrorCount the number of receive errors\n:param out: transmitErrorCount the number of transmit errors\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "messageID",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "messageIDMask",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxMessages",
+ "type": "int"
+ }
+ ],
+ "functionName": "CAN_OpenStreamSession",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Opens a CAN stream.\n\n:param out: sessionHandle output for the session handle\n:param in: messageID the message ID to read\n:param in: messageIDMask the message ID mask\n:param in: maxMessages the maximum number of messages to stream\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "messageIDMask",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "CAN_ReceiveMessage",
+ "returnType": "tuple[int, int, int, int]",
+ "tooltip": "Receives a CAN message.\n\n:param out: messageID store for the received message ID\n:param in: messageIDMask the message ID mask to look for\n:param out: data data output (8 bytes)\n:param out: dataSize data length (0-8 bytes)\n:param out: timeStamp the packet received timestamp (based off of\n CLOCK_MONOTONIC)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "messageID",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "periodMs",
+ "type": "int"
+ }
+ ],
+ "functionName": "CAN_SendMessage",
+ "returnType": "int",
+ "tooltip": "Sends a CAN message.\n\n:param in: messageID the CAN ID to send\n:param in: data the data to send (0-8 bytes)\n:param in: dataSize the size of the data to send (0-8 bytes)\n:param in: periodMs the period to repeat the packet at. Use\n HAL_CAN_SEND_PERIOD_NO_REPEAT to not repeat.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [],
+ "functionName": "HAL_GetRadioLEDState",
+ "returnType": "tuple[hal.HAL_RadioLEDState, int]",
+ "tooltip": "Get the state of the \"Radio\" LED.\n\n:param out: status the error code, or 0 for success\n\n:returns: The state of the LED."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "hal.HAL_RadioLEDState"
+ }
+ ],
+ "functionName": "HAL_SetRadioLEDState",
+ "returnType": "int",
+ "tooltip": "Set the state of the \"Radio\" LED.\n\n:param state: The state to set the LED to.\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [],
+ "functionName": "allocateDigitalPWM",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Allocates a DO PWM Generator.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: the allocated digital PWM handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "calibrateAnalogGyro",
+ "returnType": "int",
+ "tooltip": "Calibrates the analog gyro.\n\nThis happens by calculating the average value of the gyro over 5 seconds, and\nsetting that as the center. Note that this call blocks for 5 seconds to\nperform this.\n\n:param in: handle the gyro handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "notifierHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelNotifierAlarm",
+ "returnType": "int",
+ "tooltip": "Cancels the next notifier alarm.\n\nThis does not cause HAL_WaitForNotifierAlarm to return.\n\n:param in: notifierHandle the notifier handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "checkAnalogInputChannel",
+ "returnType": "int",
+ "tooltip": "Checks that the analog output channel number is valid.\nVerifies that the analog channel number is one of the legal channel numbers.\nChannel numbers are 0-based.\n\n:param in: channel The analog output channel number.\n\n:returns: Analog channel is valid"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ }
+ ],
+ "functionName": "checkAnalogModule",
+ "returnType": "int",
+ "tooltip": "Checks that the analog module number is valid.\n\n:param in: module The analog module number.\n\n:returns: Analog module is valid and present"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "checkAnalogOutputChannel",
+ "returnType": "int",
+ "tooltip": "Checks that the analog output channel number is valid.\n\nVerifies that the analog channel number is one of the legal channel numbers.\nChannel numbers are 0-based.\n\n:returns: Analog channel is valid"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "checkCTREPCMSolenoidChannel",
+ "returnType": "int",
+ "tooltip": "Checks if a solenoid channel number is valid.\n\n:param in: channel the channel to check\n\n:returns: true if the channel is valid, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "checkDIOChannel",
+ "returnType": "int",
+ "tooltip": "Checks if a DIO channel is valid.\n\n:param channel: the channel number to check\n\n:returns: true if the channel is valid, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "checkPWMChannel",
+ "returnType": "int",
+ "tooltip": "Checks if a pwm channel is valid.\n\n:param channel: the channel to check\n\n:returns: true if the channel is valid, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "checkPowerDistributionChannel",
+ "returnType": "int",
+ "tooltip": "Checks if a PowerDistribution channel is valid.\n\n:param handle: the module handle\n:param channel: the channel to check\n\n:returns: true if the channel is valid, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "hal.PowerDistributionType"
+ }
+ ],
+ "functionName": "checkPowerDistributionModule",
+ "returnType": "int",
+ "tooltip": "Checks if a PowerDistribution module is valid.\n\n:param module: the module to check\n:param type: the type of module\n\n:returns: true if the module is valid, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ }
+ ],
+ "functionName": "checkREVPHModuleNumber",
+ "returnType": "int",
+ "tooltip": "Checks if a PH module (CAN ID) is valid.\n\n:param in: module the module to check\n\n:returns: true if the module is valid, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "checkREVPHSolenoidChannel",
+ "returnType": "int",
+ "tooltip": "Checks if a solenoid channel number is valid.\n\n:param in: channel the channel to check\n\n:returns: true if the channel is valid, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "checkRelayChannel",
+ "returnType": "int",
+ "tooltip": "Checks if a relay channel is valid.\n\n:param channel: the channel to check\n\n:returns: true if the channel is valid, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogTriggerHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "cleanAnalogTrigger",
+ "returnType": "None",
+ "tooltip": "Frees an analog trigger.\n\n:param in: analogTriggerHandle the trigger handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "cleanCAN",
+ "returnType": "None",
+ "tooltip": "Frees a CAN device\n\n:param handle: the CAN handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "interruptHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "cleanInterrupts",
+ "returnType": "None",
+ "tooltip": "Frees an interrupt.\n\n:param interruptHandle: the interrupt handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "notifierHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "cleanNotifier",
+ "returnType": "None",
+ "tooltip": "Cleans a notifier.\n\nNote this also stops a notifier if it is already running.\n\n:param in: notifierHandle the notifier handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "cleanPowerDistribution",
+ "returnType": "None",
+ "tooltip": "Cleans a PowerDistribution module.\n\n:param handle: the module handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "clearAllCTREPCMStickyFaults",
+ "returnType": "int",
+ "tooltip": "Clears all sticky faults on this device.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "clearCounterDownSource",
+ "returnType": "int",
+ "tooltip": "Disables the down counting source to the counter.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "clearCounterUpSource",
+ "returnType": "int",
+ "tooltip": "Disables the up counting source to the counter.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "clearPowerDistributionStickyFaults",
+ "returnType": "int",
+ "tooltip": "Clears any PowerDistribution sticky faults.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "clearREVPHStickyFaults",
+ "returnType": "int",
+ "tooltip": "Clears the sticky faults.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "clearSerial",
+ "returnType": "int",
+ "tooltip": "Clears the receive buffer of the serial port.\n\n:param in: handle the serial port handle\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.I2CPort"
+ }
+ ],
+ "functionName": "closeI2C",
+ "returnType": "None",
+ "tooltip": "Closes an I2C port\n\n:param port: The I2C port, 0 for the on-board, 1 for the MXP."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ }
+ ],
+ "functionName": "closeSPI",
+ "returnType": "None",
+ "tooltip": "Closes the SPI port.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for MXP"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "closeSerial",
+ "returnType": "None",
+ "tooltip": "Closes a serial port.\n\n:param in: handle the serial port handle to close"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "csToSclkTicks",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "stallTicks",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "pow2BytesPerRead",
+ "type": "int"
+ }
+ ],
+ "functionName": "configureSPIAutoStall",
+ "returnType": "int",
+ "tooltip": "Configure the Auto SPI Stall time between reads.\n\n:param in: port The number of the port to use. 0-3 for Onboard\n CS0-CS2, 4 for MXP.\n:param in: csToSclkTicks the number of ticks to wait before asserting the\n cs pin\n:param in: stallTicks the number of ticks to stall for\n:param in: pow2BytesPerRead the number of bytes to read before stalling\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "handleType",
+ "type": "hal.HandleEnum"
+ },
+ {
+ "defaultValue": null,
+ "name": "version",
+ "type": "int"
+ }
+ ],
+ "functionName": "createHandle",
+ "returnType": "int",
+ "tooltip": "Create a handle for a specific index, type and version.\n\nNote the version is not checked on the roboRIO.\n\n:param index: the index\n:param handleType: the handle type\n:param version: the handle version\n\n:returns: the created handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ }
+ ],
+ "functionName": "createPortHandle",
+ "returnType": "int",
+ "tooltip": "Create a port handle.\n\n:param channel: the channel\n:param module: the module\n\n:returns: port handle for the module and channel"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "createPortHandleForSPI",
+ "returnType": "int",
+ "tooltip": "Create a port handle for SPI.\n\n:param channel: the SPI channel\n\n:returns: port handle for the channel"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "disableSerialTermination",
+ "returnType": "int",
+ "tooltip": "Disables a termination character for reads.\n\n:param in: handle the serial port handle\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "terminator",
+ "type": "str"
+ }
+ ],
+ "functionName": "enableSerialTermination",
+ "returnType": "int",
+ "tooltip": "Sets the termination character that terminates a read.\n\nBy default this is disabled.\n\n:param in: handle the serial port handle\n:param in: terminator the termination character to set\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [],
+ "functionName": "exitMain",
+ "returnType": "None",
+ "tooltip": "Causes HAL_RunMain() to exit.\n\nIf HAL_SetMain() has been called, this calls the exit function provided\nto that function."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "unexpandedLower",
+ "type": "int"
+ }
+ ],
+ "functionName": "expandFPGATime",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Given an 32 bit FPGA time, expand it to the nearest likely 64 bit FPGA time.\n\nNote: This is making the assumption that the timestamp being converted is\nalways in the past. If you call this with a future timestamp, it probably\nwill make it in the past. If you wait over 70 minutes between capturing the\nbottom 32 bits of the timestamp and expanding it, you will be off by\nmultiples of 1<<32 microseconds.\n\n:param in: unexpandedLower 32 bit FPGA time\n:param out: status the error code, or 0 for success\n\n:returns: The current time in microseconds according to the FPGA (since FPGA\n reset) as a 64 bit number."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "fireCTREPCMOneShot",
+ "returnType": "int",
+ "tooltip": "Fire a single solenoid shot.\n\n:param in: handle the PCM handle\n:param in: index solenoid index\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "durMs",
+ "type": "int"
+ }
+ ],
+ "functionName": "fireREVPHOneShot",
+ "returnType": "int",
+ "tooltip": "Fire a single solenoid shot for the specified duration.\n\n:param in: handle the PH handle\n:param in: index solenoid index\n:param in: durMs shot duration in ms\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "flushSerial",
+ "returnType": "int",
+ "tooltip": "Flushes the serial write buffer out to the port.\n\n:param in: handle the serial port handle\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ }
+ ],
+ "functionName": "forceSPIAutoRead",
+ "returnType": "int",
+ "tooltip": "Immediately forces an SPI read to happen.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP.\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeAddressableLED",
+ "returnType": "None",
+ "tooltip": "Free the Addressable LED Handle.\n\n:param in: handle the Addressable LED handle to free"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeAnalogGyro",
+ "returnType": "None",
+ "tooltip": "Frees an analog gyro.\n\n:param handle: the gyro handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeAnalogInputPort",
+ "returnType": "None",
+ "tooltip": "Frees an analog input port.\n\n:param analogPortHandle: Handle to the analog port."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogOutputHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeAnalogOutputPort",
+ "returnType": "None",
+ "tooltip": "Frees an analog output port.\n\n:param analogOutputHandle: the analog output handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeCTREPCM",
+ "returnType": "None",
+ "tooltip": "Frees a PCM handle.\n\n:param in: handle the PCMhandle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeCounter",
+ "returnType": "None",
+ "tooltip": "Frees a counter.\n\n:param in: counterHandle the counter handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dioPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeDIOPort",
+ "returnType": "None",
+ "tooltip": "Frees a DIO port.\n\n:param dioPortHandle: the DIO channel handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmGenerator",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeDigitalPWM",
+ "returnType": "None",
+ "tooltip": "Frees the resource associated with a DO PWM generator.\n\n:param in: pwmGenerator the digital PWM handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dutyCycleHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeDutyCycle",
+ "returnType": "None",
+ "tooltip": "Free a DutyCycle.\n\n:param dutyCycleHandle: the duty cycle handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeEncoder",
+ "returnType": "None",
+ "tooltip": "Frees an encoder.\n\n:param in: encoderHandle the encoder handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freePWMPort",
+ "returnType": "None",
+ "tooltip": "Frees a PWM port.\n\n:param in: pwmPortHandle the pwm handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeREVPH",
+ "returnType": "None",
+ "tooltip": "Frees a PH handle.\n\n:param in: handle the PH handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "relayPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "freeRelayPort",
+ "returnType": "None",
+ "tooltip": "Frees a relay port.\n\n:param relayPortHandle: the relay handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ }
+ ],
+ "functionName": "freeSPIAuto",
+ "returnType": "int",
+ "tooltip": "Frees an SPI automatic accumulator.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP.\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [],
+ "functionName": "getAccelerometerX",
+ "returnType": "float",
+ "tooltip": "Gets the x-axis acceleration.\n\nThis is a floating point value in units of 1 g-force.\n\n:returns: the X acceleration"
+ },
+ {
+ "args": [],
+ "functionName": "getAccelerometerY",
+ "returnType": "float",
+ "tooltip": "Gets the y-axis acceleration.\n\nThis is a floating point value in units of 1 g-force.\n\n:returns: the Y acceleration"
+ },
+ {
+ "args": [],
+ "functionName": "getAccelerometerZ",
+ "returnType": "float",
+ "tooltip": "Gets the z-axis acceleration.\n\nThis is a floating point value in units of 1 g-force.\n\n:returns: the Z acceleration"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAccumulatorCount",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Read the number of accumulated values.\n\nRead the count of the accumulated values since the accumulator was last\nReset().\n\n:param in: analogPortHandle Handle to the analog port.\n:param out: status Error status variable. 0 on success.\n\n:returns: The number of times samples from the channel were accumulated."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAccumulatorOutput",
+ "returnType": "tuple[int, 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 in: analogPortHandle Handle to the analog port.\n:param in: value Pointer to the 64-bit accumulated output.\n:param in: count Pointer to the number of accumulation cycles.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAccumulatorValue",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Read the accumulated value.\n\nRead the value that has been accumulating on channel 1.\nThe accumulator is attached after the oversample and average engine.\n\n:param in: analogPortHandle Handle to the analog port.\n:param out: status Error status variable. 0 on success.\n\n:returns: The 64-bit value accumulated since the last Reset()."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "axes",
+ "type": "hal.JoystickAxes"
+ },
+ {
+ "defaultValue": null,
+ "name": "povs",
+ "type": "hal.JoystickPOVs"
+ },
+ {
+ "defaultValue": null,
+ "name": "buttons",
+ "type": "hal.JoystickButtons"
+ }
+ ],
+ "functionName": "getAllJoystickData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getAllianceStation",
+ "returnType": "tuple[hal.AllianceStationID, int]",
+ "tooltip": "Gets the current alliance station ID.\n\n:param out: status the error code, or 0 for success\n\n:returns: the alliance station ID"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogAverageBits",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the number of averaging bits.\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 FPGA.\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: Bits to average."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogAverageValue",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets a sample from the output of the oversample and average engine for the\nchannel.\n\nThe sample is 12-bit + the value configured in SetOversampleBits().\nThe value configured in SetAverageBits() will cause this value to be averaged\n2**bits number of samples. This is not a sliding window. The sample will not\nchange until 2**(OversampleBits + AverageBits) samples have been acquired\nfrom the module on this channel. Use GetAverageVoltage() to get the analog\nvalue in calibrated units.\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: A sample from the oversample and average engine for the channel."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogAverageVoltage",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets a scaled sample from the output of the oversample and average engine for\nthe channel.\n\nThe value is scaled to units of Volts using the calibrated scaling data from\nGetLSBWeight() and GetOffset(). Using oversampling will cause this value to\nbe higher resolution, but it will update more slowly. Using averaging will\ncause this value to be more stable, but it will update more slowly.\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: A scaled sample from the output of the oversample and average engine\n for the channel."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogGyroAngle",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the gyro angle in degrees.\n\n:param in: handle the gyro handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the gyro angle in degrees"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogGyroCenter",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the calibrated gyro center.\n\nCan be used to not repeat a calibration but reconstruct the gyro object.\n\n:param in: handle the gyro handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the gyro center"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogGyroOffset",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the calibrated gyro offset.\n\nCan be used to not repeat a calibration but reconstruct the gyro object.\n\n:param in: handle the gyro handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the gyro offset"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogGyroRate",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the gyro rate in degrees/second.\n\n:param in: handle the gyro handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the gyro rate in degrees/second"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogLSBWeight",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the factory scaling least significant bit weight constant.\nThe least significant bit weight constant for the channel that was calibrated\nin manufacturing and stored in an eeprom in the module.\n\nVolts = ((LSB_Weight * 1e-9) * raw) - (Offset * 1e-9)\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: Least significant bit weight."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogOffset",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the factory scaling offset constant.\nThe offset constant for the channel that was calibrated in manufacturing and\nstored in an eeprom in the module.\n\nVolts = ((LSB_Weight * 1e-9) * raw) - (Offset * 1e-9)\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status Error status variable. 0 on success.\n\n:returns: Offset constant."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogOutputHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogOutput",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the current analog output value.\n\n:param in: analogOutputHandle the analog output handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current output voltage (0-5v)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogOversampleBits",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the number of oversample bits.\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:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: Bits to oversample."
+ },
+ {
+ "args": [],
+ "functionName": "getAnalogSampleRate",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the current sample rate.\n\nThis assumes one entry in the scan list.\nThis is a global setting for the Athena and effects all channels.\n\n:param out: status the error code, or 0 for success\n\n:returns: Sample rate."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogTriggerHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogTriggerFPGAIndex",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Get the FPGA index for the AnalogTrigger.\n\n:param in: analogTriggerHandle the trigger handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the FPGA index"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogTriggerHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogTriggerInWindow",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns the InWindow output of the analog trigger.\n\nTrue if the analog input is between the upper and lower limits.\n\n:param in: analogTriggerHandle the trigger handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the InWindow output of the analog trigger"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogTriggerHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "hal.AnalogTriggerType"
+ }
+ ],
+ "functionName": "getAnalogTriggerOutput",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the state of the analog trigger output.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: type the type of trigger to trigger on\n:param out: status Error status variable. 0 on success.\n\n:returns: the state of the analog trigger output"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogTriggerHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogTriggerTriggerState",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns 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:param in: analogTriggerHandle the trigger handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the TriggerState output of the analog trigger"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogValue",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets a sample straight from the channel on this module.\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:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: A sample straight from the channel on this module."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rawValue",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogValueToVolts",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Get the analog voltage from a raw value.\n\n:param in: analogPortHandle Handle to the analog port the values were read\n from.\n:param in: rawValue The raw analog value\n:param out: status Error status variable. 0 on success.\n\n:returns: The voltage relating to the value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogVoltage",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets a scaled sample straight from the channel on this module.\n\nThe value is scaled to units of Volts using the calibrated scaling data from\nGetLSBWeight() and GetOffset().\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param out: status the error code, or 0 for success\n\n:returns: A scaled sample straight from the channel on this module."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "float"
+ }
+ ],
+ "functionName": "getAnalogVoltsToValue",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Converts a voltage to a raw value for a specified channel.\n\nThis process depends on the calibration of each channel, so the channel must\nbe specified.\n\n@todo This assumes raw values. Oversampling not supported as is.\n\n:param in: analogPortHandle Handle to the analog port to use.\n:param in: voltage The voltage to convert.\n:param out: status the error code, or 0 for success\n\n:returns: The raw value for the channel."
+ },
+ {
+ "args": [],
+ "functionName": "getBrownedOut",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets if the system is in a browned out state.\n\n:param out: status the error code, or 0 for success\n\n:returns: true if the system is in a low voltage brown out, false otherwise"
+ },
+ {
+ "args": [],
+ "functionName": "getBrownoutVoltage",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Get the current brownout voltage setting.\n\n:param out: status the error code, or 0 for success\n\n:returns: The brownout voltage"
+ },
+ {
+ "args": [],
+ "functionName": "getCANPacketBaseTime",
+ "returnType": "int",
+ "tooltip": "Reads the current value of the millisecond-resolution timer that the CAN API\nfunctions use as a time base.\n\n:returns: Current value of timer used as a base time by the CAN API in\n milliseconds."
+ },
+ {
+ "args": [],
+ "functionName": "getCPUTemp",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Get the current CPU temperature in degrees Celsius\n\n:param out: status the error code, or 0 for success\n\n:returns: current CPU temperature in degrees Celsius"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMClosedLoopControl",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Get whether the PCM closed loop control is enabled.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if closed loop control is enabled, otherwise false."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMCompressor",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Get whether compressor is turned on.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if the compressor is turned on"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMCompressorCurrent",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Returns the current drawn by the compressor.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: The current drawn by the compressor in amps."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMCompressorCurrentTooHighFault",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Return whether the compressor current is currently too high.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if the compressor current is too high, otherwise false.\n @see HAL_GetCTREPCMCompressorShortedStickyFault"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMCompressorCurrentTooHighStickyFault",
+ "returnType": "tuple[int, int]",
+ "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\nHAL_ClearAllCTREPCMStickyFaults()\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if the compressor current has been too high since sticky\n faults were last cleared.\n @see HAL_GetCTREPCMCompressorCurrentTooHighFault()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMCompressorNotConnectedFault",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns whether the compressor is currently disconnected.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if compressor is currently disconnected, otherwise false.\n @see HAL_GetCTREPCMCompressorNotConnectedStickyFault()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMCompressorNotConnectedStickyFault",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns whether the compressor has been disconnected since sticky faults\nwere last cleared. This fault is persistent and can be cleared by\nHAL_ClearAllCTREPCMStickyFaults()\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if the compressor has been disconnected since sticky faults\n were last cleared, otherwise false.\n @see HAL_GetCTREPCMCompressorShortedFault()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMCompressorShortedFault",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns whether the compressor is currently shorted.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if the compressor is currently shorted, otherwise false.\n @see HAL_GetCTREPCMCompressorShortedStickyFault"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMCompressorShortedStickyFault",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns whether the compressor has been shorted since sticky faults were\nlast cleared. This fault is persistent and can be cleared by\nHAL_ClearAllCTREPCMStickyFaults()\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if the compressor has been shorted since sticky faults were\n last cleared, otherwise false.\n @see HAL_GetCTREPCMCompressorShortedFault()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMPressureSwitch",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns the state of the pressure switch.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if pressure switch indicates that the system is full,\n otherwise false."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMSolenoidDisabledList",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Get a bitmask of disabled solenoids.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: Bitmask indicating disabled solenoids. The LSB represents solenoid 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMSolenoidVoltageFault",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns whether the solenoid is currently reporting a voltage fault.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if solenoid is reporting a fault, otherwise false.\n @see HAL_GetCTREPCMSolenoidVoltageStickyFault()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMSolenoidVoltageStickyFault",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns whether the solenoid has reported a voltage fault since sticky faults\nwere last cleared. This fault is persistent and can be cleared by\nHAL_ClearAllCTREPCMStickyFaults()\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if solenoid is reporting a fault, otherwise false.\n @see HAL_GetCTREPCMSolenoidVoltageFault()"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMSolenoids",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets a bitmask of solenoid values.\n\n:param in: handle the PCM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: Bitmask containing the state of the solenoids. The LSB represents\n solenoid 0."
+ },
+ {
+ "args": [],
+ "functionName": "getComments",
+ "returnType": "str",
+ "tooltip": "Returns the comments from the roboRIO web interface.\n\n:param out: comments The comments string. Free with WPI_FreeString"
+ },
+ {
+ "args": [],
+ "functionName": "getCommsDisableCount",
+ "returnType": "tuple[int, 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": [
+ {
+ "defaultValue": null,
+ "name": "controlWord",
+ "type": "hal.ControlWord"
+ }
+ ],
+ "functionName": "getControlWord",
+ "returnType": "int",
+ "tooltip": "Gets the current control word of the driver station.\n\nThe control word contains the robot state.\n\n:param controlWord: the control word (out)\n\n:returns: the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCounter",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Reads the current counter value.\n\nReads 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.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current counter value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCounterDirection",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the last direction the counter value changed.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the last direction the counter value changed"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCounterPeriod",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets 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:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the period of the last two pulses in units of seconds"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCounterSamplesToAverage",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets 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 in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.\n\n:returns: SamplesToAverage The number of samples being averaged (from 1 to 127)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCounterStopped",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Determines 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:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if the most recent counter period exceeds the MaxPeriod value\n set by SetMaxPeriod"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "isRealTime",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCurrentThreadPriority",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the thread priority for the current thread.\n\n:param out: isRealTime Set to true if thread is real-time, otherwise false.\n:param out: status Error status variable. 0 on success.\n\n:returns: The current thread priority. For real-time, this is 1-99 with 99\n being highest. For non-real-time, this is 0. See \"man 7 sched\" for\n details."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dioPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDIO",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Reads a digital value from a DIO channel.\n\n:param in: dioPortHandle the digital port handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the state of the specified channel"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dioPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDIODirection",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Reads the direction of a DIO channel.\n\n:param in: dioPortHandle the digital port handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true for input, false for output"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dutyCycleHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDutyCycleFPGAIndex",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Get the FPGA index for the DutyCycle.\n\n:param in: dutyCycleHandle the duty cycle handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the FPGA index"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dutyCycleHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDutyCycleFrequency",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Get the frequency of the duty cycle signal.\n\n:param in: dutyCycleHandle the duty cycle handle\n:param out: status Error status variable. 0 on success.\n\n:returns: frequency in Hertz"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dutyCycleHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDutyCycleHighTime",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Get the raw high time of the duty cycle signal.\n\n:param in: dutyCycleHandle the duty cycle handle\n:param out: status Error status variable. 0 on success.\n\n:returns: high time of last pulse in nanoseconds"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dutyCycleHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDutyCycleOutput",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Get the output ratio of the duty cycle signal.\n\n0 means always low, 1 means always high.\n\n:param in: dutyCycleHandle the duty cycle handle\n:param out: status Error status variable. 0 on success.\n\n:returns: output ratio between 0 and 1"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dutyCycleHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDutyCycleOutputScaleFactor",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Get the scale factor of the output.\n\nAn output equal to this value is always high, and then linearly scales\ndown to 0. Divide a raw result by this in order to get the\npercentage between 0 and 1. Used by DMA.\n\n:param in: dutyCycleHandle the duty cycle handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the output scale factor"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoder",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the current counts of the encoder after encoding type scaling.\n\nThis is scaled by the value passed during initialization to encodingType.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current scaled count"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderDecodingScaleFactor",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the decoding scale factor of the encoder.\n\nThis is used to perform the scaling from raw to type scaled values.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the scale value for the encoder"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderDirection",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the last direction the encoder value changed.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the last direction the encoder value changed"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderDistance",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the current distance traveled by the encoder.\n\nThis is the encoder count scaled by the distance per pulse set for the\nencoder.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the encoder distance (units are determined by the units\n passed to HAL_SetEncoderDistancePerPulse)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderDistancePerPulse",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the user set distance per pulse of the encoder.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the set distance per pulse"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderEncodingScale",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the encoder scale value.\n\nThis is set by the value passed during initialization to encodingType.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the encoder scale value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderEncodingType",
+ "returnType": "tuple[hal.EncoderEncodingType, int]",
+ "tooltip": "Gets the encoding type of the encoder.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the encoding type"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderFPGAIndex",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the FPGA index of the encoder.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the FPGA index of the encoder"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderPeriod",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets 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:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the period of the last two pulses in units of seconds"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderRate",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the current rate of the encoder.\n\nThis is the encoder period scaled by the distance per pulse set for the\nencoder.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the encoder rate (units are determined by the units passed to\n HAL_SetEncoderDistancePerPulse, time value is seconds)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderRaw",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the raw counts of the encoder.\n\nThis is not scaled by any values.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the raw encoder count"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderSamplesToAverage",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the current samples to average value.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current samples to average value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderStopped",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Determines if the clock is stopped.\n\nDetermines 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 encoder) are assumed to be stopped and it returns true.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if the most recent encoder period exceeds the MaxPeriod value\n set by SetMaxPeriod"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "code",
+ "type": "int"
+ }
+ ],
+ "functionName": "getErrorMessage",
+ "returnType": "str",
+ "tooltip": "Gets the error message for a specific status code.\n\n:param code: the status code\n\n:returns: the error message for the code. This does not need to be freed."
+ },
+ {
+ "args": [],
+ "functionName": "getFPGAButton",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets 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:param out: status the error code, or 0 for success\n\n:returns: true if the button is currently pressed down"
+ },
+ {
+ "args": [],
+ "functionName": "getFPGARevision",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns the FPGA Revision number.\n\nThe format of the revision is 3 numbers.\nThe 12 most significant bits are the Major Revision.\nthe next 8 bits are the Minor Revision.\nThe 12 least significant bits are the Build Number.\n\n:param out: status the error code, or 0 for success\n\n:returns: FPGA Revision number."
+ },
+ {
+ "args": [],
+ "functionName": "getFPGATime",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Reads the microsecond-resolution timer on the FPGA.\n\n:param out: status the error code, or 0 for success\n\n:returns: The current time in microseconds according to the FPGA (since FPGA\n reset)."
+ },
+ {
+ "args": [],
+ "functionName": "getFPGAVersion",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns the FPGA Version number.\n\nFor now, expect this to be competition year.\n\n:param out: status the error code, or 0 for success\n\n:returns: FPGA Version number."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "filterIndex",
+ "type": "int"
+ }
+ ],
+ "functionName": "getFilterPeriod",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the filter period for the specified filter index.\n\nGets the filter period in FPGA cycles. Even though there are 2 different\nfilter index domains (MXP vs HDR), ignore that distinction for now since it\ncomplicates the interface. Set status to NiFpga_Status_SoftwareFault if the\nfilter values mismatch.\n\n:param in: filterIndex the filter index, 0 - 2\n:param out: status Error status variable. 0 on success.\n\n:returns: The number of FPGA cycles of the filter period."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dioPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getFilterSelect",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Reads the filter index from the FPGA.\n\nGets the filter index used to filter out short pulses.\n\n:param in: dioPortHandle the digital port handle\n:param out: status Error status variable. 0 on success.\n\n:returns: filterIndex the filter index (Must be in the range 0 - 3, where 0\n means \"none\" and 1 - 3 means filter # filterIndex - 1)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getHandleIndex",
+ "returnType": "int",
+ "tooltip": "Get the handle index from a handle.\n\n:param handle: the handle\n\n:returns: the index"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getHandleType",
+ "returnType": "hal.HandleEnum",
+ "tooltip": "Get the handle type from a handle.\n\n:param handle: the handle\n\n:returns: the type"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "enumType",
+ "type": "hal.HandleEnum"
+ },
+ {
+ "defaultValue": null,
+ "name": "version",
+ "type": "int"
+ }
+ ],
+ "functionName": "getHandleTypedIndex",
+ "returnType": "int",
+ "tooltip": "Get if the handle is a correct type and version.\n\nNote the version is not checked on the roboRIO.\n\n:param handle: the handle\n:param enumType: the type to check\n:param version: the handle version to check\n\n:returns: true if the handle is proper version and type, otherwise\n false."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "axes",
+ "type": "hal.JoystickAxes"
+ }
+ ],
+ "functionName": "getJoystickAxes",
+ "returnType": "int",
+ "tooltip": "Gets the axes of a specific joystick.\n\n:param joystickNum: the joystick number\n:param axes: the axes values (output)\n\n:returns: the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ }
+ ],
+ "functionName": "getJoystickAxisType",
+ "returnType": "int",
+ "tooltip": "Gets the type of a specific joystick axis.\n\nThis is device specific, and different depending on what system input type\nthe joystick uses.\n\n:param joystickNum: the joystick number\n:param axis: the axis number\n\n:returns: the enumerated axis type"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "buttons",
+ "type": "hal.JoystickButtons"
+ }
+ ],
+ "functionName": "getJoystickButtons",
+ "returnType": "int",
+ "tooltip": "Gets the buttons of a specific joystick.\n\n:param joystickNum: the joystick number\n:param buttons: the button values (output)\n\n:returns: the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "desc",
+ "type": "hal.JoystickDescriptor"
+ }
+ ],
+ "functionName": "getJoystickDescriptor",
+ "returnType": "int",
+ "tooltip": "Retrieves the Joystick Descriptor for particular slot.\n\n:param joystickNum: the joystick number\n:param out: desc descriptor (data transfer object) to fill in. desc is\n filled in regardless of success. In other words, if\n descriptor is not available, desc is filled in with\n default values matching the init-values in Java and C++\n Driver Station for when caller requests a too-large\n joystick index.\n\n:returns: error code reported from Network Comm back-end. Zero is good,\n nonzero is bad."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ }
+ ],
+ "functionName": "getJoystickIsXbox",
+ "returnType": "int",
+ "tooltip": "Gets whether a specific joystick is considered to be an XBox controller.\n\n:param joystickNum: the joystick number\n\n:returns: true if xbox, false otherwise"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ }
+ ],
+ "functionName": "getJoystickName",
+ "returnType": "str",
+ "tooltip": "Gets the name of a joystick.\n\nThe returned string must be freed with WPI_FreeString\n\n:param name: the joystick name string\n:param joystickNum: the joystick number"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "povs",
+ "type": "hal.JoystickPOVs"
+ }
+ ],
+ "functionName": "getJoystickPOVs",
+ "returnType": "int",
+ "tooltip": "Gets the POVs of a specific joystick.\n\n:param joystickNum: the joystick number\n:param povs: the POV values (output)\n\n:returns: the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ }
+ ],
+ "functionName": "getJoystickType",
+ "returnType": "int",
+ "tooltip": "Gets the type of joystick connected.\n\nThis is device specific, and different depending on what system input type\nthe joystick uses.\n\n:param joystickNum: the joystick number\n\n:returns: the enumerated joystick type"
+ },
+ {
+ "args": [],
+ "functionName": "getLastError",
+ "returnType": "tuple[str, int]",
+ "tooltip": "Gets the last error set on this thread, or the message for the status code.\n\nIf passed HAL_USE_LAST_ERROR, the last error set on the thread will be\nreturned.\n\n:param out: status the status code, set to the error status code if input is\n HAL_USE_LAST_ERROR\n\n:returns: the error message for the code. This does not need to be freed,\n but can be overwritten by another hal call on the same thread."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "info",
+ "type": "hal.MatchInfo"
+ }
+ ],
+ "functionName": "getMatchInfo",
+ "returnType": "int",
+ "tooltip": "Gets info about a specific match.\n\n:param in: info the match info (output)\n\n:returns: the error code, or 0 for success"
+ },
+ {
+ "args": [],
+ "functionName": "getMatchTime",
+ "returnType": "tuple[float, int]",
+ "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 integer\nincrements, 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:param out: status the error code, or 0 for success\n\n:returns: Time remaining in current match period (auto or teleop) in seconds"
+ },
+ {
+ "args": [],
+ "functionName": "getNumAccumulators",
+ "returnType": "int",
+ "tooltip": "Gets the number of analog accumulators in the current system.\n\n:returns: the number of analog accumulators"
+ },
+ {
+ "args": [],
+ "functionName": "getNumAddressableLEDs",
+ "returnType": "int",
+ "tooltip": "Gets the number of addressable LED generators in the current system.\n\n:returns: the number of Addressable LED generators"
+ },
+ {
+ "args": [],
+ "functionName": "getNumAnalogInputs",
+ "returnType": "int",
+ "tooltip": "Gets the number of analog inputs in the current system.\n\n:returns: the number of analog inputs"
+ },
+ {
+ "args": [],
+ "functionName": "getNumAnalogOutputs",
+ "returnType": "int",
+ "tooltip": "Gets the number of analog outputs in the current system.\n\n:returns: the number of analog outputs"
+ },
+ {
+ "args": [],
+ "functionName": "getNumAnalogTriggers",
+ "returnType": "int",
+ "tooltip": "Gets the number of analog triggers in the current system.\n\n:returns: the number of analog triggers"
+ },
+ {
+ "args": [],
+ "functionName": "getNumCTREPCMModules",
+ "returnType": "int",
+ "tooltip": "Gets the number of PCM modules in the current system.\n\n:returns: the number of PCM modules"
+ },
+ {
+ "args": [],
+ "functionName": "getNumCTREPDPChannels",
+ "returnType": "int",
+ "tooltip": "Gets the number of PDP channels in the current system.\n\n:returns: the number of PDP channels"
+ },
+ {
+ "args": [],
+ "functionName": "getNumCTREPDPModules",
+ "returnType": "int",
+ "tooltip": "Gets the number of PDP modules in the current system.\n\n:returns: the number of PDP modules"
+ },
+ {
+ "args": [],
+ "functionName": "getNumCTRESolenoidChannels",
+ "returnType": "int",
+ "tooltip": "Gets the number of solenoid channels in the current system.\n\n:returns: the number of solenoid channels"
+ },
+ {
+ "args": [],
+ "functionName": "getNumCounters",
+ "returnType": "int",
+ "tooltip": "Gets the number of counters in the current system.\n\n:returns: the number of counters"
+ },
+ {
+ "args": [],
+ "functionName": "getNumDigitalChannels",
+ "returnType": "int",
+ "tooltip": "Gets the number of digital channels in the current system.\n\n:returns: the number of digital channels"
+ },
+ {
+ "args": [],
+ "functionName": "getNumDigitalHeaders",
+ "returnType": "int",
+ "tooltip": "Gets the number of digital headers in the current system.\n\n:returns: the number of digital headers"
+ },
+ {
+ "args": [],
+ "functionName": "getNumDigitalPWMOutputs",
+ "returnType": "int",
+ "tooltip": "Gets the number of digital IO PWM outputs in the current system.\n\n:returns: the number of digital IO PWM outputs"
+ },
+ {
+ "args": [],
+ "functionName": "getNumDutyCycles",
+ "returnType": "int",
+ "tooltip": "Gets the number of duty cycle inputs in the current system.\n\n:returns: the number of Duty Cycle inputs"
+ },
+ {
+ "args": [],
+ "functionName": "getNumEncoders",
+ "returnType": "int",
+ "tooltip": "Gets the number of quadrature encoders in the current system.\n\n:returns: the number of quadrature encoders"
+ },
+ {
+ "args": [],
+ "functionName": "getNumInterrupts",
+ "returnType": "int",
+ "tooltip": "Gets the number of interrupts in the current system.\n\n:returns: the number of interrupts"
+ },
+ {
+ "args": [],
+ "functionName": "getNumPWMChannels",
+ "returnType": "int",
+ "tooltip": "Gets the number of PWM channels in the current system.\n\n:returns: the number of PWM channels"
+ },
+ {
+ "args": [],
+ "functionName": "getNumPWMHeaders",
+ "returnType": "int",
+ "tooltip": "Gets the number of PWM headers in the current system.\n\n:returns: the number of PWM headers"
+ },
+ {
+ "args": [],
+ "functionName": "getNumREVPDHChannels",
+ "returnType": "int",
+ "tooltip": "Gets the number of PDH channels in the current system.\n\n:returns: the number of PDH channels"
+ },
+ {
+ "args": [],
+ "functionName": "getNumREVPDHModules",
+ "returnType": "int",
+ "tooltip": "Gets the number of PDH modules in the current system.\n\n:returns: the number of PDH modules"
+ },
+ {
+ "args": [],
+ "functionName": "getNumREVPHChannels",
+ "returnType": "int",
+ "tooltip": "Gets the number of PH channels in the current system.\n\n:returns: the number of PH channels"
+ },
+ {
+ "args": [],
+ "functionName": "getNumREVPHModules",
+ "returnType": "int",
+ "tooltip": "Gets the number of PH modules in the current system.\n\n:returns: the number of PH modules"
+ },
+ {
+ "args": [],
+ "functionName": "getNumRelayChannels",
+ "returnType": "int",
+ "tooltip": "Gets the number of relay channels in the current system.\n\n:returns: the number of relay channels"
+ },
+ {
+ "args": [],
+ "functionName": "getNumRelayHeaders",
+ "returnType": "int",
+ "tooltip": "Gets the number of relay headers in the current system.\n\n:returns: the number of relay headers"
+ },
+ {
+ "args": [],
+ "functionName": "getOutputsEnabled",
+ "returnType": "int",
+ "tooltip": "Gets if outputs are enabled by the control system.\n\n:returns: true if outputs are enabled"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMConfigMicroseconds",
+ "returnType": "tuple[int, int, int, int, int, int]",
+ "tooltip": "Gets the pwm configuration settings for the PWM channel.\n\nValues are in microseconds.\n\n:param in: pwmPortHandle the PWM handle\n:param in: maxPwm the maximum PWM value\n:param in: deadbandMaxPwm the high range of the center deadband\n:param in: centerPwm the center PWM value\n:param in: deadbandMinPwm the low range of the center deadband\n:param in: minPwm the minimum PWM value\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [],
+ "functionName": "getPWMCycleStartTime",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the pwm starting cycle time.\n\nThis time is relative to the FPGA time.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: the pwm cycle start time"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMEliminateDeadband",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the current eliminate deadband value.\n\n:param in: pwmPortHandle the PWM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if set, otherwise false"
+ },
+ {
+ "args": [],
+ "functionName": "getPWMLoopTiming",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the loop timing of the PWM system.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: the loop time in clock ticks"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMPosition",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets a position value from a PWM channel.\n\nThe values range from 0 to 1.\n\n:param in: pwmPortHandle the PWM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current positional PWM value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMPulseTimeMicroseconds",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the current microsecond pulse time from a PWM channel.\n\n:param in: pwmPortHandle the PWM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current PWM microsecond pulse time"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMSpeed",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets a scaled value from a PWM channel.\n\nThe values range from -1 to 1.\n\n:param in: pwmPortHandle the PWM handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the current speed PWM value"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPort",
+ "returnType": "int",
+ "tooltip": "Gets a port handle for a specific channel.\n\nThe created handle does not need to be freed.\n\n:param channel: the channel number\n\n:returns: the created port"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPortHandleChannel",
+ "returnType": "int",
+ "tooltip": "Gets the port channel of a port handle.\n\n:param handle: the port handle\n\n:returns: the port channel"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPortHandleModule",
+ "returnType": "int",
+ "tooltip": "Gets the port module of a port handle.\n\n:param handle: the port handle\n\n:returns: the port module"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPortHandleSPIEnable",
+ "returnType": "int",
+ "tooltip": "Gets the SPI channel of a port handle.\n\n:param handle: the port handle\n\n:returns: the port SPI channel"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPortWithModule",
+ "returnType": "int",
+ "tooltip": "Gets a port handle for a specific channel and module.\n\nThis is expected to be used for PCMs, as the roboRIO does not work with\nmodules anymore.\n\nThe created handle does not need to be freed.\n\n:param module: the module number\n:param channel: the channel number\n\n:returns: the created port"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "currentsLength",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionAllChannelCurrents",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the current of all channels on the PowerDistribution.\n\nThe array must be large enough to hold all channels.\n\n:param in: handle the module handle\n:param out: currents the currents\n:param in: currentsLength the length of the currents array\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionChannelCurrent",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the current of a specific PowerDistribution channel.\n\n:param in: handle the module handle\n:param in: channel the channel\n:param out: status Error status variable. 0 on success.\n\n:returns: the channel current (amps)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "faults",
+ "type": "hal.PowerDistributionFaults"
+ }
+ ],
+ "functionName": "getPowerDistributionFaults",
+ "returnType": "int",
+ "tooltip": "Get the current faults of the PowerDistribution.\n\nOn a CTRE PDP, this will return an object with no faults active.\n\n:param in: handle the module handle\n:param out: faults the HAL_PowerDistributionFaults to populate\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionModuleNumber",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the module number for a specific handle.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the module number"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionNumChannels",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the number of channels for this handle.\n\n:param in: handle the handle\n:param out: status Error status variable. 0 on success.\n\n:returns: number of channels"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "stickyFaults",
+ "type": "hal.PowerDistributionStickyFaults"
+ }
+ ],
+ "functionName": "getPowerDistributionStickyFaults",
+ "returnType": "int",
+ "tooltip": "Gets the sticky faults of the PowerDistribution.\n\nOn a CTRE PDP, this will return an object with no faults active.\n\n:param in: handle the module handle\n:param out: stickyFaults the HAL_PowerDistributionStickyFaults to populate\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionSwitchableChannel",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns true if switchable channel is powered on.\n\nThis is a REV PDH-specific function. This function will no-op on CTRE PDP.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the state of the switchable channel"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionTemperature",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the temperature of the Power Distribution Panel.\n\nNot supported on the Rev PDH and returns 0.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the module temperature (celsius)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionTotalCurrent",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the total current of the PowerDistribution.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the total current (amps)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionTotalEnergy",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the total energy of the Power Distribution Panel.\n\nNot supported on the Rev PDH and returns 0.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the total energy (joules)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionTotalPower",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the total power of the Power Distribution Panel.\n\nNot supported on the Rev PDH and returns 0.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the total power (watts)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionType",
+ "returnType": "tuple[hal.PowerDistributionType, int]",
+ "tooltip": "Gets the type of PowerDistribution module.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the type of module"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "version",
+ "type": "hal.PowerDistributionVersion"
+ }
+ ],
+ "functionName": "getPowerDistributionVersion",
+ "returnType": "int",
+ "tooltip": "Get the version of the PowerDistribution.\n\n:param in: handle the module handle\n:param out: version the HAL_PowerDistributionVersion to populate\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionVoltage",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the PowerDistribution input voltage.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the input voltage (volts)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPH5VVoltage",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Returns the current voltage of the regulated 5v supply.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: The current voltage of the 5v supply in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHAnalogVoltage",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Returns the raw voltage of the specified analog\ninput channel.\n\n:param in: handle the PH handle\n:param in: channel The analog input channel to read voltage from.\n:param out: status Error status variable. 0 on success.\n\n:returns: The voltage of the specified analog input channel in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHCompressor",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Get whether compressor is turned on.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if the compressor is turned on"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHCompressorConfig",
+ "returnType": "tuple[hal.REVPHCompressorConfigType, int]",
+ "tooltip": "Get compressor configuration from the PH.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: compressor configuration"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHCompressorCurrent",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Returns the current drawn by the compressor.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: The current drawn by the compressor in amps."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "faults",
+ "type": "hal.REVPHFaults"
+ }
+ ],
+ "functionName": "getREVPHFaults",
+ "returnType": "int",
+ "tooltip": "Returns the faults currently active on the PH.\n\n:param in: handle the PH handle\n:param out: faults The faults.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHPressureSwitch",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns the state of the digital pressure switch.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: True if pressure switch indicates that the system is full,\n otherwise false."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHSolenoidCurrent",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Returns the total current drawn by all solenoids.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: Total current drawn by all solenoids in amps."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHSolenoidDisabledList",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Get a bitmask of disabled solenoids.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: Bitmask indicating disabled solenoids. The LSB represents solenoid 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHSolenoidVoltage",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Returns the current voltage of the solenoid power supply.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: The current voltage of the solenoid power supply in volts."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHSolenoids",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets a bitmask of solenoid values.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: Bitmask containing the state of the solenoids. The LSB represents\n solenoid 0."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "stickyFaults",
+ "type": "hal.REVPHStickyFaults"
+ }
+ ],
+ "functionName": "getREVPHStickyFaults",
+ "returnType": "int",
+ "tooltip": "Returns the sticky faults currently active on this device.\n\n:param in: handle the PH handle\n:param out: stickyFaults The sticky faults.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "version",
+ "type": "hal.REVPHVersion"
+ }
+ ],
+ "functionName": "getREVPHVersion",
+ "returnType": "int",
+ "tooltip": "Returns the hardware and firmware versions of the PH.\n\n:param in: handle the PH handle\n:param out: version The hardware and firmware versions.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHVoltage",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Returns the current input voltage for the PH.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success.\n\n:returns: The input voltage in volts."
+ },
+ {
+ "args": [],
+ "functionName": "getRSLState",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the current state of the Robot Signal Light (RSL).\n\n:param out: status the error code, or 0 for success\n\n:returns: The current state of the RSL- true if on, false if off"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "relayPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getRelay",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the current state of the relay channel.\n\n:param in: relayPortHandle the relay handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true for on, false for off"
+ },
+ {
+ "args": [],
+ "functionName": "getRuntimeType",
+ "returnType": "hal.RuntimeType",
+ "tooltip": "Returns the runtime type of the HAL.\n\n:returns: HAL Runtime Type"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ }
+ ],
+ "functionName": "getSPIAutoDroppedCount",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the count of how many SPI accumulations have been missed.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP.\n:param out: status the error code, or 0 for success\n\n:returns: The number of missed accumulations."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ }
+ ],
+ "functionName": "getSPIHandle",
+ "returnType": "int",
+ "tooltip": "Gets the stored handle for a SPI port.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for MXP\n\n:returns: The stored handle for the SPI port. 0 represents no stored\n handle."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ }
+ ],
+ "functionName": "getSPIMode",
+ "returnType": "hal.SPIMode",
+ "tooltip": "Gets the SPI Mode.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP\n\n:returns: The SPI mode currently set"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getSerialBytesReceived",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the number of bytes currently in the read buffer.\n\n:param in: handle the serial port handle\n:param out: status the error code, or 0 for success\n\n:returns: the number of bytes in the read buffer"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getSerialFD",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the raw serial port file descriptor from a handle.\n\n:param in: handle the serial port handle\n:param out: status the error code, or 0 for success\n\n:returns: the raw port descriptor"
+ },
+ {
+ "args": [],
+ "functionName": "getSerialNumber",
+ "returnType": "str",
+ "tooltip": "Returns the roboRIO serial number.\n\n:param out: serialNumber The roboRIO serial number. Free with WPI_FreeString"
+ },
+ {
+ "args": [],
+ "functionName": "getSystemActive",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets if the system outputs are currently active.\n\n:param out: status the error code, or 0 for success\n\n:returns: true if the system outputs are active, false if disabled"
+ },
+ {
+ "args": [],
+ "functionName": "getSystemClockTicksPerMicrosecond",
+ "returnType": "int",
+ "tooltip": "Gets the number of FPGA system clock ticks per microsecond.\n\n:returns: the number of clock ticks per microsecond"
+ },
+ {
+ "args": [],
+ "functionName": "getSystemTimeValid",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets if the system time is valid.\n\n:param out: status the error code, or 0 for success\n\n:returns: True if the system time is valid, false otherwise"
+ },
+ {
+ "args": [],
+ "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": [],
+ "functionName": "getUserActive3V3",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the active state of the 3V3 rail.\n\n:param out: status the error code, or 0 for success\n\n:returns: true if the rail is active, otherwise false"
+ },
+ {
+ "args": [],
+ "functionName": "getUserActive5V",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the active state of the 5V rail.\n\n:param out: status the error code, or 0 for success\n\n:returns: true if the rail is active, otherwise false"
+ },
+ {
+ "args": [],
+ "functionName": "getUserActive6V",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the active state of the 6V rail.\n\n:param out: status the error code, or 0 for success\n\n:returns: true if the rail is active, otherwise false"
+ },
+ {
+ "args": [],
+ "functionName": "getUserCurrent3V3",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the 3V3 rail current.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 3V3 rail current (amps)"
+ },
+ {
+ "args": [],
+ "functionName": "getUserCurrent5V",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the 5V rail current.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 5V rail current (amps)"
+ },
+ {
+ "args": [],
+ "functionName": "getUserCurrent6V",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the 6V rail current.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 6V rail current (amps)"
+ },
+ {
+ "args": [],
+ "functionName": "getUserCurrentFaults3V3",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the fault count for the 3V3 rail. Capped at 255.\n\n:param out: status the error code, or 0 for success\n\n:returns: the number of 3V3 fault counts"
+ },
+ {
+ "args": [],
+ "functionName": "getUserCurrentFaults5V",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the fault count for the 5V rail. Capped at 255.\n\n:param out: status the error code, or 0 for success\n\n:returns: the number of 5V fault counts"
+ },
+ {
+ "args": [],
+ "functionName": "getUserCurrentFaults6V",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Gets the fault count for the 6V rail. Capped at 255.\n\n:param out: status the error code, or 0 for success\n\n:returns: the number of 6V fault counts"
+ },
+ {
+ "args": [],
+ "functionName": "getUserVoltage3V3",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the 3V3 rail voltage.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 3V3 rail voltage (volts)"
+ },
+ {
+ "args": [],
+ "functionName": "getUserVoltage5V",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the 5V rail voltage.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 5V rail voltage (volts)"
+ },
+ {
+ "args": [],
+ "functionName": "getUserVoltage6V",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the 6V rail voltage.\n\n:param out: status the error code, or 0 for success\n\n:returns: the 6V rail voltage (volts)"
+ },
+ {
+ "args": [],
+ "functionName": "getVinCurrent",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the roboRIO input current.\n\n:param out: status the error code, or 0 for success\n\n:returns: the input current (amps)"
+ },
+ {
+ "args": [],
+ "functionName": "getVinVoltage",
+ "returnType": "tuple[float, int]",
+ "tooltip": "Gets the roboRIO input voltage.\n\n:param out: status the error code, or 0 for success\n\n:returns: the input voltage (volts)"
+ },
+ {
+ "args": [],
+ "functionName": "hasMain",
+ "returnType": "int",
+ "tooltip": "Returns true if HAL_SetMain() has been called.\n\n:returns: True if HAL_SetMain() has been called, false otherwise."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "initAccumulator",
+ "returnType": "int",
+ "tooltip": "Initialize the accumulator.\n\n:param in: analogPortHandle Handle to the analog port.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "bufferSize",
+ "type": "int"
+ }
+ ],
+ "functionName": "initSPIAuto",
+ "returnType": "int",
+ "tooltip": "Initializes the SPI automatic accumulator.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2,\n 4 for MXP.\n:param in: bufferSize The accumulator buffer size.\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "timeout",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "mode",
+ "type": "int"
+ }
+ ],
+ "functionName": "initialize",
+ "returnType": "int",
+ "tooltip": "Call this to start up HAL. This is required for robot programs.\n\nThis must be called before any other HAL functions. Failure to do so will\nresult in undefined behavior, and likely segmentation faults. This means that\nany statically initialized variables in a program MUST call this function in\ntheir constructors if they want to use other HAL calls.\n\nThe common parameters are 500 for timeout and 0 for mode.\n\nThis function is safe to call from any thread, and as many times as you wish.\nIt internally guards from any reentrancy.\n\nThe applicable modes are:\n0: Try to kill an existing HAL from another program, if not successful,\nerror.\n1: Force kill a HAL from another program.\n2: Just warn if another hal exists and cannot be killed. Will likely result\nin undefined behavior.\n\n:param timeout: the initialization timeout (ms)\n:param mode: the initialization mode (see remarks)\n\n:returns: true if initialization was successful, otherwise false."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "outputPort",
+ "type": "int"
+ }
+ ],
+ "functionName": "initializeAddressableLED",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initialize Addressable LED using a PWM Digital handle.\n\n:param in: outputPort handle of the digital port for PWM\n:param out: status the error code, or 0 for success\n\n:returns: Addressable LED handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "allocationLocation",
+ "type": "str"
+ }
+ ],
+ "functionName": "initializeAnalogGyro",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes an analog gyro.\n\n:param in: handle handle to the analog input port\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status the error code, or 0 for success\n\n:returns: the initialized gyro handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "portHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "allocationLocation",
+ "type": "str"
+ }
+ ],
+ "functionName": "initializeAnalogInputPort",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes the analog input port using the given port object.\n\n:param in: portHandle Handle to the port to initialize.\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status the error code, or 0 for success\n\n:returns: the created analog input handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "portHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "allocationLocation",
+ "type": "str"
+ }
+ ],
+ "functionName": "initializeAnalogOutputPort",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes the analog output port using the given port object.\n\n:param in: portHandle handle to the port\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created analog output handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "portHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "initializeAnalogTrigger",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes an analog trigger.\n\n:param in: portHandle the analog input to use for triggering\n:param out: status Error status variable. 0 on success.\n\n:returns: the created analog trigger handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dutyCycleHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "initializeAnalogTriggerDutyCycle",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes an analog trigger with a Duty Cycle input\n\n:param in: dutyCycleHandle the analog input to use for duty cycle\n:param out: status Error status variable. 0 on success.\n\n:returns: tbe created analog trigger handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "manufacturer",
+ "type": "hal.CANManufacturer"
+ },
+ {
+ "defaultValue": null,
+ "name": "deviceId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "deviceType",
+ "type": "hal.CANDeviceType"
+ }
+ ],
+ "functionName": "initializeCAN",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes a CAN device.\n\nThese follow the FIRST standard CAN layout.\nhttps://docs.wpilib.org/en/stable/docs/software/can-devices/can-addressing.html\n\n:param in: manufacturer the can manufacturer\n:param in: deviceId the device ID (0-63)\n:param in: deviceType the device type\n:param out: status Error status variable. 0 on success.\n\n:returns: the created CAN handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "allocationLocation",
+ "type": "str"
+ }
+ ],
+ "functionName": "initializeCTREPCM",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes a PCM.\n\n:param in: module the CAN ID to initialize\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created PH handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "mode",
+ "type": "hal.CounterMode"
+ }
+ ],
+ "functionName": "initializeCounter",
+ "returnType": "tuple[int, int, int]",
+ "tooltip": "Initializes a counter.\n\n:param in: mode the counter mode\n:param in: index the compressor index (output)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "portHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "input",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "allocationLocation",
+ "type": "str"
+ }
+ ],
+ "functionName": "initializeDIOPort",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Creates a new instance of a digital port.\n\n:param in: portHandle the port handle to create from\n:param in: input true for input, false for output\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created digital handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "digitalSourceHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "triggerType",
+ "type": "hal.AnalogTriggerType"
+ }
+ ],
+ "functionName": "initializeDutyCycle",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initialize a DutyCycle input.\n\n:param in: digitalSourceHandle the digital source to use (either a\n HAL_DigitalHandle or a\n HAL_AnalogTriggerHandle)\n:param in: triggerType the analog trigger type of the source if it is\n an analog trigger\n:param out: status Error status variable. 0 on success.\n\n:returns: the created duty cycle handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "digitalSourceHandleA",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "analogTriggerTypeA",
+ "type": "hal.AnalogTriggerType"
+ },
+ {
+ "defaultValue": null,
+ "name": "digitalSourceHandleB",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "analogTriggerTypeB",
+ "type": "hal.AnalogTriggerType"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverseDirection",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "encodingType",
+ "type": "hal.EncoderEncodingType"
+ }
+ ],
+ "functionName": "initializeEncoder",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes an encoder.\n\n:param in: digitalSourceHandleA the A source (either a HAL_DigitalHandle or a\n HAL_AnalogTriggerHandle)\n:param in: analogTriggerTypeA the analog trigger type of the A source if it\n is an analog trigger\n:param in: digitalSourceHandleB the B source (either a HAL_DigitalHandle or a\n HAL_AnalogTriggerHandle)\n:param in: analogTriggerTypeB the analog trigger type of the B source if it\n is an analog trigger\n:param in: reverseDirection true to reverse the counting direction from\n standard, otherwise false\n:param in: encodingType the encoding type\n:param out: status Error status variable. 0 on success.\n\n:returns: the created encoder handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.I2CPort"
+ }
+ ],
+ "functionName": "initializeI2C",
+ "returnType": "int",
+ "tooltip": "Initializes the I2C port.\n\nOpens the port if necessary and saves the handle.\nIf opening the MXP port, also sets up the channel functions appropriately.\n\n:param in: port The port to open, 0 for the on-board, 1 for the MXP.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [],
+ "functionName": "initializeInterrupts",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes an interrupt.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: the created interrupt handle"
+ },
+ {
+ "args": [],
+ "functionName": "initializeNotifier",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes a notifier.\n\nA notifier is an FPGA controller timer that triggers at requested intervals\nbased on the FPGA time. This can be used to make precise control loops.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: the created notifier"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "portHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "allocationLocation",
+ "type": "str"
+ }
+ ],
+ "functionName": "initializePWMPort",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes a PWM port.\n\n:param in: portHandle the port to initialize\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created pwm handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "moduleNumber",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "hal.PowerDistributionType"
+ },
+ {
+ "defaultValue": null,
+ "name": "allocationLocation",
+ "type": "str"
+ }
+ ],
+ "functionName": "initializePowerDistribution",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes a Power Distribution Panel.\n\n:param in: moduleNumber the module number to initialize\n:param in: type the type of module to initialize\n:param in: allocationLocation the location where the allocation is occurring\n:param out: status Error status variable. 0 on success.\n\n:returns: the created PowerDistribution handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "module",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "allocationLocation",
+ "type": "str"
+ }
+ ],
+ "functionName": "initializeREVPH",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes a PH.\n\n:param in: module the CAN ID to initialize\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created PH handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "portHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "fwd",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "allocationLocation",
+ "type": "str"
+ }
+ ],
+ "functionName": "initializeRelayPort",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes a relay.\n\nNote this call will only initialize either the forward or reverse port of the\nrelay. If you need both, you will need to initialize 2 relays.\n\n:param in: portHandle the port handle to initialize\n:param in: fwd true for the forward port, false for the\n reverse port\n:param in: allocationLocation the location where the allocation is occurring\n (can be null)\n:param out: status Error status variable. 0 on success.\n\n:returns: the created relay handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ }
+ ],
+ "functionName": "initializeSPI",
+ "returnType": "int",
+ "tooltip": "Initializes the SPI port. Opens the port if necessary and saves the handle.\n\nIf opening the MXP port, also sets up the channel functions appropriately.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS3, 4\n for MXP\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SerialPort"
+ }
+ ],
+ "functionName": "initializeSerialPort",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes a serial port.\n\nThe channels are either the onboard RS232, the MXP UART, or 2 USB ports. The\ntop port is USB1, the bottom port is USB2.\n\n:param in: port the serial port to initialize\n:param out: status the error code, or 0 for success\n\n:returns: Serial Port Handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SerialPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "portName",
+ "type": "str"
+ }
+ ],
+ "functionName": "initializeSerialPortDirect",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Initializes a serial port with a direct name.\n\nThis name is the /dev name for a specific port.\nNote these are not always consistent between roboRIO reboots.\n\n:param in: port the serial port to initialize\n:param in: portName the dev port name\n:param out: status the error code, or 0 for success\n\n:returns: Serial Port Handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "isAccumulatorChannel",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Is the channel attached to an accumulator.\n\n:param in: analogPortHandle Handle to the analog port.\n:param out: status Error status variable. 0 on success.\n\n:returns: The analog channel is attached to an accumulator."
+ },
+ {
+ "args": [],
+ "functionName": "isAnyPulsing",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Checks if any DIO line is currently generating a pulse.\n\n:param out: status Error status variable. 0 on success.\n\n:returns: true if a pulse on some line is in progress"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "version",
+ "type": "int"
+ }
+ ],
+ "functionName": "isHandleCorrectVersion",
+ "returnType": "bool",
+ "tooltip": "Get if the version of the handle is correct.\n\nDo not use on the roboRIO, used specifically for the sim to handle resets.\n\n:param handle: the handle\n:param version: the handle version to check\n\n:returns: true if the handle is the right version, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "handleType",
+ "type": "hal.HandleEnum"
+ }
+ ],
+ "functionName": "isHandleType",
+ "returnType": "bool",
+ "tooltip": "Get if the handle is a specific type.\n\n:param handle: the handle\n:param handleType: the type to check\n\n:returns: true if the type is correct, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dioPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "isPulsing",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Checks a DIO line to see if it is currently generating a pulse.\n\n:param in: dioPortHandle the digital port handle\n:param out: status Error status variable. 0 on success.\n\n:returns: true if a pulse is in progress, otherwise false"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "latchPWMZero",
+ "returnType": "int",
+ "tooltip": "Forces a PWM signal to go to 0 temporarily.\n\n:param in: pwmPortHandle the PWM handle.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [],
+ "functionName": "loadExtensions",
+ "returnType": "int",
+ "tooltip": "Loads any extra halsim libraries provided in the HALSIM_EXTENSIONS\nenvironment variable.\n\n:returns: the success state of the initialization"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "library",
+ "type": "str"
+ }
+ ],
+ "functionName": "loadOneExtension",
+ "returnType": "int",
+ "tooltip": "Loads a single extension from a direct path.\n\nExpected to be called internally, not by users.\n\n:param library: the library path\n\n:returns: the success state of the initialization"
+ },
+ {
+ "args": [],
+ "functionName": "observeUserProgramAutonomous",
+ "returnType": "None",
+ "tooltip": "Sets the autonomous enabled flag in the DS.\n\nThis is used for the DS to ensure the robot is properly responding to its\nstate request. Ensure this gets called about every 50ms, or the robot will be\ndisabled by the DS."
+ },
+ {
+ "args": [],
+ "functionName": "observeUserProgramDisabled",
+ "returnType": "None",
+ "tooltip": "Sets the disabled flag in the DS.\n\nThis is used for the DS to ensure the robot is properly responding to its\nstate request. Ensure this gets called about every 50ms, or the robot will be\ndisabled by the DS."
+ },
+ {
+ "args": [],
+ "functionName": "observeUserProgramStarting",
+ "returnType": "None",
+ "tooltip": "Sets the program starting flag in the DS.\n\nThis is what changes the DS to showing robot code ready."
+ },
+ {
+ "args": [],
+ "functionName": "observeUserProgramTeleop",
+ "returnType": "None",
+ "tooltip": "Sets the teleoperated enabled flag in the DS.\n\nThis is used for the DS to ensure the robot is properly responding to its\nstate request. Ensure this gets called about every 50ms, or the robot will be\ndisabled by the DS."
+ },
+ {
+ "args": [],
+ "functionName": "observeUserProgramTest",
+ "returnType": "None",
+ "tooltip": "Sets the test mode flag in the DS.\n\nThis is used for the DS to ensure the robot is properly responding to its\nstate request. Ensure this gets called about every 50ms, or the robot will be\ndisabled by the DS."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "provideNewDataEventHandle",
+ "returnType": "None",
+ "tooltip": "Adds an event handle to be signalled when new data arrives.\n\n:param handle: the event handle to be signalled"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dioPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "pulseLengthSeconds",
+ "type": "float"
+ }
+ ],
+ "functionName": "pulse",
+ "returnType": "int",
+ "tooltip": "Generates a single digital pulse.\n\nWrite a pulse to the specified digital output channel. There can only be a\nsingle pulse going at any time.\n\n:param in: dioPortHandle the digital port handle\n:param in: pulseLengthSeconds the active length of the pulse (in seconds)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channelMask",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "pulseLengthSeconds",
+ "type": "float"
+ }
+ ],
+ "functionName": "pulseMultiple",
+ "returnType": "int",
+ "tooltip": "Generates a single digital pulse on multiple channels.\n\nWrite a pulse to the channels enabled by the mask. There can only be a\nsingle pulse going at any time.\n\n:param in: channelMask the channel mask\n:param in: pulseLengthSeconds the active length of the pulse (in seconds)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "readCANPacketLatest",
+ "returnType": "tuple[int, int, int]",
+ "tooltip": "Reads a CAN packet. The will continuously return the last packet received,\nwithout accounting for packet age.\n\n:param in: handle the CAN handle\n:param in: apiId the ID to read (0-1023)\n:param out: data the packet data (8 bytes)\n:param out: length the received length (0-8 bytes)\n:param out: receivedTimestamp the packet received timestamp in ms (based off\n of CLOCK_MONOTONIC)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "readCANPacketNew",
+ "returnType": "tuple[int, int, int]",
+ "tooltip": "Reads a new CAN packet.\n\nThis will only return properly once per packet received. Multiple calls\nwithout receiving another packet will return an error code.\n\n:param in: handle the CAN handle\n:param in: apiId the ID to read (0-1023)\n:param out: data the packet data (8 bytes)\n:param out: length the received length (0-8 bytes)\n:param out: receivedTimestamp the packet received timestamp in ms (based off\n of CLOCK_MONOTONIC)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "timeoutMs",
+ "type": "int"
+ }
+ ],
+ "functionName": "readCANPacketTimeout",
+ "returnType": "tuple[int, int, int]",
+ "tooltip": "Reads a CAN packet. The will return the last packet received until the\npacket is older then the requested timeout. Then it will return an error\ncode.\n\n:param in: handle the CAN handle\n:param in: apiId the ID to read (0-1023)\n:param out: data the packet data (8 bytes)\n:param out: length the received length (0-8 bytes)\n:param out: receivedTimestamp the packet received timestamp in ms (based off\n of CLOCK_MONOTONIC)\n:param out: timeoutMs the timeout time for the packet\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.I2CPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "deviceAddress",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "buffer",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "readI2C",
+ "returnType": "int",
+ "tooltip": "Executes a read transaction with the device.\n\nReads bytes from a device.\nMost I2C devices will auto-increment the register pointer internally allowing\nyou to read consecutive registers on a device in a single transaction.\n\n:param port: The I2C port, 0 for the on-board, 1 for the MXP.\n:param deviceAddress: The register to read first in the transaction.\n:param count: The number of bytes to read in the transaction.\n:param buffer: A pointer to the array of bytes to store the data read from the\n device.\n\n:returns: 0 on success or -1 on transfer abort."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "interruptHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "readInterruptFallingTimestamp",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns the timestamp for the falling interrupt that occurred most recently.\n\nThis is in the same time domain as HAL_GetFPGATime(). It only contains the\nbottom 32 bits of the timestamp. If your robot has been running for over 1\nhour, you will need to fill in the upper 32 bits yourself.\n\n:param in: interruptHandle the interrupt handle\n:param out: status Error status variable. 0 on success.\n\n:returns: timestamp in microseconds since FPGA Initialization"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "interruptHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "readInterruptRisingTimestamp",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Returns the timestamp for the rising interrupt that occurred most recently.\n\nThis is in the same time domain as HAL_GetFPGATime(). It only contains the\nbottom 32 bits of the timestamp. If your robot has been running for over 1\nhour, you will need to fill in the upper 32 bits yourself.\n\n:param in: interruptHandle the interrupt handle\n:param out: status Error status variable. 0 on success.\n\n:returns: timestamp in microseconds since FPGA Initialization"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "buffer",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "readSPI",
+ "returnType": "int",
+ "tooltip": "Executes a read from the device.\n\nThis method does not write any data out to the device.\n\nMost spi devices will require a register address to be written before they\nbegin returning data.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP\n:param buffer: A pointer to the array of bytes to store the data read from the\n device.\n:param count: The number of bytes to read in the transaction. [1..7]\n\n:returns: Number of bytes read. -1 for error."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "buffer",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "timeout",
+ "type": "float"
+ }
+ ],
+ "functionName": "readSPIAutoReceivedData",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Reads data received by the SPI accumulator. Each received data sequence\nconsists of a timestamp followed by the received data bytes, one byte per\nword (in the least significant byte). The length of each received data\nsequence is the same as the combined dataSize + zeroSize set in\nHAL_SetSPIAutoTransmitData.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2,\n 4 for MXP.\n:param out: buffer The buffer to store the data into.\n:param in: numToRead The number of words to read.\n:param in: timeout The read timeout (in seconds).\n:param out: status the error code, or 0 for success\n\n:returns: The number of words actually read."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "buffer",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "readSerial",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Reads data from the serial port.\n\nWill wait for either timeout (if set), the termination char (if set), or the\ncount to be full. Whichever one comes first.\n\n:param in: handle the serial port handle\n:param out: buffer the buffer in which to store bytes read\n:param in: count the number of bytes maximum to read\n:param out: status the error code, or 0 for success\n\n:returns: the number of bytes actually read"
+ },
+ {
+ "args": [],
+ "functionName": "refreshDSData",
+ "returnType": "int",
+ "tooltip": "Refresh the DS control word.\n\n:returns: true if updated"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "interruptHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "releaseWaitingInterrupt",
+ "returnType": "int",
+ "tooltip": "Releases a waiting interrupt.\n\nThis will release both rising and falling waiters.\n\n:param in: interruptHandle the interrupt handle to release\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "removeNewDataEventHandle",
+ "returnType": "None",
+ "tooltip": "Removes the event handle from being signalled when new data arrives.\n\n:param handle: the event handle to remove"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "resource",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "instanceNumber",
+ "type": "int"
+ },
+ {
+ "defaultValue": "0",
+ "name": "context",
+ "type": "int"
+ },
+ {
+ "defaultValue": "None",
+ "name": "feature",
+ "type": "str"
+ }
+ ],
+ "functionName": "report",
+ "returnType": "int",
+ "tooltip": "Reports a hardware usage to the HAL.\n\n:param resource: the used resource\n:param instanceNumber: the instance of the resource\n:param context: a user specified context index\n:param feature: a user specified feature string\n\n:returns: the index of the added value in NetComm"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "interruptHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "digitalSourceHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "analogTriggerType",
+ "type": "hal.AnalogTriggerType"
+ }
+ ],
+ "functionName": "requestInterrupts",
+ "returnType": "int",
+ "tooltip": "Requests interrupts on a specific digital source.\n\n:param in: interruptHandle the interrupt handle\n:param in: digitalSourceHandle the digital source handle (either a\n HAL_AnalogTriggerHandle or a\n HAL_DigitalHandle)\n:param in: analogTriggerType the trigger type if the source is an\n AnalogTrigger\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetAccumulator",
+ "returnType": "int",
+ "tooltip": "Resets the accumulator to the initial value.\n\n:param in: analogPortHandle Handle to the analog port.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetAnalogGyro",
+ "returnType": "int",
+ "tooltip": "Resets the analog gyro value to 0.\n\n:param in: handle the gyro handle\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetCounter",
+ "returnType": "int",
+ "tooltip": "Resets the Counter to zero.\n\nSets the counter value to zero. This does not effect the running state of the\ncounter, just sets the current value to zero.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetEncoder",
+ "returnType": "int",
+ "tooltip": "Reads the current encoder 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.\n\n:param in: encoderHandle the encoder handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetPowerDistributionTotalEnergy",
+ "returnType": "int",
+ "tooltip": "Resets the PowerDistribution accumulated energy.\n\nNot supported on the Rev PDH and does nothing.\n\n:param in: handle the module handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [],
+ "functionName": "resetUserCurrentFaults",
+ "returnType": "int",
+ "tooltip": "Resets the overcurrent fault counters for all user rails to 0.\n\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [],
+ "functionName": "runMain",
+ "returnType": "None",
+ "tooltip": "Runs the main function provided to HAL_SetMain().\n\nIf HAL_SetMain() has not been called, simply sleeps until HAL_ExitMain()\nis called."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "line",
+ "type": "str"
+ }
+ ],
+ "functionName": "sendConsoleLine",
+ "returnType": "int",
+ "tooltip": "Sends a line to the driver station console.\n\n:param line: the line to send (null terminated)\n\n:returns: the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "isError",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "errorCode",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "isLVCode",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "details",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "location",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "callStack",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "printMsg",
+ "type": "int"
+ }
+ ],
+ "functionName": "sendError",
+ "returnType": "int",
+ "tooltip": "Sends an error to the driver station.\n\n:param isError: true for error, false for warning\n:param errorCode: the error code\n:param isLVCode: true for a LV error code, false for a standard error code\n:param details: the details of the error\n:param location: the file location of the error\n:param callStack: the callstack of the error\n:param printMsg: true to print the error message to stdout as well as to the\n DS\n\n:returns: the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "active",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAccelerometerActive",
+ "returnType": "None",
+ "tooltip": "Sets the accelerometer to active or standby mode.\n\nIt must be in standby mode to change any configuration.\n\n:param active: true to set to active, false for standby"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "range",
+ "type": "hal.AccelerometerRange"
+ }
+ ],
+ "functionName": "setAccelerometerRange",
+ "returnType": "None",
+ "tooltip": "Sets the range of values that can be measured (either 2, 4, or 8 g-forces).\n\nThe accelerometer should be in standby mode when this is called.\n\n:param range: the accelerometer range"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAccumulatorCenter",
+ "returnType": "int",
+ "tooltip": "Set the center value of the accumulator.\n\nThe center value is subtracted from each A/D 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.\n\nThis center value is based on the output of the oversampled and averaged\nsource from channel 1. Because of this, any non-zero oversample bits will\naffect the size of the value for this field.\n\n:param in: analogPortHandle Handle to the analog port.\n:param in: center The center value of the accumulator.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadband",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAccumulatorDeadband",
+ "returnType": "int",
+ "tooltip": "Set the accumulator's deadband.\n\n:param in: analogPortHandle Handle to the analog port.\n:param in: deadband The deadband of the accumulator.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "highTime0NanoSeconds",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "lowTime0NanoSeconds",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "highTime1NanoSeconds",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "lowTime1NanoSeconds",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAddressableLEDBitTiming",
+ "returnType": "int",
+ "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 in: handle the Addressable LED handle\n:param in: highTime0NanoSeconds high time for 0 bit (default 400ns)\n:param in: lowTime0NanoSeconds low time for 0 bit (default 900ns)\n:param in: highTime1NanoSeconds high time for 1 bit (default 900ns)\n:param in: lowTime1NanoSeconds low time for 1 bit (default 600ns)\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAddressableLEDLength",
+ "returnType": "int",
+ "tooltip": "Sets the length of the LED strip.\n\nThe max length is 5460 LEDs.\n\n:param in: handle the Addressable LED handle\n:param in: length the strip length\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputPort",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAddressableLEDOutputPort",
+ "returnType": "int",
+ "tooltip": "Set the Addressable LED PWM Digital port.\n\n:param in: handle the Addressable LED handle\n:param in: outputPort The digital handle of the PWM port\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "syncTimeMicroSeconds",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAddressableLEDSyncTime",
+ "returnType": "int",
+ "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 in: handle the Addressable LED handle\n:param in: syncTimeMicroSeconds the sync time (default 280us)\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "bits",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogAverageBits",
+ "returnType": "int",
+ "tooltip": "Sets the number of averaging bits.\n\nThis sets the number of averaging bits. The actual number of averaged samples\nis 2**bits. Use averaging to improve the stability of your measurement at the\nexpense of sampling rate. The averaging is done automatically in the FPGA.\n\n:param in: analogPortHandle Handle to the analog port to configure.\n:param in: bits Number of bits to average.\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "volts",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogGyroDeadband",
+ "returnType": "int",
+ "tooltip": "Sets the deadband of the analog gyro.\n\n:param in: handle the gyro handle\n:param in: volts the voltage deadband\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltsPerDegreePerSecond",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "offset",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "center",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogGyroParameters",
+ "returnType": "int",
+ "tooltip": "Sets the analog gyro parameters to the specified values.\n\nThis is meant to be used if you want to reuse the values from a previous\ncalibration.\n\n:param in: handle the gyro handle\n:param in: voltsPerDegreePerSecond the gyro volts scaling\n:param in: offset the gyro offset\n:param in: center the gyro center\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltsPerDegreePerSecond",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogGyroVoltsPerDegreePerSecond",
+ "returnType": "int",
+ "tooltip": "Sets the analog gyro volts per degrees per second scaling.\n\n:param in: handle the gyro handle\n:param in: voltsPerDegreePerSecond the gyro volts scaling\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "device",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogInputSimDevice",
+ "returnType": "None",
+ "tooltip": "Indicates the analog input is used by a simulated device.\n\n:param handle: the analog input handle\n:param device: simulated device handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogOutputHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogOutput",
+ "returnType": "int",
+ "tooltip": "Sets an analog output value.\n\n:param in: analogOutputHandle the analog output handle\n:param in: voltage the voltage (0-5v) to output\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "bits",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogOversampleBits",
+ "returnType": "int",
+ "tooltip": "Sets 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 in: analogPortHandle Handle to the analog port to use.\n:param in: bits Number of bits to oversample.\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "samplesPerSecond",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogSampleRate",
+ "returnType": "int",
+ "tooltip": "Sets the sample rate.\n\nThis is a global setting for the Athena and effects all channels.\n\n:param in: samplesPerSecond The number of samples per channel per second.\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogTriggerHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "useAveragedValue",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogTriggerAveraged",
+ "returnType": "int",
+ "tooltip": "Configures 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\nThis is not allowed to be used if filtered mode is set.\nThis is not allowed to be used with Duty Cycle based inputs.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: useAveragedValue true to use averaged values, false for raw\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogTriggerHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "useFilteredValue",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogTriggerFiltered",
+ "returnType": "int",
+ "tooltip": "Configures the analog trigger to use a filtered value.\n\nThe analog trigger will operate with a 3 point average rejection filter. This\nis designed to help with 360 degree pot applications for the period where the\npot crosses through zero.\n\nThis is not allowed to be used if averaged mode is set.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: useFilteredValue true to use filtered values, false for average\n or raw\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogTriggerHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "lower",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "upper",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogTriggerLimitsDutyCycle",
+ "returnType": "int",
+ "tooltip": "Sets the upper and lower limits of the analog trigger.\n\nThe limits are given as floating point duty cycle values.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: lower the lower duty cycle value\n:param in: upper the upper duty cycle value\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogTriggerHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "lower",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "upper",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogTriggerLimitsRaw",
+ "returnType": "int",
+ "tooltip": "Sets the raw ADC upper and lower limits of the analog trigger.\n\nHAL_SetAnalogTriggerLimitsVoltage or HAL_SetAnalogTriggerLimitsDutyCycle\nis likely better in most cases.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: lower the lower ADC value\n:param in: upper the upper ADC value\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "analogTriggerHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "lower",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "upper",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogTriggerLimitsVoltage",
+ "returnType": "int",
+ "tooltip": "Sets the upper and lower limits of the analog trigger.\n\nThe limits are given as floating point voltage values.\n\n:param in: analogTriggerHandle the trigger handle\n:param in: lower the lower voltage value\n:param in: upper the upper voltage value\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "float"
+ }
+ ],
+ "functionName": "setBrownoutVoltage",
+ "returnType": "int",
+ "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 in: voltage The brownout voltage\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCTREPCMClosedLoopControl",
+ "returnType": "int",
+ "tooltip": "Enables the compressor closed loop control 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 that\nthe system is full.\n\n:param in: handle the PCM handle\n:param in: enabled true to enable closed loop control\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "durMs",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCTREPCMOneShotDuration",
+ "returnType": "int",
+ "tooltip": "Set the duration for a single solenoid shot.\n\n:param in: handle the PCM handle\n:param in: index solenoid index\n:param in: durMs shot duration in ms\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "values",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCTREPCMSolenoids",
+ "returnType": "int",
+ "tooltip": "Sets solenoids on a pneumatics module.\n\n:param in: handle the PCM handle\n:param in: mask Bitmask indicating which solenoids to set. The LSB represents\n solenoid 0.\n:param in: values Bitmask indicating the desired states of the solenoids. The\n LSB represents solenoid 0.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "size",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCounterAverageSize",
+ "returnType": "int",
+ "tooltip": "Sets the average sample size of a counter.\n\n:param in: counterHandle the counter handle\n:param in: size the size of samples to average\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "digitalSourceHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "analogTriggerType",
+ "type": "hal.AnalogTriggerType"
+ }
+ ],
+ "functionName": "setCounterDownSource",
+ "returnType": "int",
+ "tooltip": "Sets the source object that causes the counter to count down.\n\n:param in: counterHandle the counter handle\n:param in: digitalSourceHandle the digital source handle (either a\n HAL_AnalogTriggerHandle or a\n HAL_DigitalHandle)\n:param in: analogTriggerType the analog trigger type if the source is an\n analog trigger\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "risingEdge",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "fallingEdge",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCounterDownSourceEdge",
+ "returnType": "int",
+ "tooltip": "Sets the down source to either detect rising edges or falling edges.\nNote that both are allowed to be set true at the same time without issues.\n\n:param in: counterHandle the counter handle\n:param in: risingEdge true to trigger on rising\n:param in: fallingEdge true to trigger on falling\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCounterExternalDirectionMode",
+ "returnType": "int",
+ "tooltip": "Sets directional counting mode on this counter.\n\nThe direction is determined by the B input, with counting happening with the\nA input.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPeriod",
+ "type": "float"
+ }
+ ],
+ "functionName": "setCounterMaxPeriod",
+ "returnType": "int",
+ "tooltip": "Sets the maximum period where the device is still considered \"moving\".\n\nSets the maximum period where the device is considered moving. This value is\nused to determine the \"stopped\" state of the counter using the\nHAL_GetCounterStopped method.\n\n:param in: counterHandle the counter handle\n:param in: maxPeriod the maximum period where the counted device is\n considered moving in seconds\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "threshold",
+ "type": "float"
+ }
+ ],
+ "functionName": "setCounterPulseLengthMode",
+ "returnType": "int",
+ "tooltip": "Configures 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 in: counterHandle the counter handle\n:param in: threshold The pulse length beyond which the counter counts the\n opposite direction (seconds)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverseDirection",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCounterReverseDirection",
+ "returnType": "int",
+ "tooltip": "Sets the Counter to return reversed sensing on the direction.\n\nThis allows counters to change the direction they are counting in the case of\n1X and 2X quadrature encoding only. Any other counter mode isn't supported.\n\n:param in: counterHandle the counter handle\n:param in: reverseDirection true if the value counted should be negated.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "samplesToAverage",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCounterSamplesToAverage",
+ "returnType": "int",
+ "tooltip": "Sets 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 in: counterHandle the counter handle\n:param in: samplesToAverage The number of samples to average from 1 to 127\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "highSemiPeriod",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCounterSemiPeriodMode",
+ "returnType": "int",
+ "tooltip": "Sets Semi-period mode on this counter.\n\nThe counter counts up based on the time the input is triggered. High or Low\ndepends on the highSemiPeriod parameter.\n\n:param in: counterHandle the counter handle\n:param in: highSemiPeriod true for counting when the input is high, false for\n low\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCounterUpDownMode",
+ "returnType": "int",
+ "tooltip": "Sets standard up / down counting mode on this counter.\n\nUp and down counts are sourced independently from two inputs.\n\n:param in: counterHandle the counter handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "digitalSourceHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "analogTriggerType",
+ "type": "hal.AnalogTriggerType"
+ }
+ ],
+ "functionName": "setCounterUpSource",
+ "returnType": "int",
+ "tooltip": "Sets the source object that causes the counter to count up.\n\n:param in: counterHandle the counter handle\n:param in: digitalSourceHandle the digital source handle (either a\n HAL_AnalogTriggerHandle or a\n HAL_DigitalHandle)\n:param in: analogTriggerType the analog trigger type if the source is an\n analog trigger\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "risingEdge",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "fallingEdge",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCounterUpSourceEdge",
+ "returnType": "int",
+ "tooltip": "Sets the up source to either detect rising edges or falling edges.\n\nNote that both are allowed to be set true at the same time without issues.\n\n:param in: counterHandle the counter handle\n:param in: risingEdge true to trigger on rising\n:param in: fallingEdge true to trigger on falling\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "counterHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCounterUpdateWhenEmpty",
+ "returnType": "int",
+ "tooltip": "Selects 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.\n\nIf you enable the update when empty, you will be\nnotified of the stopped source and the event time will report 0 samples.\n\nIf you disable update when empty, the most recent average will remain on the\noutput until a new sample is acquired.\n\nYou will never see 0 samples output (except when there have been no events\nsince an FPGA reset) and you will likely not see the stopped bit become true\n(since it is updated at the end of an average and there are no samples to\naverage).\n\n:param in: counterHandle the counter handle\n:param in: enabled true to enable counter updating with no samples\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "realTime",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "priority",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCurrentThreadPriority",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Sets the thread priority for the current thread.\n\n:param in: realTime Set to true to set a real-time priority, false for\n standard priority.\n:param in: priority Priority to set the thread to. For real-time, this is\n 1-99 with 99 being highest. For non-real-time, this is\n forced to 0. See \"man 7 sched\" for more details.\n:param out: status Error status variable. 0 on success.\n\n:returns: True on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dioPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDIO",
+ "returnType": "int",
+ "tooltip": "Writes a digital value to a DIO channel.\n\n:param in: dioPortHandle the digital port handle\n:param in: value the state to set the digital channel (if it is\n configured as an output)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dioPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "input",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDIODirection",
+ "returnType": "int",
+ "tooltip": "Sets the direction of a DIO channel.\n\n:param in: dioPortHandle the digital port handle\n:param in: input true to set input, false for output\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "device",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDIOSimDevice",
+ "returnType": "None",
+ "tooltip": "Indicates the DIO channel is used by a simulated device.\n\n:param handle: the DIO channel handle\n:param device: simulated device handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmGenerator",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "dutyCycle",
+ "type": "float"
+ }
+ ],
+ "functionName": "setDigitalPWMDutyCycle",
+ "returnType": "int",
+ "tooltip": "Configures the duty-cycle of the PWM generator.\n\n:param in: pwmGenerator the digital PWM handle\n:param in: dutyCycle the percent duty cycle to output [0..1]\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmGenerator",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDigitalPWMOutputChannel",
+ "returnType": "int",
+ "tooltip": "Configures which DO channel the PWM signal is output on.\n\n:param in: pwmGenerator the digital PWM handle\n:param in: channel the channel to output on\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmGenerator",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "dutyCycle",
+ "type": "float"
+ }
+ ],
+ "functionName": "setDigitalPWMPPS",
+ "returnType": "int",
+ "tooltip": "Configures the digital PWM to be a PPS signal with specified duty cycle.\n\n:param in: pwmGenerator the digital PWM handle\n:param in: dutyCycle the percent duty cycle to output [0..1]\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "rate",
+ "type": "float"
+ }
+ ],
+ "functionName": "setDigitalPWMRate",
+ "returnType": "int",
+ "tooltip": "Changes the frequency of the DO PWM generator.\n\nThe valid range is from 0.6 Hz to 19 kHz.\n\nThe frequency resolution is logarithmic.\n\n:param in: rate the frequency to output all digital output PWM signals\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "device",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDutyCycleSimDevice",
+ "returnType": "None",
+ "tooltip": "Indicates the duty cycle is used by a simulated device.\n\n:param handle: the duty cycle handle\n:param device: simulated device handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "distancePerPulse",
+ "type": "float"
+ }
+ ],
+ "functionName": "setEncoderDistancePerPulse",
+ "returnType": "int",
+ "tooltip": "Sets the distance traveled per encoder pulse. This is used as a scaling\nfactor for the rate and distance calls.\n\n:param in: encoderHandle the encoder handle\n:param in: distancePerPulse the distance traveled per encoder pulse (units\n user defined)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "digitalSourceHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "analogTriggerType",
+ "type": "hal.AnalogTriggerType"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "hal.EncoderIndexingType"
+ }
+ ],
+ "functionName": "setEncoderIndexSource",
+ "returnType": "int",
+ "tooltip": "Sets the source for an index pulse on the encoder.\n\nThe index pulse can be used to cause an encoder to reset based on an external\ninput.\n\n:param in: encoderHandle the encoder handle\n:param in: digitalSourceHandle the index source handle (either a\n HAL_AnalogTriggerHandle or a\n HAL_DigitalHandle)\n:param in: analogTriggerType the analog trigger type if the source is an\n analog trigger\n:param in: type the index triggering type\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPeriod",
+ "type": "float"
+ }
+ ],
+ "functionName": "setEncoderMaxPeriod",
+ "returnType": "int",
+ "tooltip": "Sets the maximum period where the device is still considered \"moving\".\n\nSets the maximum period where the device is considered moving. This value is\nused to determine the \"stopped\" state of the encoder using the\nHAL_GetEncoderStopped method.\n\n:param in: encoderHandle the encoder handle\n:param in: maxPeriod the maximum period where the counted device is\n considered moving in seconds\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "minRate",
+ "type": "float"
+ }
+ ],
+ "functionName": "setEncoderMinRate",
+ "returnType": "int",
+ "tooltip": "Sets the minimum rate to be considered moving by the encoder.\n\nUnits need to match what is set by HAL_SetEncoderDistancePerPulse, with time\nas seconds.\n\n:param in: encoderHandle the encoder handle\n:param in: minRate the minimum rate to be considered moving (units are\n determined by the units passed to\n HAL_SetEncoderDistancePerPulse, time value is\n seconds)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverseDirection",
+ "type": "int"
+ }
+ ],
+ "functionName": "setEncoderReverseDirection",
+ "returnType": "int",
+ "tooltip": "Sets if to reverse the direction of the encoder.\n\nNote that this is not a toggle. It is an absolute set.\n\n:param in: encoderHandle the encoder handle\n:param in: reverseDirection true to reverse the direction, false to not.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "encoderHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "samplesToAverage",
+ "type": "int"
+ }
+ ],
+ "functionName": "setEncoderSamplesToAverage",
+ "returnType": "int",
+ "tooltip": "Sets the number of encoder samples to average when calculating encoder rate.\n\n:param in: encoderHandle the encoder handle\n:param in: samplesToAverage the number of samples to average\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "device",
+ "type": "int"
+ }
+ ],
+ "functionName": "setEncoderSimDevice",
+ "returnType": "None",
+ "tooltip": "Indicates the encoder is used by a simulated device.\n\n:param handle: the encoder handle\n:param device: simulated device handle"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "filterIndex",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "functionName": "setFilterPeriod",
+ "returnType": "int",
+ "tooltip": "Sets the filter period for the specified filter index.\n\nSets the filter period in FPGA cycles. Even though there are 2 different\nfilter index domains (MXP vs HDR), ignore that distinction for now since it\ncomplicates the interface. That can be changed later.\n\n:param in: filterIndex the filter index, 0 - 2\n:param in: value the number of cycles that the signal must not\n transition to be counted as a transition.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dioPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "filterIndex",
+ "type": "int"
+ }
+ ],
+ "functionName": "setFilterSelect",
+ "returnType": "int",
+ "tooltip": "Writes the filter index from the FPGA.\n\nSet the filter index used to filter out short pulses.\n\n:param in: dioPortHandle the digital port handle\n:param in: filterIndex the filter index (Must be in the range 0 - 3, where\n 0 means \"none\" and 1 - 3 means filter # filterIndex\n - 1)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "interruptHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "risingEdge",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "fallingEdge",
+ "type": "int"
+ }
+ ],
+ "functionName": "setInterruptUpSourceEdge",
+ "returnType": "int",
+ "tooltip": "Sets the edges to trigger the interrupt on.\n\nNote that both edges triggered is a valid configuration.\n\n:param in: interruptHandle the interrupt handle\n:param in: risingEdge true for triggering on rising edge\n:param in: fallingEdge true for triggering on falling edge\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputs",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftRumble",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightRumble",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickOutputs",
+ "returnType": "int",
+ "tooltip": "Set joystick outputs.\n\n:param joystickNum: the joystick number\n:param outputs: bitmask of outputs, 1 for on 0 for off\n:param leftRumble: the left rumble value (0-FFFF)\n:param rightRumble: the right rumble value (0-FFFF)\n\n:returns: the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "notifierHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "functionName": "setNotifierName",
+ "returnType": "int",
+ "tooltip": "Sets the name of a notifier.\n\n:param in: notifierHandle the notifier handle\n:param in: name name\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "realTime",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "priority",
+ "type": "int"
+ }
+ ],
+ "functionName": "setNotifierThreadPriority",
+ "returnType": "tuple[int, int]",
+ "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 in: realTime Set to true to set a real-time priority, false for\n standard priority.\n:param in: priority Priority to set the thread to. For real-time, this is\n 1-99 with 99 being highest. For non-real-time, this is\n forced to 0. See \"man 7 sched\" for more details.\n:param out: status Error status variable. 0 on success.\n\n:returns: True on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPWMAlwaysHighMode",
+ "returnType": "int",
+ "tooltip": "Sets the PWM output to be a continuous high signal while enabled.\n\n:param in: pwmPortHandle the PWM handle.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPwm",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadbandMaxPwm",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "centerPwm",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadbandMinPwm",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "minPwm",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPWMConfigMicroseconds",
+ "returnType": "int",
+ "tooltip": "Sets the configuration settings for the PWM channel.\n\nAll values are in microseconds.\n\n:param in: pwmPortHandle the PWM handle\n:param in: maxPwm the maximum PWM value\n:param in: deadbandMaxPwm the high range of the center deadband\n:param in: centerPwm the center PWM value\n:param in: deadbandMinPwm the low range of the center deadband\n:param in: minPwm the minimum PWM value\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPWMDisabled",
+ "returnType": "int",
+ "tooltip": "Sets a PWM channel to be disabled.\n\nThe channel is disabled until the next time it is set. Note this is different\nfrom just setting a 0 speed, as this will actively stop all signaling on the\nchannel.\n\n:param in: pwmPortHandle the PWM handle.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "eliminateDeadband",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPWMEliminateDeadband",
+ "returnType": "int",
+ "tooltip": "Sets if the FPGA should output the center value if the input value is within\nthe deadband.\n\n:param in: pwmPortHandle the PWM handle\n:param in: eliminateDeadband true to eliminate deadband, otherwise false\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "squelchMask",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPWMPeriodScale",
+ "returnType": "int",
+ "tooltip": "Sets how how often the PWM signal is squelched, thus scaling the period.\n\n:param in: pwmPortHandle the PWM handle.\n:param in: squelchMask the 2-bit mask of outputs to squelch\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "position",
+ "type": "float"
+ }
+ ],
+ "functionName": "setPWMPosition",
+ "returnType": "int",
+ "tooltip": "Sets a PWM channel to the desired position value.\n\nThe values range from 0 to 1 and the period is controlled by the PWM Period\nand MinHigh registers.\n\n:param in: pwmPortHandle the PWM handle\n:param in: position the positional PWM value to set\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "microsecondPulseTime",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPWMPulseTimeMicroseconds",
+ "returnType": "int",
+ "tooltip": "Sets a PWM channel to the desired pulse width in microseconds.\n\n:param in: pwmPortHandle the PWM handle\n:param in: microsecondPulseTime the PWM value to set\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "pwmPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "float"
+ }
+ ],
+ "functionName": "setPWMSpeed",
+ "returnType": "int",
+ "tooltip": "Sets a PWM channel to the desired scaled value.\n\nThe values range from -1 to 1 and the period is controlled by the PWM Period\nand MinHigh registers.\n\n:param in: pwmPortHandle the PWM handle\n:param in: speed the scaled PWM value to set\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPowerDistributionSwitchableChannel",
+ "returnType": "int",
+ "tooltip": "Power on/off switchable channel.\n\nThis is a REV PDH-specific function. This function will no-op on CTRE PDP.\n\n:param in: handle the module handle\n:param in: enabled true to turn on switchable channel\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "minAnalogVoltage",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAnalogVoltage",
+ "type": "float"
+ }
+ ],
+ "functionName": "setREVPHClosedLoopControlAnalog",
+ "returnType": "int",
+ "tooltip": "Enables the compressor in analog mode. This mode uses an analog\npressure sensor connected to analog channel 0 to cycle the compressor. The\ncompressor will turn on when the pressure drops below minAnalogVoltage and\nwill turn off when the pressure reaches maxAnalogVoltage. This mode is only\nsupported by the REV PH with the REV Analog Pressure Sensor connected to\nanalog channel 0.\n\n:param in: handle the PH handle\n:param in: minAnalogVoltage The compressor will turn on when the analog\n pressure sensor voltage drops below this value\n:param in: maxAnalogVoltage The compressor will turn off when the analog\n pressure sensor reaches this value.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "setREVPHClosedLoopControlDigital",
+ "returnType": "int",
+ "tooltip": "Enables the compressor in digital mode using the digital pressure switch. The\ncompressor will turn on when the pressure switch indicates that the system is\nnot full, and will turn off when the pressure switch indicates that the\nsystem is full.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "setREVPHClosedLoopControlDisabled",
+ "returnType": "int",
+ "tooltip": "Disable Compressor.\n\n:param in: handle the PH handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "minAnalogVoltage",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxAnalogVoltage",
+ "type": "float"
+ }
+ ],
+ "functionName": "setREVPHClosedLoopControlHybrid",
+ "returnType": "int",
+ "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 in: handle the PH handle\n:param in: minAnalogVoltage The compressor will turn on when the analog\n pressure sensor voltage drops below this value and the pressure switch\n indicates that the system is not full.\n:param in: maxAnalogVoltage The compressor will turn off when the analog\n pressure sensor reaches this value or the pressure switch is disconnected or\n indicates that the system is full.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "config",
+ "type": "hal.REVPHCompressorConfig"
+ }
+ ],
+ "functionName": "setREVPHCompressorConfig",
+ "returnType": "int",
+ "tooltip": "Send compressor configuration to the PH.\n\n:param in: handle the PH handle\n:param in: config compressor configuration\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "values",
+ "type": "int"
+ }
+ ],
+ "functionName": "setREVPHSolenoids",
+ "returnType": "int",
+ "tooltip": "Sets solenoids on a PH.\n\n:param in: handle the PH handle\n:param in: mask Bitmask indicating which solenoids to set. The LSB represents\n solenoid 0.\n:param in: values Bitmask indicating the desired states of the solenoids. The\n LSB represents solenoid 0.\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "relayPortHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "on",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRelay",
+ "returnType": "int",
+ "tooltip": "Sets the state of a relay output.\n\n:param in: relayPortHandle the relay handle\n:param in: on true for on, false for off\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataToSend",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "zeroSize",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSPIAutoTransmitData",
+ "returnType": "int",
+ "tooltip": "Sets the data to be transmitted to the device to initiate a read.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2,\n 4 for MXP.\n:param in: dataToSend Pointer to the data to send (Gets copied for continue\n use, so no need to keep alive).\n:param in: dataSize The length of the data to send.\n:param in: zeroSize The number of zeros to send after the data.\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ }
+ ],
+ "functionName": "setSPIChipSelectActiveHigh",
+ "returnType": "int",
+ "tooltip": "Sets the CS Active high for a SPI port.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ }
+ ],
+ "functionName": "setSPIChipSelectActiveLow",
+ "returnType": "int",
+ "tooltip": "Sets the CS Active low for a SPI port.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSPIHandle",
+ "returnType": "None",
+ "tooltip": "Sets the stored handle for a SPI port.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP.\n:param handle: The value of the handle for the port."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "mode",
+ "type": "hal.SPIMode"
+ }
+ ],
+ "functionName": "setSPIMode",
+ "returnType": "None",
+ "tooltip": "Sets the SPI Mode.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP\n:param mode: The SPI mode to use"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSPISpeed",
+ "returnType": "None",
+ "tooltip": "Sets the clock speed for the SPI bus.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4 for\n MXP\n:param speed: The speed in Hz (500KHz-10MHz)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "baud",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSerialBaudRate",
+ "returnType": "int",
+ "tooltip": "Sets the baud rate of a serial port.\n\nAny value between 0 and 0xFFFFFFFF may be used. Default is 9600.\n\n:param in: handle the serial port handle\n:param in: baud the baud rate to set\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "bits",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSerialDataBits",
+ "returnType": "int",
+ "tooltip": "Sets the number of data bits on a serial port.\n\nDefaults to 8.\n\n:param in: handle the serial port handle\n:param in: bits the number of data bits (5-8)\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "flow",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSerialFlowControl",
+ "returnType": "int",
+ "tooltip": "Sets the flow control mode of a serial port.\n\nValid values are:\n0: None (default)\n1: XON-XOFF\n2: RTS-CTS\n3: DTR-DSR\n\n:param in: handle the serial port handle\n:param in: flow the mode to set (see remarks for valid values)\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "parity",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSerialParity",
+ "returnType": "int",
+ "tooltip": "Sets the number of parity bits on a serial port.\n\nValid values are:\n0: None (default)\n1: Odd\n2: Even\n3: Mark - Means exists and always 1\n4: Space - Means exists and always 0\n\n:param in: handle the serial port handle\n:param in: parity the parity bit mode (see remarks for valid values)\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "size",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSerialReadBufferSize",
+ "returnType": "int",
+ "tooltip": "Sets the size of the read buffer.\n\n:param in: handle the serial port handle\n:param in: size the read buffer size\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "stopBits",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSerialStopBits",
+ "returnType": "int",
+ "tooltip": "Sets the number of stop bits on a serial port.\n\nValid values are:\n10: One stop bit (default)\n15: One and a half stop bits\n20: Two stop bits\n\n:param in: handle the serial port handle\n:param in: stopBits the stop bit value (see remarks for valid values)\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "timeout",
+ "type": "float"
+ }
+ ],
+ "functionName": "setSerialTimeout",
+ "returnType": "int",
+ "tooltip": "Sets the minimum serial read timeout of a port.\n\n:param in: handle the serial port handle\n:param in: timeout the timeout in milliseconds\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "size",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSerialWriteBufferSize",
+ "returnType": "int",
+ "tooltip": "Sets the size of the write buffer.\n\n:param in: handle the serial port handle\n:param in: size the write buffer size\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "mode",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSerialWriteMode",
+ "returnType": "int",
+ "tooltip": "Sets the write mode on a serial port.\n\nValid values are:\n1: Flush on access\n2: Flush when full (default)\n\n:param in: handle the serial port handle\n:param in: mode the mode to set (see remarks for valid values)\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "showMessage",
+ "type": "int"
+ }
+ ],
+ "functionName": "setShowExtensionsNotFoundMessages",
+ "returnType": "None",
+ "tooltip": "Enables or disables the message saying no HAL extensions were found.\n\nSome apps don't care, and the message create clutter. For general team code,\nwe want it.\n\nThis must be called before HAL_Initialize is called.\n\nThis defaults to true.\n\n:param showMessage: true to show message, false to not."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "int"
+ }
+ ],
+ "functionName": "setUserRailEnabled3V3",
+ "returnType": "int",
+ "tooltip": "Enables or disables the 3V3 rail.\n\n:param enabled: whether the rail should be enabled\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "int"
+ }
+ ],
+ "functionName": "setUserRailEnabled5V",
+ "returnType": "int",
+ "tooltip": "Enables or disables the 5V rail.\n\n:param enabled: whether the rail should be enabled\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "int"
+ }
+ ],
+ "functionName": "setUserRailEnabled6V",
+ "returnType": "int",
+ "tooltip": "Enables or disables the 6V rail.\n\n:param enabled: whether the rail should be enabled\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "setupAnalogGyro",
+ "returnType": "int",
+ "tooltip": "Sets up an analog gyro with the proper offsets and settings for the KOP\nanalog gyro.\n\n:param in: handle the gyro handle\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [],
+ "functionName": "shutdown",
+ "returnType": "None",
+ "tooltip": "Call this to shut down HAL.\n\nThis must be called at termination of the robot program to avoid potential\nsegmentation faults with simulation extensions at exit."
+ },
+ {
+ "args": [],
+ "functionName": "simPeriodicAfter",
+ "returnType": "None",
+ "tooltip": "Calls registered SimPeriodic \"after\" callbacks (only in simulation mode).\nThis should be called after user code periodic simulation functions."
+ },
+ {
+ "args": [],
+ "functionName": "simPeriodicBefore",
+ "returnType": "None",
+ "tooltip": "Calls registered SimPeriodic \"before\" callbacks (only in simulation mode).\nThis should be called prior to user code periodic simulation functions."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "startAddressableLEDOutput",
+ "returnType": "int",
+ "tooltip": "Starts the output.\n\nThe output writes continuously.\n\n:param in: handle the Addressable LED handle\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "float"
+ }
+ ],
+ "functionName": "startSPIAutoRate",
+ "returnType": "int",
+ "tooltip": "Sets the period for automatic SPI accumulation.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP.\n:param in: period The accumulation period (seconds).\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "digitalSourceHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "analogTriggerType",
+ "type": "hal.AnalogTriggerType"
+ },
+ {
+ "defaultValue": null,
+ "name": "triggerRising",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "triggerFalling",
+ "type": "int"
+ }
+ ],
+ "functionName": "startSPIAutoTrigger",
+ "returnType": "int",
+ "tooltip": "Starts the auto SPI accumulator on a specific trigger.\n\nNote that triggering on both rising and falling edges is a valid\nconfiguration.\n\n:param in: port The number of the port to use. 0-3 for Onboard\n CS0-CS2, 4 for MXP.\n:param in: digitalSourceHandle The trigger source to use (Either\n HAL_AnalogTriggerHandle or HAL_DigitalHandle).\n:param in: analogTriggerType The analog trigger type, if the source is an\n analog trigger.\n:param in: triggerRising Trigger on the rising edge if true.\n:param in: triggerFalling Trigger on the falling edge if true.\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "stopAddressableLEDOutput",
+ "returnType": "int",
+ "tooltip": "Stops the output.\n\n:param in: handle the Addressable LED handle\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ }
+ ],
+ "functionName": "stopCANPacketRepeating",
+ "returnType": "int",
+ "tooltip": "Stops a repeating packet with a specific ID.\n\nThis ID is 10 bits.\n\n:param in: handle the CAN handle\n:param in: apiId the ID to stop repeating (0-1023)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "notifierHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "stopNotifier",
+ "returnType": "int",
+ "tooltip": "Stops a notifier from running.\n\nThis will cause any call into HAL_WaitForNotifierAlarm to return with time =\n0.\n\n:param in: notifierHandle the notifier handle\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ }
+ ],
+ "functionName": "stopSPIAuto",
+ "returnType": "int",
+ "tooltip": "Stops an automatic SPI accumulation.\n\n:param in: port The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP.\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.I2CPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "deviceAddress",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataToSend",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataReceived",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "transactionI2C",
+ "returnType": "int",
+ "tooltip": "Generic I2C read/write transaction.\n\nThis is a lower-level interface to the I2C hardware giving you more control\nover each transaction.\n\n:param port: The I2C port, 0 for the on-board, 1 for the MXP.\n:param deviceAddress: The address of the register on the device to be\n read/written.\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: 0 on success or -1 on transfer abort."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataToSend",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataReceived",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "transactionSPI",
+ "returnType": "int",
+ "tooltip": "Performs an SPI send/receive transaction.\n\nThis is a lower-level interface to the spi hardware giving you more control\nover each transaction.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP\n:param dataToSend: Buffer of data to send as part of the transaction.\n:param dataReceived: Buffer to read data into.\n:param size: Number of bytes to transfer. [0..7]\n\n:returns: Number of bytes transferred, -1 for error"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "notifierHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "triggerTime",
+ "type": "int"
+ }
+ ],
+ "functionName": "updateNotifierAlarm",
+ "returnType": "int",
+ "tooltip": "Updates the trigger time for a notifier.\n\nNote that this time is an absolute time relative to HAL_GetFPGATime()\n\n:param in: notifierHandle the notifier handle\n:param in: triggerTime the updated trigger time\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "interruptHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "timeout",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "ignorePrevious",
+ "type": "int"
+ }
+ ],
+ "functionName": "waitForInterrupt",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Waits for the defined interrupt to occur.\n\n:param in: interruptHandle the interrupt handle\n:param in: timeout timeout in seconds\n:param in: ignorePrevious if true, ignore interrupts that happened before\n waitForInterrupt was called\n:param out: status Error status variable. 0 on success.\n\n:returns: the mask of interrupts that fired"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "interruptHandle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "mask",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "timeout",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "ignorePrevious",
+ "type": "int"
+ }
+ ],
+ "functionName": "waitForMultipleInterrupts",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Waits for any interrupt covered by the mask to occur.\n\n:param in: interruptHandle the interrupt handle to use for the context\n:param in: mask the mask of interrupts to wait for\n:param in: timeout timeout in seconds\n:param in: ignorePrevious if true, ignore interrupts that happened before\n waitForInterrupt was called\n:param out: status Error status variable. 0 on success.\n\n:returns: the mask of interrupts that fired"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "notifierHandle",
+ "type": "int"
+ }
+ ],
+ "functionName": "waitForNotifierAlarm",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Waits for the next alarm for the specific notifier.\n\nThis is a blocking call until either the time elapses or HAL_StopNotifier\ngets called. If the latter occurs, this function will return zero and any\nloops using this function should exit. Failing to do so can lead to\nuse-after-frees.\n\n:param in: notifierHandle the notifier handle\n:param out: status Error status variable. 0 on success.\n\n:returns: the FPGA time the notifier returned"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "hal.AddressableLEDData"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ }
+ ],
+ "functionName": "writeAddressableLEDData",
+ "returnType": "int",
+ "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 in: handle the Addressable LED handle\n:param in: data the buffer to write\n:param in: length the strip length\n:param out: status the error code, or 0 for success"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ }
+ ],
+ "functionName": "writeCANPacket",
+ "returnType": "int",
+ "tooltip": "Writes a packet to the CAN device with a specific ID.\n\nThis ID is 10 bits.\n\n:param in: handle the CAN handle\n:param in: data the data to write (0-8 bytes)\n:param in: length the length of data (0-8)\n:param in: apiId the ID to write (0-1023 bits)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "Buffer"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "repeatMs",
+ "type": "int"
+ }
+ ],
+ "functionName": "writeCANPacketRepeating",
+ "returnType": "int",
+ "tooltip": "Writes a repeating packet to the CAN device with a specific ID.\n\nThis ID is 10 bits.\n\nThe RoboRIO will automatically repeat the packet at the specified interval\n\n:param in: handle the CAN handle\n:param in: data the data to write (0-8 bytes)\n:param in: length the length of data (0-8)\n:param in: apiId the ID to write (0-1023)\n:param in: repeatMs the period to repeat in ms\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "apiId",
+ "type": "int"
+ }
+ ],
+ "functionName": "writeCANRTRFrame",
+ "returnType": "int",
+ "tooltip": "Writes an RTR frame of the specified length to the CAN device with the\nspecific ID.\n\nBy spec, the length must be equal to the length sent by the other device,\notherwise behavior is unspecified.\n\n:param in: handle the CAN handle\n:param in: length the length of data to request (0-8)\n:param in: apiId the ID to write (0-1023)\n:param out: status Error status variable. 0 on success."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.I2CPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "deviceAddress",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataToSend",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "writeI2C",
+ "returnType": "int",
+ "tooltip": "Executes a write transaction with the device.\n\nWrites a single byte to a register on a device and wait until the\ntransaction is complete.\n\n:param port: The I2C port, 0 for the on-board, 1 for the MXP.\n:param deviceAddress: The address of the register on the device to be\n written.\n:param dataToSend: The byte to write to the register on the device.\n:param sendSize: Number of bytes to send.\n\n:returns: 0 on success or -1 on transfer abort."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "port",
+ "type": "hal.SPIPort"
+ },
+ {
+ "defaultValue": null,
+ "name": "dataToSend",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "writeSPI",
+ "returnType": "int",
+ "tooltip": "Executes a write transaction with the device.\n\nWrites to a device and wait until the transaction is complete.\n\n:param port: The number of the port to use. 0-3 for Onboard CS0-CS2, 4\n for MXP\n:param dataToSend: The data to write to the register on the device.\n:param sendSize: The number of bytes to be written\n\n:returns: The number of bytes written. -1 for an error"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "buffer",
+ "type": "Buffer"
+ }
+ ],
+ "functionName": "writeSerial",
+ "returnType": "tuple[int, int]",
+ "tooltip": "Writes data to the serial port.\n\n:param in: handle the serial port handle\n:param in: buffer the buffer to write\n:param in: count the number of bytes to write from the buffer\n:param out: status the error code, or 0 for success\n\n:returns: the number of bytes actually written"
+ }
+ ],
+ "moduleName": "hal",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "hal.exceptions",
+ "moduleVariables": []
+ },
+ {
+ "enums": [
+ {
+ "enumClassName": "hal.simulation.AnalogTriggerMode",
+ "enumValues": [
+ "HALSIM_AnalogTriggerAveraged",
+ "HALSIM_AnalogTriggerDutyCycle",
+ "HALSIM_AnalogTriggerFiltered",
+ "HALSIM_AnalogTriggerUnassigned"
+ ],
+ "moduleName": "hal.simulation",
+ "tooltip": "Members:\n\n HALSIM_AnalogTriggerUnassigned\n\n HALSIM_AnalogTriggerFiltered\n\n HALSIM_AnalogTriggerDutyCycle\n\n HALSIM_AnalogTriggerAveraged"
+ }
+ ],
+ "functions": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAccelerometerActiveCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAccelerometerRangeCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAccelerometerXCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAccelerometerYCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAccelerometerZCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAddressableLEDDataCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAddressableLEDInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAddressableLEDLengthCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAddressableLEDOutputPortCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAddressableLEDRunningCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "cancelAllSimPeriodicCallbacks",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogGyroAngleCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogGyroInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogGyroRateCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogInAccumulatorCenterCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogInAccumulatorCountCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogInAccumulatorDeadbandCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogInAccumulatorInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogInAccumulatorValueCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogInAverageBitsCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogInInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogInOversampleBitsCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogInVoltageCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogOutInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogOutVoltageCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogTriggerInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogTriggerTriggerLowerBoundCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogTriggerTriggerModeCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelAnalogTriggerTriggerUpperBoundCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelCTREPCMClosedLoopEnabledCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelCTREPCMCompressorCurrentCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelCTREPCMCompressorOnCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelCTREPCMInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelCTREPCMPressureSwitchCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelCTREPCMSolenoidOutputCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDIOFilterIndexCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDIOInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDIOIsInputCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDIOPulseLengthCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDIOValueCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDigitalPWMDutyCycleCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDigitalPWMInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDigitalPWMPinCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDriverStationAllianceStationIdCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDriverStationAutonomousCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDriverStationDsAttachedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDriverStationEStopCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDriverStationEnabledCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDriverStationFmsAttachedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDriverStationMatchTimeCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDriverStationNewDataCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDriverStationTestCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDutyCycleFrequencyCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDutyCycleInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelDutyCycleOutputCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelEncoderCountCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelEncoderDirectionCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelEncoderDistancePerPulseCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelEncoderInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelEncoderMaxPeriodCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelEncoderPeriodCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelEncoderResetCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelEncoderReverseDirectionCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelEncoderSamplesToAverageCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelJoystickAxesCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelJoystickButtonsCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelJoystickDescriptorCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelJoystickOutputsCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelJoystickPOVsCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelMatchInfoCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelPWMInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelPWMPeriodScaleCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelPWMPositionCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelPWMSpeedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelPWMZeroLatchCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelPowerDistributionCurrentCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelPowerDistributionInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelPowerDistributionTemperatureCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelPowerDistributionVoltageCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelREVPHCompressorConfigTypeCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelREVPHCompressorCurrentCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelREVPHCompressorOnCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelREVPHInitializedCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelREVPHPressureSwitchCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelREVPHSolenoidOutputCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRelayForwardCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRelayInitializedForwardCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRelayInitializedReverseCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRelayReverseCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioBrownoutVoltageCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioCPUTempCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioCommentsCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioFPGAButtonCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioRadioLEDStateCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioSerialNumberCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioTeamNumberCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserActive3V3Callback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserActive5VCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserActive6VCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserCurrent3V3Callback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserCurrent5VCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserCurrent6VCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserFaults3V3Callback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserFaults5VCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserFaults6VCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserVoltage3V3Callback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserVoltage5VCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioUserVoltage6VCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioVInCurrentCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelRoboRioVInVoltageCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelSPIAccelerometerActiveCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelSPIAccelerometerRangeCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelSPIAccelerometerXCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelSPIAccelerometerYCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "uid",
+ "type": "int"
+ }
+ ],
+ "functionName": "cancelSPIAccelerometerZCallback",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "findAddressableLEDForChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "findAnalogTriggerForChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "findDigitalPWMForChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "findDutyCycleForChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "findEncoderForChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAccelerometerActive",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAccelerometerRange",
+ "returnType": "hal.AccelerometerRange",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAccelerometerX",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAccelerometerY",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAccelerometerZ",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "hal.AddressableLEDData"
+ }
+ ],
+ "functionName": "getAddressableLEDData",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAddressableLEDInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAddressableLEDLength",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAddressableLEDOutputPort",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAddressableLEDRunning",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogGyroAngle",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogGyroInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogGyroRate",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogInAccumulatorCenter",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogInAccumulatorCount",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogInAccumulatorDeadband",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogInAccumulatorInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogInAccumulatorValue",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogInAverageBits",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogInInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogInOversampleBits",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogInSimDevice",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogInVoltage",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogOutInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogOutVoltage",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogTriggerInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogTriggerTriggerLowerBound",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogTriggerTriggerMode",
+ "returnType": "hal.simulation.AnalogTriggerMode",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getAnalogTriggerTriggerUpperBound",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMAllSolenoids",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMClosedLoopEnabled",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMCompressorCurrent",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMCompressorOn",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMPressureSwitch",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "getCTREPCMSolenoidOutput",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDIOFilterIndex",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDIOInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDIOIsInput",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDIOPulseLength",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDIOSimDevice",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDIOValue",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDigitalPWMDutyCycle",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDigitalPWMInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDigitalPWMPin",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getDriverStationAllianceStationId",
+ "returnType": "hal.AllianceStationID",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getDriverStationAutonomous",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getDriverStationDsAttached",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getDriverStationEStop",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getDriverStationEnabled",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getDriverStationFmsAttached",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getDriverStationMatchTime",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getDriverStationTest",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDutyCycleDigitalChannel",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDutyCycleFrequency",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDutyCycleInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDutyCycleOutput",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getDutyCycleSimDevice",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderCount",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderDigitalChannelA",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderDigitalChannelB",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderDirection",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderDistance",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderDistancePerPulse",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderMaxPeriod",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderPeriod",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderRate",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderReset",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderReverseDirection",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderSamplesToAverage",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getEncoderSimDevice",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "axes",
+ "type": "hal.JoystickAxes"
+ }
+ ],
+ "functionName": "getJoystickAxes",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "buttons",
+ "type": "hal.JoystickButtons"
+ }
+ ],
+ "functionName": "getJoystickButtons",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ }
+ ],
+ "functionName": "getJoystickCounts",
+ "returnType": "tuple[int, int, int]",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "descriptor",
+ "type": "hal.JoystickDescriptor"
+ }
+ ],
+ "functionName": "getJoystickDescriptor",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ }
+ ],
+ "functionName": "getJoystickOutputs",
+ "returnType": "tuple[int, int, int]",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "povs",
+ "type": "hal.JoystickPOVs"
+ }
+ ],
+ "functionName": "getJoystickPOVs",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "info",
+ "type": "hal.MatchInfo"
+ }
+ ],
+ "functionName": "getMatchInfo",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getNextNotifierTimeout",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "arr",
+ "type": "hal.simulation.NotifierInfo"
+ },
+ {
+ "defaultValue": null,
+ "name": "size",
+ "type": "int"
+ }
+ ],
+ "functionName": "getNotifierInfo",
+ "returnType": "int",
+ "tooltip": "Gets detailed information about each notifier.\n\n:param arr: array of information to be filled\n:param size: size of arr\n\n:returns: Number of notifiers; note: may be larger than passed-in size"
+ },
+ {
+ "args": [],
+ "functionName": "getNumNotifiers",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMPeriodScale",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMPosition",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMPulseMicrosecond",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMSpeed",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPWMZeroLatch",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionAllCurrents",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionCurrent",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionTemperature",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getPowerDistributionVoltage",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getProgramStarted",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHAllSolenoids",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHCompressorConfigType",
+ "returnType": "hal.REVPHCompressorConfigType",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHCompressorCurrent",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHCompressorOn",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHInitialized",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHPressureSwitch",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ }
+ ],
+ "functionName": "getREVPHSolenoidOutput",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getRelayForward",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getRelayInitializedForward",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getRelayInitializedReverse",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getRelayReverse",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioBrownoutVoltage",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioCPUTemp",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioComments",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioFPGAButton",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioRadioLEDState",
+ "returnType": "hal.HAL_RadioLEDState",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioSerialNumber",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioTeamNumber",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserActive3V3",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserActive5V",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserActive6V",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserCurrent3V3",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserCurrent5V",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserCurrent6V",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserFaults3V3",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserFaults5V",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserFaults6V",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserVoltage3V3",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserVoltage5V",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioUserVoltage6V",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioVInCurrent",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "getRoboRioVInVoltage",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getSPIAccelerometerActive",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getSPIAccelerometerRange",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getSPIAccelerometerX",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getSPIAccelerometerY",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "getSPIAccelerometerZ",
+ "returnType": "float",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "functionName": "getSimDeviceHandle",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getSimDeviceName",
+ "returnType": "str",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "handle",
+ "type": "int"
+ }
+ ],
+ "functionName": "getSimValueDeviceHandle",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "device",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "functionName": "getSimValueHandle",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "functionName": "isSimDeviceEnabled",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "isTimingPaused",
+ "returnType": "int",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "notifyDriverStationNewData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "pauseTiming",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[], None]"
+ }
+ ],
+ "functionName": "registerSimPeriodicAfterCallback",
+ "returnType": "hal.simulation.SimCB",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[], None]"
+ }
+ ],
+ "functionName": "registerSimPeriodicBeforeCallback",
+ "returnType": "hal.simulation.SimCB",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "hal.SimValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, int, hal.SimValueDirection, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "functionName": "registerSimValueChangedCallback",
+ "returnType": "hal.simulation.SimValueCB",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "device",
+ "type": "hal.SimDevice"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, int, hal.SimValueDirection, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "functionName": "registerSimValueCreatedCallback",
+ "returnType": "hal.simulation.SimValueCB",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "hal.SimValue"
+ },
+ {
+ "defaultValue": null,
+ "name": "callback",
+ "type": "Callable[[str, int, hal.SimValueDirection, hal.Value], None]"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialNotify",
+ "type": "bool"
+ }
+ ],
+ "functionName": "registerSimValueResetCallback",
+ "returnType": "hal.simulation.SimValueCB",
+ "tooltip": "Register a callback for HAL_SimValueReset(). The callback is called with the\nold value.\n\n:param value: simulated value handle\n:param param: parameter for callback\n:param callback: callback\n:param initialNotify: ignored (present for consistency)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetAccelerometerData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetAddressableLEDData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "resetAllSimData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetAnalogGyroData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetAnalogInData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetAnalogOutData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetAnalogTriggerData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetCTREPCMData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetDIOData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetDigitalPWMData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "resetDriverStationData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetDutyCycleData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetEncoderData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "resetGlobalHandles",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetPWMData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetPowerDistributionData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetREVPHData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetRelayData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "resetRoboRioData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ }
+ ],
+ "functionName": "resetSPIAccelerometerData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "resetSimDeviceData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "restartTiming",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "resumeTiming",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "active",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAccelerometerActive",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "range",
+ "type": "hal.AccelerometerRange"
+ }
+ ],
+ "functionName": "setAccelerometerRange",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAccelerometerX",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAccelerometerY",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "z",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAccelerometerZ",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "data",
+ "type": "hal.AddressableLEDData"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAddressableLEDData",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAddressableLEDInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAddressableLEDLength",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputPort",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAddressableLEDOutputPort",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "running",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAddressableLEDRunning",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogGyroAngle",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogGyroInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rate",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogGyroRate",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "accumulatorCenter",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogInAccumulatorCenter",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "accumulatorCount",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogInAccumulatorCount",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "accumulatorDeadband",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogInAccumulatorDeadband",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "accumulatorInitialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogInAccumulatorInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "accumulatorValue",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogInAccumulatorValue",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "averageBits",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogInAverageBits",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogInInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "oversampleBits",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogInOversampleBits",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogInVoltage",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogOutInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogOutVoltage",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setAnalogTriggerInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "triggerLowerBound",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogTriggerTriggerLowerBound",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "triggerMode",
+ "type": "hal.simulation.AnalogTriggerMode"
+ }
+ ],
+ "functionName": "setAnalogTriggerTriggerMode",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "triggerUpperBound",
+ "type": "float"
+ }
+ ],
+ "functionName": "setAnalogTriggerTriggerUpperBound",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "values",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCTREPCMAllSolenoids",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "closedLoopEnabled",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCTREPCMClosedLoopEnabled",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "compressorCurrent",
+ "type": "float"
+ }
+ ],
+ "functionName": "setCTREPCMCompressorCurrent",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "compressorOn",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCTREPCMCompressorOn",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "solenoidInitialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCTREPCMInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "pressureSwitch",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCTREPCMPressureSwitch",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "solenoidOutput",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCTREPCMSolenoidOutput",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "filterIndex",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDIOFilterIndex",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDIOInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "isInput",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDIOIsInput",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "pulseLength",
+ "type": "float"
+ }
+ ],
+ "functionName": "setDIOPulseLength",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDIOValue",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "dutyCycle",
+ "type": "float"
+ }
+ ],
+ "functionName": "setDigitalPWMDutyCycle",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDigitalPWMInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "pin",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDigitalPWMPin",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "allianceStationId",
+ "type": "hal.AllianceStationID"
+ }
+ ],
+ "functionName": "setDriverStationAllianceStationId",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "autonomous",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDriverStationAutonomous",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "dsAttached",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDriverStationDsAttached",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "eStop",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDriverStationEStop",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDriverStationEnabled",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "fmsAttached",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDriverStationFmsAttached",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "matchTime",
+ "type": "float"
+ }
+ ],
+ "functionName": "setDriverStationMatchTime",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "test",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDriverStationTest",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "frequency",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDutyCycleFrequency",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setDutyCycleInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "output",
+ "type": "float"
+ }
+ ],
+ "functionName": "setDutyCycleOutput",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "functionName": "setEncoderCount",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "direction",
+ "type": "int"
+ }
+ ],
+ "functionName": "setEncoderDirection",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "distance",
+ "type": "float"
+ }
+ ],
+ "functionName": "setEncoderDistance",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "distancePerPulse",
+ "type": "float"
+ }
+ ],
+ "functionName": "setEncoderDistancePerPulse",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setEncoderInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "maxPeriod",
+ "type": "float"
+ }
+ ],
+ "functionName": "setEncoderMaxPeriod",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "period",
+ "type": "float"
+ }
+ ],
+ "functionName": "setEncoderPeriod",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rate",
+ "type": "float"
+ }
+ ],
+ "functionName": "setEncoderRate",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "reset",
+ "type": "int"
+ }
+ ],
+ "functionName": "setEncoderReset",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverseDirection",
+ "type": "int"
+ }
+ ],
+ "functionName": "setEncoderReverseDirection",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "samplesToAverage",
+ "type": "int"
+ }
+ ],
+ "functionName": "setEncoderSamplesToAverage",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "functionName": "setEventName",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "message",
+ "type": "str"
+ }
+ ],
+ "functionName": "setGameSpecificMessage",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "axes",
+ "type": "hal.JoystickAxes"
+ }
+ ],
+ "functionName": "setJoystickAxes",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ }
+ ],
+ "functionName": "setJoystickAxis",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickAxisCount",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "axis",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickAxisType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "button",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickButton",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickButtonCount",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "buttons",
+ "type": "hal.JoystickButtons"
+ }
+ ],
+ "functionName": "setJoystickButtons",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "buttons",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickButtonsValue",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "descriptor",
+ "type": "hal.JoystickDescriptor"
+ }
+ ],
+ "functionName": "setJoystickDescriptor",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "isXbox",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickIsXbox",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "name",
+ "type": "str"
+ }
+ ],
+ "functionName": "setJoystickName",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "outputs",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "leftRumble",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "rightRumble",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickOutputs",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "pov",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickPOV",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "count",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickPOVCount",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "joystickNum",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "povs",
+ "type": "hal.JoystickPOVs"
+ }
+ ],
+ "functionName": "setJoystickPOVs",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "stick",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "int"
+ }
+ ],
+ "functionName": "setJoystickType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "info",
+ "type": "hal.MatchInfo"
+ }
+ ],
+ "functionName": "setMatchInfo",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "matchNumber",
+ "type": "int"
+ }
+ ],
+ "functionName": "setMatchNumber",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "hal.MatchType"
+ }
+ ],
+ "functionName": "setMatchType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPWMInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "periodScale",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPWMPeriodScale",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "position",
+ "type": "float"
+ }
+ ],
+ "functionName": "setPWMPosition",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "microsecondPulseTime",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPWMPulseMicrosecond",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "speed",
+ "type": "float"
+ }
+ ],
+ "functionName": "setPWMSpeed",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "zeroLatch",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPWMZeroLatch",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "currents",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "length",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPowerDistributionAllCurrents",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "current",
+ "type": "float"
+ }
+ ],
+ "functionName": "setPowerDistributionCurrent",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setPowerDistributionInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "temperature",
+ "type": "float"
+ }
+ ],
+ "functionName": "setPowerDistributionTemperature",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "voltage",
+ "type": "float"
+ }
+ ],
+ "functionName": "setPowerDistributionVoltage",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "setProgramStarted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "values",
+ "type": "int"
+ }
+ ],
+ "functionName": "setREVPHAllSolenoids",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "configType",
+ "type": "hal.REVPHCompressorConfigType"
+ }
+ ],
+ "functionName": "setREVPHCompressorConfigType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "compressorCurrent",
+ "type": "float"
+ }
+ ],
+ "functionName": "setREVPHCompressorCurrent",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "compressorOn",
+ "type": "int"
+ }
+ ],
+ "functionName": "setREVPHCompressorOn",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "solenoidInitialized",
+ "type": "int"
+ }
+ ],
+ "functionName": "setREVPHInitialized",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "pressureSwitch",
+ "type": "int"
+ }
+ ],
+ "functionName": "setREVPHPressureSwitch",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "channel",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "solenoidOutput",
+ "type": "int"
+ }
+ ],
+ "functionName": "setREVPHSolenoidOutput",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "forward",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRelayForward",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initializedForward",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRelayInitializedForward",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "initializedReverse",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRelayInitializedReverse",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "reverse",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRelayReverse",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "replayNumber",
+ "type": "int"
+ }
+ ],
+ "functionName": "setReplayNumber",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "brownoutVoltage",
+ "type": "float"
+ }
+ ],
+ "functionName": "setRoboRioBrownoutVoltage",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "cpuTemp",
+ "type": "float"
+ }
+ ],
+ "functionName": "setRoboRioCPUTemp",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "comments",
+ "type": "str"
+ }
+ ],
+ "functionName": "setRoboRioComments",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "fPGAButton",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRoboRioFPGAButton",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "state",
+ "type": "hal.HAL_RadioLEDState"
+ }
+ ],
+ "functionName": "setRoboRioRadioLEDState",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "serialNumber",
+ "type": "str"
+ }
+ ],
+ "functionName": "setRoboRioSerialNumber",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "teamNumber",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRoboRioTeamNumber",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userActive3V3",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRoboRioUserActive3V3",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userActive5V",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRoboRioUserActive5V",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userActive6V",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRoboRioUserActive6V",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userCurrent3V3",
+ "type": "float"
+ }
+ ],
+ "functionName": "setRoboRioUserCurrent3V3",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userCurrent5V",
+ "type": "float"
+ }
+ ],
+ "functionName": "setRoboRioUserCurrent5V",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userCurrent6V",
+ "type": "float"
+ }
+ ],
+ "functionName": "setRoboRioUserCurrent6V",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userFaults3V3",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRoboRioUserFaults3V3",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userFaults5V",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRoboRioUserFaults5V",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userFaults6V",
+ "type": "int"
+ }
+ ],
+ "functionName": "setRoboRioUserFaults6V",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userVoltage3V3",
+ "type": "float"
+ }
+ ],
+ "functionName": "setRoboRioUserVoltage3V3",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userVoltage5V",
+ "type": "float"
+ }
+ ],
+ "functionName": "setRoboRioUserVoltage5V",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "userVoltage6V",
+ "type": "float"
+ }
+ ],
+ "functionName": "setRoboRioUserVoltage6V",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "vInCurrent",
+ "type": "float"
+ }
+ ],
+ "functionName": "setRoboRioVInCurrent",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "vInVoltage",
+ "type": "float"
+ }
+ ],
+ "functionName": "setRoboRioVInVoltage",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "hal.RuntimeType"
+ }
+ ],
+ "functionName": "setRuntimeType",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "active",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSPIAccelerometerActive",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "range",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSPIAccelerometerRange",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "float"
+ }
+ ],
+ "functionName": "setSPIAccelerometerX",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "float"
+ }
+ ],
+ "functionName": "setSPIAccelerometerY",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "index",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "z",
+ "type": "float"
+ }
+ ],
+ "functionName": "setSPIAccelerometerZ",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "prefix",
+ "type": "str"
+ },
+ {
+ "defaultValue": null,
+ "name": "enabled",
+ "type": "int"
+ }
+ ],
+ "functionName": "setSimDeviceEnabled",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "delta",
+ "type": "int"
+ }
+ ],
+ "functionName": "stepTiming",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "delta",
+ "type": "int"
+ }
+ ],
+ "functionName": "stepTimingAsync",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "waitForProgramStart",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "moduleName": "hal.simulation",
+ "moduleVariables": []
+ },
+ {
+ "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."
+ }
+ ],
+ "functions": [
+ {
+ "args": [],
+ "functionName": "getCurrentThreadPriority",
+ "returnType": "tuple[int, bool]",
+ "tooltip": "Get the thread priority for the current thread.\n\n:param isRealTime: Set to true if thread is real-time, otherwise false.\n\n:returns: The current thread priority. For real-time, this is 1-99\n with 99 being highest. For non-real-time, this is 0. See\n \"man 7 sched\" for details."
+ },
+ {
+ "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"
+ },
+ {
+ "args": [],
+ "functionName": "getErrorMessage",
+ "returnType": "tuple[str, int]",
+ "tooltip": "Gets error message string for an error code."
+ },
+ {
+ "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."
+ },
+ {
+ "args": [],
+ "functionName": "getTime",
+ "returnType": "wpimath.units.seconds",
+ "tooltip": "Gives real-time clock system time with nanosecond resolution\n\n:returns: The time, just in case you want the robot to start autonomous at 8pm\n on Saturday."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "realTime",
+ "type": "bool"
+ },
+ {
+ "defaultValue": null,
+ "name": "priority",
+ "type": "int"
+ }
+ ],
+ "functionName": "setCurrentThreadPriority",
+ "returnType": "bool",
+ "tooltip": "Sets the thread priority for the current thread.\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."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "seconds",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "functionName": "wait",
+ "returnType": "None",
+ "tooltip": "Pause the task for a specified time.\n\nPause the execution of the program for a specified period of time given in\nseconds. Motors will continue to run at their last assigned values, and\nsensors will continue to update. Only the task containing the wait will pause\nuntil the wait time is expired.\n\n:param seconds: Length of time to pause, in seconds."
+ }
+ ],
+ "moduleName": "wpilib",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpilib.cameraserver",
+ "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."
+ }
+ ],
+ "functions": [],
+ "moduleName": "wpilib.counter",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpilib.drive",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpilib.event",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "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| Name | Type | Default Value | Notes |
|---|
\n| Label position | String | \"BOTTOM\" | \nThe position of component labels inside the grid. One of\n``[\"TOP\", \"LEFT\", \"BOTTOM\", \"RIGHT\", \"HIDDEN\"`` |
\n
\n\n kGrid : Groups components in an *n* x *m* grid. Grid layouts default to\n3x3. \nCustom properties: \n| Name | Type | Default Value | Notes |
|---|
\n| Number of columns | Number | 3 | Must be in the\nrange [1,15] | \n
\n| Number of rows | Number | 3 | Must be in the\nrange [1,15] |
| Label position | String | \n\"BOTTOM\" | \nThe position of component labels inside the grid.\nOne of ``[\"TOP\", \"LEFT\", \"BOTTOM\", \"RIGHT\", \"HIDDEN\"`` | \n
\n
"
+ },
+ {
+ "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| Name | Type | Default Value | Notes |
|---|
\n| Min | Number | -1.0 | The minimum value of the\nslider |
| Max | Number | 1.0 | The maximum\nvalue of the slider |
| Block\nincrement | Number | 0.0625 | How much to move the\nslider by with the arrow keys |
\n
\n\n kNumberBar : Displays a number with a view-only bar.\nSupported types:\n\n- Number\n\nCustom properties:\n\n| Name | Type | Default Value | Notes |
|---|
\n| Min | Number | -1.0 | The minimum value of the\nbar |
| Max | Number | 1.0 | The maximum\nvalue of the bar |
\n| Center | Number | 0 | The center (\"zero\") value\nof the bar |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Min | Number | 0 | The minimum value of the\ndial |
| Max | Number | 100 | The maximum\nvalue of the dial |
| Show\nvalue | Boolean | true | Whether or not to show the\nvalue as text |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Visible time | Number | 30 | \nHow long, in seconds, should past data be visible for |
\n
\n\n kBooleanBox : Displays a boolean value as a large colored box.\nSupported types:\n\n- Boolean\n\nCustom properties:\n\n| Name | Type | Default Value | Notes |
|---|
\n| Color when true | Color | \"green\" | \nCan be specified as a string (``\"#00FF00\"``) or a rgba integer\n(``0x00FF0000``)\n |
\n| Color when false | Color | \"red\" | \nCan be specified as a string or a number |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Min | Number | 0 | The minimum value of the\nbar |
| Max | Number | 5 | The maximum\nvalue of the bar |
\n| Center | Number | 0 | The center (\"zero\") value\nof the bar |
\n| Orientation | String | \"HORIZONTAL\" | \nThe orientation of the bar. One of {@code [\"HORIZONTAL\",\n\"VERTICAL\"]} |
| Number of tick\nmarks | Number | 5 | The number of discrete ticks on the\nbar |
\n
\n\n kPowerDistribution : Displays a PowerDistribution. \nSupported types: -\nPowerDistribution\n\nCustom properties:\n\n| Name | Type | Default Value | Notes |
|---|
\n| Show voltage and current values | Boolean | true | \nWhether or not to display the voltage and current draw |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Orientation | String | \"HORIZONTAL\" | \nOne of ``[\"HORIZONTAL\", \"VERTICAL\"]`` |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Min | Number | -1 | \nThe minimum acceleration value to display |
\n| Max | Number | 1 | \nThe maximum acceleration value to display |
\n| Show text | Boolean | true | \nShow or hide the acceleration values |
\n| Precision | Number | 2 | \nHow many numbers to display after the decimal point |
\n| Show tick marks | Boolean | false | \nShow or hide the tick marks on the number bars |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Range | Range | k16G | The accelerometer\nrange |
| Show value | Boolean | true | \nShow or hide the acceleration values |
\n| Precision | Number | 2 | \nHow many numbers to display after the decimal point |
\n| Show tick marks | Boolean | false | \nShow or hide the tick marks on the number bars |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Major tick\nspacing | Number | 45 | Degrees |
\n| Starting angle | Number | 180 | \nHow far to rotate the entire dial, in degrees |
\n| Show tick mark ring | Boolean | true |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Number of wheels | Number | 4 | Must be a\npositive even integer\n |
\n| Wheel diameter | Number | 80 | Pixels |
\n| Show velocity vectors | Boolean | true |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Show velocity vectors | Boolean | true |
\n
\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| Name | Type | Default Value | Notes |
|---|
\n| Show crosshair | Boolean | true | \nShow or hide a crosshair on the image |
\n| Crosshair color | Color | \"white\" | \nCan be a string or a rgba integer |
\n| Show controls | Boolean | true | Show or hide the\nstream controls\n |
\n| Rotation | String | \"NONE\" | \nRotates the displayed image. One of {@code [\"NONE\", \"QUARTER_CW\",\n\"QUARTER_CCW\", \"HALF\"]}\n |
\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": null,
+ "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": [
+ {
+ "args": [],
+ "functionName": "getProgramStarted",
+ "returnType": "bool",
+ "tooltip": ""
+ },
+ {
+ "args": [],
+ "functionName": "isTimingPaused",
+ "returnType": "bool",
+ "tooltip": "Check if the simulator time is paused.\n\n:returns: true if paused"
+ },
+ {
+ "args": [],
+ "functionName": "pauseTiming",
+ "returnType": "None",
+ "tooltip": "Pause the simulator time."
+ },
+ {
+ "args": [],
+ "functionName": "restartTiming",
+ "returnType": "None",
+ "tooltip": "Restart the simulator time."
+ },
+ {
+ "args": [],
+ "functionName": "resumeTiming",
+ "returnType": "None",
+ "tooltip": "Resume the simulator time."
+ },
+ {
+ "args": [],
+ "functionName": "setProgramStarted",
+ "returnType": "None",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "type",
+ "type": "hal.RuntimeType"
+ }
+ ],
+ "functionName": "setRuntimeType",
+ "returnType": "None",
+ "tooltip": "Override the HAL runtime type (simulated/real).\n\n:param type: runtime type"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "delta",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "functionName": "stepTiming",
+ "returnType": "None",
+ "tooltip": "Advance the simulator time and wait for all notifiers to run.\n\n:param delta: the amount to advance (in seconds)"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "delta",
+ "type": "wpimath.units.seconds"
+ }
+ ],
+ "functionName": "stepTimingAsync",
+ "returnType": "None",
+ "tooltip": "Advance the simulator time and return immediately.\n\n:param delta: the amount to advance (in seconds)"
+ },
+ {
+ "args": [],
+ "functionName": "waitForProgramStart",
+ "returnType": "None",
+ "tooltip": ""
+ }
+ ],
+ "moduleName": "wpilib.simulation",
+ "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."
+ }
+ ],
+ "functions": [],
+ "moduleName": "wpilib.sysid",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "angle",
+ "type": "wpimath.units.radians"
+ }
+ ],
+ "functionName": "angleModulus",
+ "returnType": "wpimath.units.radians",
+ "tooltip": ""
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "value",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "deadband",
+ "type": "float"
+ },
+ {
+ "defaultValue": "1.0",
+ "name": "maxMagnitude",
+ "type": "float"
+ }
+ ],
+ "functionName": "applyDeadband",
+ "returnType": "float",
+ "tooltip": "Returns 0.0 if the given value is within the specified range around zero. The\nremaining range between the deadband and the maximum magnitude is scaled from\n0.0 to the maximum magnitude.\n\n:param value: Value to clip.\n:param deadband: Range around zero.\n:param maxMagnitude: The maximum magnitude of the input (defaults to 1). Can\n be infinite.\n\n:returns: The value after the deadband is applied."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "int"
+ }
+ ],
+ "functionName": "floorDiv",
+ "returnType": "int",
+ "tooltip": "Returns the largest (closest to positive infinity)\n``int`` value that is less than or equal to the algebraic quotient.\n\n:param x: the dividend\n:param y: the divisor\n\n:returns: the largest (closest to positive infinity)\n ``int`` value that is less than or equal to the algebraic quotient."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "x",
+ "type": "int"
+ },
+ {
+ "defaultValue": null,
+ "name": "y",
+ "type": "int"
+ }
+ ],
+ "functionName": "floorMod",
+ "returnType": "int",
+ "tooltip": "Returns the floor modulus of the ``int`` arguments.\n\nThe floor modulus is ``r = x - (floorDiv(x, y) * y)``,\nhas the same sign as the divisor ``y`` or is zero, and\nis in the range of ``-std::abs(y) < r < +std::abs(y)``.\n\n:param x: the dividend\n:param y: the divisor\n\n:returns: the floor modulus ``x - (floorDiv(x, y) * y)``"
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "input",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "minimumInput",
+ "type": "float"
+ },
+ {
+ "defaultValue": null,
+ "name": "maximumInput",
+ "type": "float"
+ }
+ ],
+ "functionName": "inputModulus",
+ "returnType": "float",
+ "tooltip": "Returns modulus of input.\n\n:param input: Input value to wrap.\n:param minimumInput: The minimum value expected from the input.\n:param maximumInput: The maximum value expected from the input."
+ },
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "objectInField",
+ "type": "wpimath.geometry.Pose3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "cameraToObject",
+ "type": "wpimath.geometry.Transform3d"
+ },
+ {
+ "defaultValue": null,
+ "name": "robotToCamera",
+ "type": "wpimath.geometry.Transform3d"
+ }
+ ],
+ "functionName": "objectToRobotPose",
+ "returnType": "wpimath.geometry.Pose3d",
+ "tooltip": ""
+ }
+ ],
+ "moduleName": "wpimath",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.controller",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.estimator",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.filter",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [
+ {
+ "args": [
+ {
+ "defaultValue": null,
+ "name": "rotation",
+ "type": "numpy.ndarray[numpy.float64[3, 1]]"
+ }
+ ],
+ "functionName": "rotationVectorToMatrix",
+ "returnType": "numpy.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."
+ }
+ ],
+ "moduleName": "wpimath.geometry",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.interpolation",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.kinematics",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.optimization",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.path",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.spline",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.system",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.system.plant",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.trajectory",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.trajectory.constraint",
+ "moduleVariables": []
+ },
+ {
+ "enums": [],
+ "functions": [],
+ "moduleName": "wpimath.units",
+ "moduleVariables": [
+ {
+ "name": "kInchesPerFoot",
+ "tooltip": "",
+ "type": "float",
+ "writable": false
+ },
+ {
+ "name": "kKilogramsPerLb",
+ "tooltip": "",
+ "type": "float",
+ "writable": false
+ },
+ {
+ "name": "kMetersPerInch",
+ "tooltip": "",
+ "type": "float",
+ "writable": false
+ },
+ {
+ "name": "kMillisecondsPerSecond",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ },
+ {
+ "name": "kSecondsPerMinute",
+ "tooltip": "",
+ "type": "int",
+ "writable": false
+ }
+ ]
+ }
+ ],
+ "subclasses": {
+ "hal.AddressableLEDData": [
+ "hal.AddressableLEDData",
+ "wpilib.AddressableLED.LEDData"
+ ],
+ "hal.SimValue": [
+ "hal.SimValue",
+ "hal.SimBoolean",
+ "hal.SimDouble",
+ "hal.SimEnum",
+ "hal.SimInt",
+ "hal.SimLong"
+ ],
+ "ntcore.BooleanArrayPublisher": [
+ "ntcore.BooleanArrayPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.BooleanArraySubscriber": [
+ "ntcore.BooleanArraySubscriber",
+ "ntcore.BooleanArrayEntry"
+ ],
+ "ntcore.BooleanPublisher": [
+ "ntcore.BooleanPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.BooleanSubscriber": [
+ "ntcore.BooleanSubscriber",
+ "ntcore.BooleanEntry"
+ ],
+ "ntcore.DoubleArrayPublisher": [
+ "ntcore.DoubleArrayPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.DoubleArraySubscriber": [
+ "ntcore.DoubleArraySubscriber",
+ "ntcore.DoubleArrayEntry"
+ ],
+ "ntcore.DoublePublisher": [
+ "ntcore.DoublePublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.DoubleSubscriber": [
+ "ntcore.DoubleSubscriber",
+ "ntcore.DoubleEntry"
+ ],
+ "ntcore.FloatArrayPublisher": [
+ "ntcore.FloatArrayPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.FloatArraySubscriber": [
+ "ntcore.FloatArraySubscriber",
+ "ntcore.FloatArrayEntry"
+ ],
+ "ntcore.FloatPublisher": [
+ "ntcore.FloatPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.FloatSubscriber": [
+ "ntcore.FloatSubscriber",
+ "ntcore.FloatEntry"
+ ],
+ "ntcore.GenericPublisher": [
+ "ntcore.GenericPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.GenericSubscriber": [
+ "ntcore.GenericSubscriber",
+ "ntcore.GenericEntry"
+ ],
+ "ntcore.IntegerArrayPublisher": [
+ "ntcore.IntegerArrayPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.IntegerArraySubscriber": [
+ "ntcore.IntegerArraySubscriber",
+ "ntcore.IntegerArrayEntry"
+ ],
+ "ntcore.IntegerPublisher": [
+ "ntcore.IntegerPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.IntegerSubscriber": [
+ "ntcore.IntegerSubscriber",
+ "ntcore.IntegerEntry"
+ ],
+ "ntcore.NTSendable": [
+ "ntcore.NTSendable",
+ "wpilib.ADXL345_I2C",
+ "wpilib.ADXL345_SPI",
+ "wpilib.ADXL362",
+ "wpilib.Field2d",
+ "wpilib.Mechanism2d"
+ ],
+ "ntcore.NTSendableBuilder": [
+ "ntcore.NTSendableBuilder",
+ "wpilib.SendableBuilderImpl"
+ ],
+ "ntcore.Publisher": [
+ "ntcore.Publisher",
+ "ntcore.BooleanArrayPublisher",
+ "ntcore.BooleanPublisher",
+ "ntcore.DoubleArrayPublisher",
+ "ntcore.DoublePublisher",
+ "ntcore.FloatArrayPublisher",
+ "ntcore.FloatPublisher",
+ "ntcore.GenericPublisher",
+ "ntcore.IntegerArrayPublisher",
+ "ntcore.IntegerPublisher",
+ "ntcore.RawPublisher",
+ "ntcore.StringArrayPublisher",
+ "ntcore.StringPublisher",
+ "ntcore.StructArrayPublisher",
+ "ntcore.StructPublisher"
+ ],
+ "ntcore.RawPublisher": [
+ "ntcore.RawPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.RawSubscriber": [
+ "ntcore.RawSubscriber",
+ "ntcore.RawEntry"
+ ],
+ "ntcore.StringArrayPublisher": [
+ "ntcore.StringArrayPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.StringArraySubscriber": [
+ "ntcore.StringArraySubscriber",
+ "ntcore.StringArrayEntry"
+ ],
+ "ntcore.StringPublisher": [
+ "ntcore.StringPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.StringSubscriber": [
+ "ntcore.StringSubscriber",
+ "ntcore.StringEntry"
+ ],
+ "ntcore.StructArrayPublisher": [
+ "ntcore.StructArrayPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.StructArraySubscriber": [
+ "ntcore.StructArraySubscriber",
+ "ntcore.StructArrayEntry"
+ ],
+ "ntcore.StructPublisher": [
+ "ntcore.StructPublisher",
+ "ntcore.Subscriber"
+ ],
+ "ntcore.StructSubscriber": [
+ "ntcore.StructSubscriber",
+ "ntcore.StructEntry"
+ ],
+ "ntcore.Subscriber": [
+ "ntcore.Subscriber",
+ "ntcore.BooleanArraySubscriber",
+ "ntcore.BooleanSubscriber",
+ "ntcore.DoubleArraySubscriber",
+ "ntcore.DoubleSubscriber",
+ "ntcore.FloatArraySubscriber",
+ "ntcore.FloatSubscriber",
+ "ntcore.GenericSubscriber",
+ "ntcore.IntegerArraySubscriber",
+ "ntcore.IntegerSubscriber",
+ "ntcore.RawSubscriber",
+ "ntcore.StringArraySubscriber",
+ "ntcore.StringSubscriber",
+ "ntcore.StructArraySubscriber",
+ "ntcore.StructSubscriber"
+ ],
+ "ntcore.Topic": [
+ "ntcore.Topic",
+ "ntcore.BooleanArrayTopic",
+ "ntcore.BooleanTopic",
+ "ntcore.DoubleArrayTopic",
+ "ntcore.DoubleTopic",
+ "ntcore.FloatArrayTopic",
+ "ntcore.FloatTopic",
+ "ntcore.IntegerArrayTopic",
+ "ntcore.IntegerTopic",
+ "ntcore.RawTopic",
+ "ntcore.StringArrayTopic",
+ "ntcore.StringTopic",
+ "ntcore.StructArrayTopic",
+ "ntcore.StructTopic"
+ ],
+ "wpilib.DigitalSource": [
+ "wpilib.DigitalSource",
+ "wpilib.AnalogTriggerOutput",
+ "wpilib.DigitalInput",
+ "wpilib.DigitalOutput"
+ ],
+ "wpilib.IterativeRobotBase": [
+ "wpilib.IterativeRobotBase",
+ "wpilib.TimedRobot"
+ ],
+ "wpilib.MechanismObject2d": [
+ "wpilib.MechanismObject2d",
+ "wpilib.MechanismLigament2d"
+ ],
+ "wpilib.MotorSafety": [
+ "wpilib.MotorSafety",
+ "wpilib.interfaces.MotorController",
+ "wpilib.Relay",
+ "wpilib.drive.RobotDriveBase"
+ ],
+ "wpilib.PWM": [
+ "wpilib.PWM",
+ "wpilib.Servo"
+ ],
+ "wpilib.PWMMotorController": [
+ "wpilib.PWMMotorController",
+ "wpilib.DMC60",
+ "wpilib.Jaguar",
+ "wpilib.PWMSparkFlex",
+ "wpilib.PWMSparkMax",
+ "wpilib.PWMTalonFX",
+ "wpilib.PWMTalonSRX",
+ "wpilib.PWMVenom",
+ "wpilib.PWMVictorSPX",
+ "wpilib.SD540",
+ "wpilib.Spark",
+ "wpilib.Talon",
+ "wpilib.Victor",
+ "wpilib.VictorSP"
+ ],
+ "wpilib.PneumaticsBase": [
+ "wpilib.PneumaticsBase",
+ "wpilib.PneumaticHub",
+ "wpilib.PneumaticsControlModule"
+ ],
+ "wpilib.RobotBase": [
+ "wpilib.RobotBase",
+ "wpilib.IterativeRobotBase"
+ ],
+ "wpilib.SendableChooserBase": [
+ "wpilib.SendableChooserBase",
+ "wpilib.SendableChooser"
+ ],
+ "wpilib.TimedRobot": [
+ "wpilib.TimedRobot",
+ "wpilib.TimesliceRobot"
+ ],
+ "wpilib.drive.RobotDriveBase": [
+ "wpilib.drive.RobotDriveBase",
+ "wpilib.drive.DifferentialDrive",
+ "wpilib.drive.MecanumDrive"
+ ],
+ "wpilib.event.BooleanEvent": [
+ "wpilib.event.BooleanEvent",
+ "wpilib.event.NetworkBooleanEvent"
+ ],
+ "wpilib.interfaces.CounterBase": [
+ "wpilib.interfaces.CounterBase",
+ "wpilib.Counter",
+ "wpilib.Encoder"
+ ],
+ "wpilib.interfaces.GenericHID": [
+ "wpilib.interfaces.GenericHID",
+ "wpilib.Joystick",
+ "wpilib.PS4Controller",
+ "wpilib.PS5Controller",
+ "wpilib.StadiaController",
+ "wpilib.XboxController"
+ ],
+ "wpilib.interfaces.MotorController": [
+ "wpilib.interfaces.MotorController",
+ "wpilib.PWMMotorController",
+ "wpiutil.Sendable",
+ "wpilib.NidecBrushless"
+ ],
+ "wpilib.shuffleboard.ShuffleboardComponentBase": [
+ "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "wpilib.shuffleboard._ComplexComponent",
+ "wpilib.shuffleboard._LayoutComponent",
+ "wpilib.shuffleboard._SimpleComponent",
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_bool",
+ "wpilib.shuffleboard._SuppliedValueComponent_bool",
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_double",
+ "wpilib.shuffleboard._SuppliedValueComponent_double",
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_float",
+ "wpilib.shuffleboard._SuppliedValueComponent_float",
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_int",
+ "wpilib.shuffleboard._SuppliedValueComponent_integer",
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_raw",
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_string",
+ "wpilib.shuffleboard._SuppliedValueComponent_string"
+ ],
+ "wpilib.shuffleboard.ShuffleboardContainer": [
+ "wpilib.shuffleboard.ShuffleboardContainer",
+ "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "wpilib.shuffleboard.ShuffleboardTab"
+ ],
+ "wpilib.shuffleboard.ShuffleboardValue": [
+ "wpilib.shuffleboard.ShuffleboardValue",
+ "wpilib.shuffleboard.ShuffleboardComponentBase",
+ "wpilib.shuffleboard.ShuffleboardContainer"
+ ],
+ "wpilib.shuffleboard._ComplexComponent": [
+ "wpilib.shuffleboard._ComplexComponent",
+ "wpilib.shuffleboard._ComplexWidget"
+ ],
+ "wpilib.shuffleboard._ComplexWidget": [
+ "wpilib.shuffleboard._ComplexWidget",
+ "wpilib.shuffleboard.ComplexWidget"
+ ],
+ "wpilib.shuffleboard._LayoutComponent": [
+ "wpilib.shuffleboard._LayoutComponent",
+ "wpilib.shuffleboard.ShuffleboardLayout"
+ ],
+ "wpilib.shuffleboard._SimpleComponent": [
+ "wpilib.shuffleboard._SimpleComponent",
+ "wpilib.shuffleboard._SimpleWidget"
+ ],
+ "wpilib.shuffleboard._SimpleWidget": [
+ "wpilib.shuffleboard._SimpleWidget",
+ "wpilib.shuffleboard.SimpleWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_bool": [
+ "wpilib.shuffleboard._SuppliedValueComponent_bool",
+ "wpilib.shuffleboard._SuppliedValueWidget_bool"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_double": [
+ "wpilib.shuffleboard._SuppliedValueComponent_double",
+ "wpilib.shuffleboard._SuppliedValueWidget_double"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_float": [
+ "wpilib.shuffleboard._SuppliedValueComponent_float",
+ "wpilib.shuffleboard._SuppliedValueWidget_float"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_integer": [
+ "wpilib.shuffleboard._SuppliedValueComponent_integer",
+ "wpilib.shuffleboard._SuppliedValueWidget_integer"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_string": [
+ "wpilib.shuffleboard._SuppliedValueComponent_string",
+ "wpilib.shuffleboard._SuppliedValueWidget_string"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_bool": [
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_bool",
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_bool"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_double": [
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_double",
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_double"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_float": [
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_float",
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_float"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_int": [
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_int",
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_int"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_raw": [
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_raw",
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_raw"
+ ],
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_string": [
+ "wpilib.shuffleboard._SuppliedValueComponent_vector_string",
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_string"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_bool": [
+ "wpilib.shuffleboard._SuppliedValueWidget_bool",
+ "wpilib.shuffleboard.SuppliedBoolValueWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_double": [
+ "wpilib.shuffleboard._SuppliedValueWidget_double",
+ "wpilib.shuffleboard.SuppliedDoubleValueWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_float": [
+ "wpilib.shuffleboard._SuppliedValueWidget_float",
+ "wpilib.shuffleboard.SuppliedFloatValueWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_integer": [
+ "wpilib.shuffleboard._SuppliedValueWidget_integer",
+ "wpilib.shuffleboard.SuppliedIntegerValueWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_string": [
+ "wpilib.shuffleboard._SuppliedValueWidget_string",
+ "wpilib.shuffleboard.SuppliedStringValueWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_bool": [
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_bool",
+ "wpilib.shuffleboard.SuppliedBoolListValueWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_double": [
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_double",
+ "wpilib.shuffleboard.SuppliedDoubleListValueWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_float": [
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_float",
+ "wpilib.shuffleboard.SuppliedFloatListValueWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_int": [
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_int",
+ "wpilib.shuffleboard.SuppliedIntListValueWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_raw": [
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_raw",
+ "wpilib.shuffleboard.SuppliedRawValueWidget"
+ ],
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_string": [
+ "wpilib.shuffleboard._SuppliedValueWidget_vector_string",
+ "wpilib.shuffleboard.SuppliedStringListValueWidget"
+ ],
+ "wpilib.simulation.GenericHIDSim": [
+ "wpilib.simulation.GenericHIDSim",
+ "wpilib.simulation.JoystickSim",
+ "wpilib.simulation.PS4ControllerSim",
+ "wpilib.simulation.PS5ControllerSim",
+ "wpilib.simulation.StadiaControllerSim",
+ "wpilib.simulation.XboxControllerSim"
+ ],
+ "wpilib.simulation.LinearSystemSim_1_1_1": [
+ "wpilib.simulation.LinearSystemSim_1_1_1",
+ "wpilib.simulation.FlywheelSim"
+ ],
+ "wpilib.simulation.LinearSystemSim_2_1_2": [
+ "wpilib.simulation.LinearSystemSim_2_1_2",
+ "wpilib.simulation.DCMotorSim",
+ "wpilib.simulation.ElevatorSim",
+ "wpilib.simulation.SingleJointedArmSim"
+ ],
+ "wpilib.simulation.PneumaticsBaseSim": [
+ "wpilib.simulation.PneumaticsBaseSim",
+ "wpilib.simulation.CTREPCMSim",
+ "wpilib.simulation.REVPHSim"
+ ],
+ "wpimath.estimator.DifferentialDrivePoseEstimator3dBase": [
+ "wpimath.estimator.DifferentialDrivePoseEstimator3dBase",
+ "wpimath.estimator.DifferentialDrivePoseEstimator3d"
+ ],
+ "wpimath.estimator.DifferentialDrivePoseEstimatorBase": [
+ "wpimath.estimator.DifferentialDrivePoseEstimatorBase",
+ "wpimath.estimator.DifferentialDrivePoseEstimator"
+ ],
+ "wpimath.estimator.MecanumDrivePoseEstimator3dBase": [
+ "wpimath.estimator.MecanumDrivePoseEstimator3dBase",
+ "wpimath.estimator.MecanumDrivePoseEstimator3d"
+ ],
+ "wpimath.estimator.MecanumDrivePoseEstimatorBase": [
+ "wpimath.estimator.MecanumDrivePoseEstimatorBase",
+ "wpimath.estimator.MecanumDrivePoseEstimator"
+ ],
+ "wpimath.estimator.SwerveDrive2PoseEstimator3dBase": [
+ "wpimath.estimator.SwerveDrive2PoseEstimator3dBase",
+ "wpimath.estimator.SwerveDrive2PoseEstimator3d"
+ ],
+ "wpimath.estimator.SwerveDrive2PoseEstimatorBase": [
+ "wpimath.estimator.SwerveDrive2PoseEstimatorBase",
+ "wpimath.estimator.SwerveDrive2PoseEstimator"
+ ],
+ "wpimath.estimator.SwerveDrive3PoseEstimator3dBase": [
+ "wpimath.estimator.SwerveDrive3PoseEstimator3dBase",
+ "wpimath.estimator.SwerveDrive3PoseEstimator3d"
+ ],
+ "wpimath.estimator.SwerveDrive3PoseEstimatorBase": [
+ "wpimath.estimator.SwerveDrive3PoseEstimatorBase",
+ "wpimath.estimator.SwerveDrive3PoseEstimator"
+ ],
+ "wpimath.estimator.SwerveDrive4PoseEstimator3dBase": [
+ "wpimath.estimator.SwerveDrive4PoseEstimator3dBase",
+ "wpimath.estimator.SwerveDrive4PoseEstimator3d"
+ ],
+ "wpimath.estimator.SwerveDrive4PoseEstimatorBase": [
+ "wpimath.estimator.SwerveDrive4PoseEstimatorBase",
+ "wpimath.estimator.SwerveDrive4PoseEstimator"
+ ],
+ "wpimath.estimator.SwerveDrive6PoseEstimator3dBase": [
+ "wpimath.estimator.SwerveDrive6PoseEstimator3dBase",
+ "wpimath.estimator.SwerveDrive6PoseEstimator3d"
+ ],
+ "wpimath.estimator.SwerveDrive6PoseEstimatorBase": [
+ "wpimath.estimator.SwerveDrive6PoseEstimatorBase",
+ "wpimath.estimator.SwerveDrive6PoseEstimator"
+ ],
+ "wpimath.kinematics.DifferentialDriveKinematicsBase": [
+ "wpimath.kinematics.DifferentialDriveKinematicsBase",
+ "wpimath.kinematics.DifferentialDriveKinematics"
+ ],
+ "wpimath.kinematics.DifferentialDriveOdometry3dBase": [
+ "wpimath.kinematics.DifferentialDriveOdometry3dBase",
+ "wpimath.kinematics.DifferentialDriveOdometry3d"
+ ],
+ "wpimath.kinematics.DifferentialDriveOdometryBase": [
+ "wpimath.kinematics.DifferentialDriveOdometryBase",
+ "wpimath.kinematics.DifferentialDriveOdometry"
+ ],
+ "wpimath.kinematics.MecanumDriveKinematicsBase": [
+ "wpimath.kinematics.MecanumDriveKinematicsBase",
+ "wpimath.kinematics.MecanumDriveKinematics"
+ ],
+ "wpimath.kinematics.MecanumDriveOdometry3dBase": [
+ "wpimath.kinematics.MecanumDriveOdometry3dBase",
+ "wpimath.kinematics.MecanumDriveOdometry3d"
+ ],
+ "wpimath.kinematics.MecanumDriveOdometryBase": [
+ "wpimath.kinematics.MecanumDriveOdometryBase",
+ "wpimath.kinematics.MecanumDriveOdometry"
+ ],
+ "wpimath.kinematics.SwerveDrive2KinematicsBase": [
+ "wpimath.kinematics.SwerveDrive2KinematicsBase",
+ "wpimath.kinematics.SwerveDrive2Kinematics"
+ ],
+ "wpimath.kinematics.SwerveDrive2Odometry3dBase": [
+ "wpimath.kinematics.SwerveDrive2Odometry3dBase",
+ "wpimath.kinematics.SwerveDrive2Odometry3d"
+ ],
+ "wpimath.kinematics.SwerveDrive2OdometryBase": [
+ "wpimath.kinematics.SwerveDrive2OdometryBase",
+ "wpimath.kinematics.SwerveDrive2Odometry"
+ ],
+ "wpimath.kinematics.SwerveDrive3KinematicsBase": [
+ "wpimath.kinematics.SwerveDrive3KinematicsBase",
+ "wpimath.kinematics.SwerveDrive3Kinematics"
+ ],
+ "wpimath.kinematics.SwerveDrive3Odometry3dBase": [
+ "wpimath.kinematics.SwerveDrive3Odometry3dBase",
+ "wpimath.kinematics.SwerveDrive3Odometry3d"
+ ],
+ "wpimath.kinematics.SwerveDrive3OdometryBase": [
+ "wpimath.kinematics.SwerveDrive3OdometryBase",
+ "wpimath.kinematics.SwerveDrive3Odometry"
+ ],
+ "wpimath.kinematics.SwerveDrive4KinematicsBase": [
+ "wpimath.kinematics.SwerveDrive4KinematicsBase",
+ "wpimath.kinematics.SwerveDrive4Kinematics"
+ ],
+ "wpimath.kinematics.SwerveDrive4Odometry3dBase": [
+ "wpimath.kinematics.SwerveDrive4Odometry3dBase",
+ "wpimath.kinematics.SwerveDrive4Odometry3d"
+ ],
+ "wpimath.kinematics.SwerveDrive4OdometryBase": [
+ "wpimath.kinematics.SwerveDrive4OdometryBase",
+ "wpimath.kinematics.SwerveDrive4Odometry"
+ ],
+ "wpimath.kinematics.SwerveDrive6KinematicsBase": [
+ "wpimath.kinematics.SwerveDrive6KinematicsBase",
+ "wpimath.kinematics.SwerveDrive6Kinematics"
+ ],
+ "wpimath.kinematics.SwerveDrive6Odometry3dBase": [
+ "wpimath.kinematics.SwerveDrive6Odometry3dBase",
+ "wpimath.kinematics.SwerveDrive6Odometry3d"
+ ],
+ "wpimath.kinematics.SwerveDrive6OdometryBase": [
+ "wpimath.kinematics.SwerveDrive6OdometryBase",
+ "wpimath.kinematics.SwerveDrive6Odometry"
+ ],
+ "wpimath.spline.Spline3": [
+ "wpimath.spline.Spline3",
+ "wpimath.spline.CubicHermiteSpline"
+ ],
+ "wpimath.spline.Spline5": [
+ "wpimath.spline.Spline5",
+ "wpimath.spline.QuinticHermiteSpline"
+ ],
+ "wpimath.trajectory.constraint.TrajectoryConstraint": [
+ "wpimath.trajectory.constraint.TrajectoryConstraint",
+ "wpimath.trajectory.constraint.CentripetalAccelerationConstraint",
+ "wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint",
+ "wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint",
+ "wpimath.trajectory.constraint.EllipticalRegionConstraint",
+ "wpimath.trajectory.constraint.MaxVelocityConstraint",
+ "wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint",
+ "wpimath.trajectory.constraint.RectangularRegionConstraint",
+ "wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint",
+ "wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint",
+ "wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint",
+ "wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint"
+ ],
+ "wpiutil.Sendable": [
+ "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.DigitalSource",
+ "wpilib.BuiltInAccelerometer",
+ "wpilib.Compressor",
+ "wpilib.interfaces.CounterBase",
+ "wpilib.MotorSafety",
+ "wpilib.DigitalGlitchFilter",
+ "wpilib.DoubleSolenoid",
+ "wpilib.DutyCycle",
+ "wpilib.DutyCycleEncoder",
+ "wpilib.MotorControllerGroup",
+ "wpilib.interfaces.GenericHID",
+ "wpilib.PWM",
+ "wpilib.PowerDistribution",
+ "wpilib.SendableChooserBase",
+ "wpilib.SharpIR",
+ "wpilib.Solenoid",
+ "wpilib.Ultrasonic",
+ "wpilib.counter.ExternalDirectionCounter",
+ "wpilib.counter.Tachometer",
+ "wpilib.counter.UpDownCounter",
+ "wpimath.controller.BangBangController",
+ "wpimath.controller.PIDController",
+ "wpimath.controller.ProfiledPIDController",
+ "wpimath.controller.ProfiledPIDControllerRadians"
+ ],
+ "wpiutil.SendableBuilder": [
+ "wpiutil.SendableBuilder",
+ "ntcore.NTSendableBuilder"
+ ],
+ "wpiutil.log.DataLog": [
+ "wpiutil.log.DataLog",
+ "wpiutil.DataLogBackgroundWriter",
+ "wpiutil.DataLogWriter"
+ ],
+ "wpiutil.log.DataLogEntry": [
+ "wpiutil.log.DataLogEntry",
+ "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.StructArrayLogEntry",
+ "wpiutil.log.StructLogEntry"
+ ],
+ "wpiutil.log._BooleanArrayLogEntryImpl": [
+ "wpiutil.log._BooleanArrayLogEntryImpl",
+ "wpiutil.log.BooleanArrayLogEntry"
+ ],
+ "wpiutil.log._BooleanLogEntryImpl": [
+ "wpiutil.log._BooleanLogEntryImpl",
+ "wpiutil.log.BooleanLogEntry"
+ ],
+ "wpiutil.log._DoubleArrayLogEntryImpl": [
+ "wpiutil.log._DoubleArrayLogEntryImpl",
+ "wpiutil.log.DoubleArrayLogEntry"
+ ],
+ "wpiutil.log._DoubleLogEntryImpl": [
+ "wpiutil.log._DoubleLogEntryImpl",
+ "wpiutil.log.DoubleLogEntry"
+ ],
+ "wpiutil.log._FloatArrayLogEntryImpl": [
+ "wpiutil.log._FloatArrayLogEntryImpl",
+ "wpiutil.log.FloatArrayLogEntry"
+ ],
+ "wpiutil.log._FloatLogEntryImpl": [
+ "wpiutil.log._FloatLogEntryImpl",
+ "wpiutil.log.FloatLogEntry"
+ ],
+ "wpiutil.log._IntegerArrayLogEntryImpl": [
+ "wpiutil.log._IntegerArrayLogEntryImpl",
+ "wpiutil.log.IntegerArrayLogEntry"
+ ],
+ "wpiutil.log._IntegerLogEntryImpl": [
+ "wpiutil.log._IntegerLogEntryImpl",
+ "wpiutil.log.IntegerLogEntry"
+ ],
+ "wpiutil.log._RawLogEntryImpl": [
+ "wpiutil.log._RawLogEntryImpl",
+ "wpiutil.log.RawLogEntry"
+ ],
+ "wpiutil.log._StringArrayLogEntryImpl": [
+ "wpiutil.log._StringArrayLogEntryImpl",
+ "wpiutil.log.StringArrayLogEntry"
+ ],
+ "wpiutil.log._StringLogEntryImpl": [
+ "wpiutil.log._StringLogEntryImpl",
+ "wpiutil.log.StringLogEntry"
+ ]
+ }
+}
\ No newline at end of file
diff --git a/src/blocks/utils/python.ts b/src/blocks/utils/python.ts
index 283e30de..747f8474 100644
--- a/src/blocks/utils/python.ts
+++ b/src/blocks/utils/python.ts
@@ -19,9 +19,29 @@
* @author lizlooney@google.com (Liz Looney)
*/
-import * as pythonUtils from './generated/python';
+import { robotPyData } from './robotpy_data';
-export const RETURN_TYPE_NONE = 'None';
+// Utilities related to RobotPy modules and classes.
+
+export function getAlias(type: string): string | null {
+ const aliases: {[key: string]: string} = robotPyData.aliases;
+ for (const className in aliases) {
+ if (type === className) {
+ return aliases[className];
+ }
+ }
+ return null;
+}
+
+function getSubclassNames(type: string): string[] | null {
+ const subclasses: {[key: string]: string[]} = robotPyData.subclasses;
+ for (const className in subclasses) {
+ if (type === className) {
+ return subclasses[className];
+ }
+ }
+ return null;
+}
// Functions used in multiple python block definitions.
@@ -29,7 +49,7 @@ export function getAllowedTypesForSetCheck(type: string): string[] {
// For the given python type, returns an array of compatible input types.
// Type Aliases
- const alias = pythonUtils.getAlias(type);
+ const alias = getAlias(type);
if (alias) {
return [type].concat(getAllowedTypesForSetCheck(alias));
}
@@ -40,9 +60,9 @@ export function getAllowedTypesForSetCheck(type: string): string[] {
return [check];
}
- const allowedTypes = pythonUtils.getAllowedTypes(type);
- if (allowedTypes) {
- return allowedTypes;
+ const subclassNames = getSubclassNames(type);
+ if (subclassNames) {
+ return subclassNames;
}
return [type];
@@ -79,7 +99,7 @@ export function getOutputCheck(type: string): string {
}
// Type Aliases
- const alias = pythonUtils.getAlias(type);
+ const alias = getAlias(type);
if (alias) {
return getOutputCheck(alias);
}
diff --git a/src/blocks/utils/robotpy_data.ts b/src/blocks/utils/robotpy_data.ts
new file mode 100644
index 00000000..6556151c
--- /dev/null
+++ b/src/blocks/utils/robotpy_data.ts
@@ -0,0 +1,104 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @author lizlooney@google.com (Liz Looney)
+ */
+
+import generatedRobotPyData from './generated/robotpy_data.json';
+
+export const robotPyData = generatedRobotPyData as RobotPyData;
+
+export class RobotPyData {
+ modules: ModuleData[] = [];
+ classes: ClassData[] = [];
+ aliases: {[key: string]: string} = {};
+ subclasses: {[key: string]: string[]} = {};
+}
+
+export class ModuleData {
+ moduleName: string = '';
+ moduleVariables: VarData[] = [];
+ functions: FunctionData[] = [];
+ enums: EnumData[] = [];
+}
+
+export class ClassData {
+ className: string = '';
+ moduleName: string = '';
+ classVariables: VarData[] = [];
+ instanceVariables: VarData[] = [];
+ constructors: FunctionData[] = [];
+ instanceMethods: FunctionData[] = [];
+ staticMethods: FunctionData[] = [];
+ enums: EnumData[] = [];
+}
+
+export class VarData {
+ name: string = '';
+ type: string = '';
+ writable: boolean = false;
+ tooltip: string = '';
+}
+
+export class FunctionData {
+ functionName: string = '';
+ tooltip: string = '';
+ returnType: string = '';
+ args: ArgData[] = [];
+ declaringClassName?: string = '';
+}
+
+export class ArgData {
+ name: string = '';
+ type: string = '';
+ defaultValue: string = '';
+}
+
+export class EnumData {
+ enumClassName: string = '';
+ moduleName: string = '';
+ enumValues: string[] = [];
+ tooltip: string = '';
+}
+
+export class VariableGettersAndSetters {
+ varNamesForGetter: string[] = [];
+ tooltipsForGetter: string[] = [];
+ varNamesForSetter: string[] = [];
+ tooltipsForSetter: string[] = [];
+}
+
+export function organizeVarDataByType(vars: VarData[]): {[key: string]: VariableGettersAndSetters} {
+ const varsByType: {[key: string]: VariableGettersAndSetters} = {}
+ for (const varData of vars) {
+ let variableGettersAndSetters: VariableGettersAndSetters;
+ if (varData.type in varsByType) {
+ variableGettersAndSetters = varsByType[varData.type];
+ } else {
+ variableGettersAndSetters = new VariableGettersAndSetters();
+ varsByType[varData.type] = variableGettersAndSetters;
+ }
+ variableGettersAndSetters.varNamesForGetter.push(varData.name);
+ variableGettersAndSetters.tooltipsForGetter.push(varData.tooltip);
+ if (varData.writable) {
+ variableGettersAndSetters.varNamesForSetter.push(varData.name);
+ variableGettersAndSetters.tooltipsForSetter.push(varData.tooltip);
+ }
+ }
+ return varsByType;
+}
diff --git a/src/blocks/utils/robotpy_initialize.ts b/src/blocks/utils/robotpy_initialize.ts
new file mode 100644
index 00000000..630b7599
--- /dev/null
+++ b/src/blocks/utils/robotpy_initialize.ts
@@ -0,0 +1,105 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @author lizlooney@google.com (Liz Looney)
+ */
+
+import { robotPyData, organizeVarDataByType, VariableGettersAndSetters } from './robotpy_data';
+
+import * as pythonEnum from "../mrc_get_python_enum_value";
+import * as getPythonVariable from "../mrc_get_python_variable";
+import * as setPythonVariable from "../mrc_set_python_variable";
+
+export function initialize() {
+ // Process RobotPy modules.
+ for (const moduleData of robotPyData.modules) {
+ // Initialize enums.
+ for (const enumData of moduleData.enums) {
+ pythonEnum.initializeEnum(enumData.enumClassName, enumData.enumValues, enumData.tooltip);
+ }
+
+ // Initialize module variables.
+ const varsByType: {[key: string]: VariableGettersAndSetters} =
+ organizeVarDataByType(moduleData.moduleVariables);
+ for (const varType in varsByType) {
+ const variableGettersAndSetters = varsByType[varType];
+ getPythonVariable.initializeModuleVariableGetter(
+ moduleData.moduleName,
+ varType,
+ variableGettersAndSetters.varNamesForGetter,
+ variableGettersAndSetters.tooltipsForGetter);
+ if (variableGettersAndSetters.varNamesForSetter.length) {
+ setPythonVariable.initializeModuleVariableSetter(
+ moduleData.moduleName,
+ varType,
+ variableGettersAndSetters.varNamesForSetter,
+ variableGettersAndSetters.tooltipsForSetter);
+ }
+ }
+ }
+
+ // Process RobotPy classes.
+ for (const classData of robotPyData.classes) {
+ // Initialize enums.
+ for (const enumData of classData.enums) {
+ pythonEnum.initializeEnum(enumData.enumClassName, enumData.enumValues, enumData.tooltip);
+ }
+
+ // Initialize instance variables.
+ if (classData.instanceVariables.length) {
+ const varsByType: {[key: string]: VariableGettersAndSetters} =
+ organizeVarDataByType(classData.instanceVariables);
+ for (const varType in varsByType) {
+ const variableGettersAndSetters = varsByType[varType];
+ getPythonVariable.initializeInstanceVariableGetter(
+ classData.className,
+ varType,
+ variableGettersAndSetters.varNamesForGetter,
+ variableGettersAndSetters.tooltipsForGetter);
+ if (variableGettersAndSetters.varNamesForSetter.length) {
+ setPythonVariable.initializeInstanceVariableSetter(
+ classData.className,
+ varType,
+ variableGettersAndSetters.varNamesForSetter,
+ variableGettersAndSetters.tooltipsForSetter);
+ }
+ }
+ }
+
+ // Initialize class variables.
+ if (classData.classVariables.length) {
+ const varsByType: {[key: string]: VariableGettersAndSetters} =
+ organizeVarDataByType(classData.classVariables);
+ for (const varType in varsByType) {
+ const variableGettersAndSetters = varsByType[varType];
+ getPythonVariable.initializeClassVariableGetter(
+ classData.className,
+ varType,
+ variableGettersAndSetters.varNamesForGetter,
+ variableGettersAndSetters.tooltipsForGetter);
+ if (variableGettersAndSetters.varNamesForSetter.length) {
+ setPythonVariable.initializeClassVariableSetter(
+ classData.className,
+ varType,
+ variableGettersAndSetters.varNamesForSetter,
+ variableGettersAndSetters.tooltipsForSetter);
+ }
+ }
+ }
+ }
+}
diff --git a/src/blocks/utils/value.ts b/src/blocks/utils/value.ts
new file mode 100644
index 00000000..55219ff2
--- /dev/null
+++ b/src/blocks/utils/value.ts
@@ -0,0 +1,106 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @author lizlooney@google.com (Liz Looney)
+ */
+
+import { getAlias } from './python';
+import * as variable from './variable';
+
+
+export function valueForFunctionArgInput(argType: string, argDefaultValue: string): any {
+ const valueVarName = variable.varNameForType(argType);
+ if (valueVarName) {
+ return variable.createVariableGetterBlockValue(valueVarName);
+ }
+ if (!argDefaultValue) {
+ return null;
+ }
+ const alias = getAlias(argType);
+ if (alias) {
+ argType = alias;
+ }
+ switch (argType) {
+ case 'int':
+ const intNum = parseInt(argDefaultValue, 10);
+ if (!isNaN(intNum) && intNum.toString() === argDefaultValue) {
+ return createNumberShadowValue(intNum);
+ }
+ break;
+ case 'float':
+ const floatNum = Number(argDefaultValue);
+ if (!isNaN(floatNum)) {
+ return createNumberShadowValue(floatNum)
+ }
+ break;
+ case 'str':
+ if (argDefaultValue === 'None') {
+ // TODO(lizlooney): Make a block for python None
+ // In RobotPy function hal.report(), the arg named feature has a default value of None.
+ return null;
+ }
+ // If argDefaultValue has single quotes, it's a literal string.
+ if (argDefaultValue.startsWith("'") && argDefaultValue.endsWith("'")) {
+ const textValue = argDefaultValue.substring(1, argDefaultValue.length-1);
+ return createTextShadowValue(textValue);
+ }
+ break;
+ case 'bool':
+ if (argDefaultValue === 'True') {
+ return createBooleanShadowValue(true);
+ }
+ if (argDefaultValue === 'False') {
+ return createBooleanShadowValue(false);
+ }
+ break;
+ }
+ return null;
+}
+
+export function createNumberShadowValue(numValue: number): any {
+ return {
+ 'shadow': {
+ 'type': 'math_number',
+ 'fields': {
+ 'NUM': numValue,
+ },
+ },
+ };
+}
+
+export function createTextShadowValue(textValue: string): any {
+ return {
+ 'shadow': {
+ 'type': 'text',
+ 'fields': {
+ 'TEXT': textValue,
+ },
+ },
+ };
+}
+
+export function createBooleanShadowValue(boolValue: boolean): any {
+ return {
+ 'shadow': {
+ 'type': 'logic_boolean',
+ 'fields': {
+ 'BOOL': (boolValue ? 'TRUE' : 'FALSE'),
+ },
+ },
+ }
+}
diff --git a/src/blocks/utils/variable.ts b/src/blocks/utils/variable.ts
new file mode 100644
index 00000000..0c8ffaea
--- /dev/null
+++ b/src/blocks/utils/variable.ts
@@ -0,0 +1,99 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @author lizlooney@google.com (Liz Looney)
+ */
+
+import { getAlias } from './python';
+import * as toolboxItems from '../../toolbox/items';
+
+
+/** Returns a variable getter block that can be used as an input of another block. */
+export function createVariableGetterBlockValue(varName: string): any {
+ return {
+ 'block': {
+ 'type': 'variables_get',
+ 'fields': {
+ 'VAR': {
+ 'name': varName,
+ },
+ },
+ },
+ };
+}
+
+/** Returns a variable setter block. */
+export function createVariableSetterBlock(varName: string, block: toolboxItems.Block): toolboxItems.Block {
+ return {
+ 'kind': 'block',
+ 'type': 'variables_set',
+ 'fields': {
+ 'VAR': {
+ 'name': varName,
+ },
+ },
+ 'inputs': {
+ 'VALUE': {
+ 'block': block,
+ },
+ },
+ }
+}
+
+/** Returns a reasonable variable name for the given type */
+export function varNameForType(type: string): string {
+ const alias = getAlias(type);
+ if (alias) {
+ type = alias;
+ }
+
+ if (type.startsWith('tuple[') || type.startsWith('Tuple[')) {
+ return 'myTuple';
+ }
+ if (type.startsWith('dict[') || type.startsWith('Dict[')) {
+ return 'myDict';
+ }
+ if (type.startsWith('list[') || type.startsWith('List[')) {
+ return 'myList';
+ }
+ if (type.startsWith('callable[') || type.startsWith('Callable[')) {
+ return 'myCallable';
+ }
+ if (type.includes('[')) {
+ // The type is an array.
+ // TODO(lizlooney): What's a good name for an array variable?
+ return '';
+ }
+ // If the type has a dot, it is an object and we should provide a variable
+ // block for this type.
+ const lastDot = type.lastIndexOf('.')
+ if (lastDot !== -1) {
+ return 'my' + type.substring(lastDot + 1);
+ }
+ // Otherwise, we don't provide a variable block for this type.
+ return ''
+}
+
+/** Returns a reasonable name for a label of a self argument of a block that calls an instance method. */
+export function getSelfArgName(className: string): string {
+ const lastDot = className.lastIndexOf('.')
+ const shortClassName = (lastDot !== -1)
+ ? className.substring(lastDot + 1)
+ : className;
+ return shortClassName.charAt(0).toLowerCase() + shortClassName.substring(1);
+}
diff --git a/src/reactComponents/ToolboxSettings.tsx b/src/reactComponents/ToolboxSettings.tsx
index 1bd87c9a..82f3472d 100644
--- a/src/reactComponents/ToolboxSettings.tsx
+++ b/src/reactComponents/ToolboxSettings.tsx
@@ -24,7 +24,7 @@ import { Button, Flex, Modal, Splitter, Tree, Typography } from 'antd';
import type { TreeDataNode, TreeProps } from 'antd';
import * as toolboxItems from '../toolbox/items';
-import * as generatedToolbox from '../toolbox/generated/toolbox';
+import * as robotPyToolbox from '../toolbox/robotpy_toolbox';
// Throughout this file the term module refers to a python module that appears
@@ -39,7 +39,7 @@ type ToolboxSettingsModalProps = {
}
const ToolboxSettingsModal: React.FC = ({ isOpen, shownCategories, onOk, onCancel }) => {
- const [generatedCategories, setGeneratedCategories] = useState([]);
+ const [robotPyCategories, setRobotPyCategories] = useState([]);
const [shownModuleCategories, setShownModuleCategories] = useState([]);
const [moduleTreeData, setModuleTreeData] = useState([]);
const [moduleTreeKeys, setModuleTreeKeys] = useState([]);
@@ -53,19 +53,19 @@ const ToolboxSettingsModal: React.FC = ({ isOpen, sho
const [classTreeCheckedKeys, setClassTreeCheckedKeys] = useState([]);
const afterOpenChange = (open: boolean) => {
- // When the modal is opened, update the generatedCategories.
+ // When the modal is opened, update the robotPyCategories.
if (open) {
- setGeneratedCategories(generatedToolbox.getToolboxCategories());
+ setRobotPyCategories(robotPyToolbox.getToolboxCategories());
}
};
useEffect(() => {
- // When generatedCategories is set, update the moduleTreeData, moduleTreeKeys,
+ // When robotPyCategories is set, update the moduleTreeData, moduleTreeKeys,
// moduleTreeExpandedKeys, and moduleTreeSelectedKey.
- if (generatedCategories.length) {
+ if (robotPyCategories.length) {
const nodes: TreeDataNode[] = [];
const keys: React.Key[] = [];
- collectTreeData(true, false, generatedCategories, nodes, keys);
+ collectTreeData(true, false, robotPyCategories, nodes, keys);
setModuleTreeData(nodes);
setModuleTreeKeys([...keys]);
setModuleTreeExpandedKeys([...keys]);
@@ -75,7 +75,7 @@ const ToolboxSettingsModal: React.FC = ({ isOpen, sho
setModuleTreeSelectedKey('');
}
}
- }, [generatedCategories]);
+ }, [robotPyCategories]);
useEffect(() => {
// When the moduleTreeKeys is set, figure out which shownCategories are
@@ -114,7 +114,7 @@ const ToolboxSettingsModal: React.FC = ({ isOpen, sho
const keys: React.Key[] = [];
if (moduleTreeSelectedKey) {
const found = getModuleCategory(
- moduleTreeSelectedKey as string, generatedCategories);
+ moduleTreeSelectedKey as string, robotPyCategories);
if (found) {
const category = found as toolboxItems.Category;
if (category.contents) {
diff --git a/src/toolbox/generated/toolbox.ts b/src/toolbox/generated/toolbox.ts
deleted file mode 100644
index 70afda4b..00000000
--- a/src/toolbox/generated/toolbox.ts
+++ /dev/null
@@ -1,1002 +0,0 @@
-// This file was generated. Do not edit!
-
-import * as hal from '../../blocks/generated/module_hal';
-import * as hal_AddressableLEDData from '../../blocks/generated/class_hal.AddressableLEDData';
-import * as hal_CANStreamMessage from '../../blocks/generated/class_hal.CANStreamMessage';
-import * as hal_ControlWord from '../../blocks/generated/class_hal.ControlWord';
-import * as hal_JoystickAxes from '../../blocks/generated/class_hal.JoystickAxes';
-import * as hal_JoystickButtons from '../../blocks/generated/class_hal.JoystickButtons';
-import * as hal_JoystickDescriptor from '../../blocks/generated/class_hal.JoystickDescriptor';
-import * as hal_JoystickPOVs from '../../blocks/generated/class_hal.JoystickPOVs';
-import * as hal_MatchInfo from '../../blocks/generated/class_hal.MatchInfo';
-import * as hal_PowerDistributionFaults from '../../blocks/generated/class_hal.PowerDistributionFaults';
-import * as hal_PowerDistributionStickyFaults from '../../blocks/generated/class_hal.PowerDistributionStickyFaults';
-import * as hal_PowerDistributionVersion from '../../blocks/generated/class_hal.PowerDistributionVersion';
-import * as hal_REVPHCompressorConfig from '../../blocks/generated/class_hal.REVPHCompressorConfig';
-import * as hal_REVPHFaults from '../../blocks/generated/class_hal.REVPHFaults';
-import * as hal_REVPHStickyFaults from '../../blocks/generated/class_hal.REVPHStickyFaults';
-import * as hal_REVPHVersion from '../../blocks/generated/class_hal.REVPHVersion';
-import * as hal_SimBoolean from '../../blocks/generated/class_hal.SimBoolean';
-import * as hal_SimDevice from '../../blocks/generated/class_hal.SimDevice';
-import * as hal_SimDouble from '../../blocks/generated/class_hal.SimDouble';
-import * as hal_SimEnum from '../../blocks/generated/class_hal.SimEnum';
-import * as hal_SimInt from '../../blocks/generated/class_hal.SimInt';
-import * as hal_SimLong from '../../blocks/generated/class_hal.SimLong';
-import * as hal_SimValue from '../../blocks/generated/class_hal.SimValue';
-import * as hal_Value from '../../blocks/generated/class_hal.Value';
-import * as hal_exceptions from '../../blocks/generated/module_hal.exceptions';
-import * as hal_exceptions_HALError from '../../blocks/generated/class_hal.exceptions.HALError';
-import * as hal_simulation from '../../blocks/generated/module_hal.simulation';
-import * as hal_simulation_NotifierInfo from '../../blocks/generated/class_hal.simulation.NotifierInfo';
-import * as hal_simulation_SimCB from '../../blocks/generated/class_hal.simulation.SimCB';
-import * as hal_simulation_SimValueCB from '../../blocks/generated/class_hal.simulation.SimValueCB';
-import * as wpilib from '../../blocks/generated/module_wpilib';
-import * as wpilib_ADIS16448_IMU from '../../blocks/generated/class_wpilib.ADIS16448_IMU';
-import * as wpilib_ADIS16470_IMU from '../../blocks/generated/class_wpilib.ADIS16470_IMU';
-import * as wpilib_ADXL345_I2C from '../../blocks/generated/class_wpilib.ADXL345_I2C';
-import * as wpilib_ADXL345_I2C_AllAxes from '../../blocks/generated/class_wpilib.ADXL345_I2C.AllAxes';
-import * as wpilib_ADXL345_SPI from '../../blocks/generated/class_wpilib.ADXL345_SPI';
-import * as wpilib_ADXL345_SPI_AllAxes from '../../blocks/generated/class_wpilib.ADXL345_SPI.AllAxes';
-import * as wpilib_ADXL362 from '../../blocks/generated/class_wpilib.ADXL362';
-import * as wpilib_ADXL362_AllAxes from '../../blocks/generated/class_wpilib.ADXL362.AllAxes';
-import * as wpilib_ADXRS450_Gyro from '../../blocks/generated/class_wpilib.ADXRS450_Gyro';
-import * as wpilib_AddressableLED from '../../blocks/generated/class_wpilib.AddressableLED';
-import * as wpilib_AddressableLED_LEDData from '../../blocks/generated/class_wpilib.AddressableLED.LEDData';
-import * as wpilib_Alert from '../../blocks/generated/class_wpilib.Alert';
-import * as wpilib_AnalogAccelerometer from '../../blocks/generated/class_wpilib.AnalogAccelerometer';
-import * as wpilib_AnalogEncoder from '../../blocks/generated/class_wpilib.AnalogEncoder';
-import * as wpilib_AnalogGyro from '../../blocks/generated/class_wpilib.AnalogGyro';
-import * as wpilib_AnalogInput from '../../blocks/generated/class_wpilib.AnalogInput';
-import * as wpilib_AnalogOutput from '../../blocks/generated/class_wpilib.AnalogOutput';
-import * as wpilib_AnalogPotentiometer from '../../blocks/generated/class_wpilib.AnalogPotentiometer';
-import * as wpilib_AnalogTrigger from '../../blocks/generated/class_wpilib.AnalogTrigger';
-import * as wpilib_AnalogTriggerOutput from '../../blocks/generated/class_wpilib.AnalogTriggerOutput';
-import * as wpilib_BuiltInAccelerometer from '../../blocks/generated/class_wpilib.BuiltInAccelerometer';
-import * as wpilib_CAN from '../../blocks/generated/class_wpilib.CAN';
-import * as wpilib_CANData from '../../blocks/generated/class_wpilib.CANData';
-import * as wpilib_CANStatus from '../../blocks/generated/class_wpilib.CANStatus';
-import * as wpilib_Color from '../../blocks/generated/class_wpilib.Color';
-import * as wpilib_Color8Bit from '../../blocks/generated/class_wpilib.Color8Bit';
-import * as wpilib_Compressor from '../../blocks/generated/class_wpilib.Compressor';
-import * as wpilib_Counter from '../../blocks/generated/class_wpilib.Counter';
-import * as wpilib_DMC60 from '../../blocks/generated/class_wpilib.DMC60';
-import * as wpilib_DSControlWord from '../../blocks/generated/class_wpilib.DSControlWord';
-import * as wpilib_DataLogManager from '../../blocks/generated/class_wpilib.DataLogManager';
-import * as wpilib_DigitalGlitchFilter from '../../blocks/generated/class_wpilib.DigitalGlitchFilter';
-import * as wpilib_DigitalInput from '../../blocks/generated/class_wpilib.DigitalInput';
-import * as wpilib_DigitalOutput from '../../blocks/generated/class_wpilib.DigitalOutput';
-import * as wpilib_DigitalSource from '../../blocks/generated/class_wpilib.DigitalSource';
-import * as wpilib_DoubleSolenoid from '../../blocks/generated/class_wpilib.DoubleSolenoid';
-import * as wpilib_DriverStation from '../../blocks/generated/class_wpilib.DriverStation';
-import * as wpilib_DutyCycle from '../../blocks/generated/class_wpilib.DutyCycle';
-import * as wpilib_DutyCycleEncoder from '../../blocks/generated/class_wpilib.DutyCycleEncoder';
-import * as wpilib_Encoder from '../../blocks/generated/class_wpilib.Encoder';
-import * as wpilib_Field2d from '../../blocks/generated/class_wpilib.Field2d';
-import * as wpilib_FieldObject2d from '../../blocks/generated/class_wpilib.FieldObject2d';
-import * as wpilib_I2C from '../../blocks/generated/class_wpilib.I2C';
-import * as wpilib_IterativeRobotBase from '../../blocks/generated/class_wpilib.IterativeRobotBase';
-import * as wpilib_Jaguar from '../../blocks/generated/class_wpilib.Jaguar';
-import * as wpilib_Joystick from '../../blocks/generated/class_wpilib.Joystick';
-import * as wpilib_LEDPattern from '../../blocks/generated/class_wpilib.LEDPattern';
-import * as wpilib_LEDPattern_LEDReader from '../../blocks/generated/class_wpilib.LEDPattern.LEDReader';
-import * as wpilib_LiveWindow from '../../blocks/generated/class_wpilib.LiveWindow';
-import * as wpilib_Mechanism2d from '../../blocks/generated/class_wpilib.Mechanism2d';
-import * as wpilib_MechanismLigament2d from '../../blocks/generated/class_wpilib.MechanismLigament2d';
-import * as wpilib_MechanismObject2d from '../../blocks/generated/class_wpilib.MechanismObject2d';
-import * as wpilib_MechanismRoot2d from '../../blocks/generated/class_wpilib.MechanismRoot2d';
-import * as wpilib_MotorControllerGroup from '../../blocks/generated/class_wpilib.MotorControllerGroup';
-import * as wpilib_MotorSafety from '../../blocks/generated/class_wpilib.MotorSafety';
-import * as wpilib_NidecBrushless from '../../blocks/generated/class_wpilib.NidecBrushless';
-import * as wpilib_Notifier from '../../blocks/generated/class_wpilib.Notifier';
-import * as wpilib_PS4Controller from '../../blocks/generated/class_wpilib.PS4Controller';
-import * as wpilib_PS4Controller_Axis from '../../blocks/generated/class_wpilib.PS4Controller.Axis';
-import * as wpilib_PS4Controller_Button from '../../blocks/generated/class_wpilib.PS4Controller.Button';
-import * as wpilib_PS5Controller from '../../blocks/generated/class_wpilib.PS5Controller';
-import * as wpilib_PS5Controller_Axis from '../../blocks/generated/class_wpilib.PS5Controller.Axis';
-import * as wpilib_PS5Controller_Button from '../../blocks/generated/class_wpilib.PS5Controller.Button';
-import * as wpilib_PWM from '../../blocks/generated/class_wpilib.PWM';
-import * as wpilib_PWMMotorController from '../../blocks/generated/class_wpilib.PWMMotorController';
-import * as wpilib_PWMSparkFlex from '../../blocks/generated/class_wpilib.PWMSparkFlex';
-import * as wpilib_PWMSparkMax from '../../blocks/generated/class_wpilib.PWMSparkMax';
-import * as wpilib_PWMTalonFX from '../../blocks/generated/class_wpilib.PWMTalonFX';
-import * as wpilib_PWMTalonSRX from '../../blocks/generated/class_wpilib.PWMTalonSRX';
-import * as wpilib_PWMVenom from '../../blocks/generated/class_wpilib.PWMVenom';
-import * as wpilib_PWMVictorSPX from '../../blocks/generated/class_wpilib.PWMVictorSPX';
-import * as wpilib_PneumaticHub from '../../blocks/generated/class_wpilib.PneumaticHub';
-import * as wpilib_PneumaticHub_Faults from '../../blocks/generated/class_wpilib.PneumaticHub.Faults';
-import * as wpilib_PneumaticHub_StickyFaults from '../../blocks/generated/class_wpilib.PneumaticHub.StickyFaults';
-import * as wpilib_PneumaticHub_Version from '../../blocks/generated/class_wpilib.PneumaticHub.Version';
-import * as wpilib_PneumaticsBase from '../../blocks/generated/class_wpilib.PneumaticsBase';
-import * as wpilib_PneumaticsControlModule from '../../blocks/generated/class_wpilib.PneumaticsControlModule';
-import * as wpilib_PowerDistribution from '../../blocks/generated/class_wpilib.PowerDistribution';
-import * as wpilib_PowerDistribution_Faults from '../../blocks/generated/class_wpilib.PowerDistribution.Faults';
-import * as wpilib_PowerDistribution_StickyFaults from '../../blocks/generated/class_wpilib.PowerDistribution.StickyFaults';
-import * as wpilib_PowerDistribution_Version from '../../blocks/generated/class_wpilib.PowerDistribution.Version';
-import * as wpilib_Preferences from '../../blocks/generated/class_wpilib.Preferences';
-import * as wpilib_Relay from '../../blocks/generated/class_wpilib.Relay';
-import * as wpilib_RobotBase from '../../blocks/generated/class_wpilib.RobotBase';
-import * as wpilib_RobotController from '../../blocks/generated/class_wpilib.RobotController';
-import * as wpilib_RobotState from '../../blocks/generated/class_wpilib.RobotState';
-import * as wpilib_SD540 from '../../blocks/generated/class_wpilib.SD540';
-import * as wpilib_SPI from '../../blocks/generated/class_wpilib.SPI';
-import * as wpilib_SendableBuilderImpl from '../../blocks/generated/class_wpilib.SendableBuilderImpl';
-import * as wpilib_SendableChooser from '../../blocks/generated/class_wpilib.SendableChooser';
-import * as wpilib_SendableChooserBase from '../../blocks/generated/class_wpilib.SendableChooserBase';
-import * as wpilib_SensorUtil from '../../blocks/generated/class_wpilib.SensorUtil';
-import * as wpilib_SerialPort from '../../blocks/generated/class_wpilib.SerialPort';
-import * as wpilib_Servo from '../../blocks/generated/class_wpilib.Servo';
-import * as wpilib_SharpIR from '../../blocks/generated/class_wpilib.SharpIR';
-import * as wpilib_SmartDashboard from '../../blocks/generated/class_wpilib.SmartDashboard';
-import * as wpilib_Solenoid from '../../blocks/generated/class_wpilib.Solenoid';
-import * as wpilib_Spark from '../../blocks/generated/class_wpilib.Spark';
-import * as wpilib_StadiaController from '../../blocks/generated/class_wpilib.StadiaController';
-import * as wpilib_StadiaController_Axis from '../../blocks/generated/class_wpilib.StadiaController.Axis';
-import * as wpilib_StadiaController_Button from '../../blocks/generated/class_wpilib.StadiaController.Button';
-import * as wpilib_SynchronousInterrupt from '../../blocks/generated/class_wpilib.SynchronousInterrupt';
-import * as wpilib_Talon from '../../blocks/generated/class_wpilib.Talon';
-import * as wpilib_TimedRobot from '../../blocks/generated/class_wpilib.TimedRobot';
-import * as wpilib_Timer from '../../blocks/generated/class_wpilib.Timer';
-import * as wpilib_TimesliceRobot from '../../blocks/generated/class_wpilib.TimesliceRobot';
-import * as wpilib_Tracer from '../../blocks/generated/class_wpilib.Tracer';
-import * as wpilib_Ultrasonic from '../../blocks/generated/class_wpilib.Ultrasonic';
-import * as wpilib_Victor from '../../blocks/generated/class_wpilib.Victor';
-import * as wpilib_VictorSP from '../../blocks/generated/class_wpilib.VictorSP';
-import * as wpilib_Watchdog from '../../blocks/generated/class_wpilib.Watchdog';
-import * as wpilib_XboxController from '../../blocks/generated/class_wpilib.XboxController';
-import * as wpilib_XboxController_Axis from '../../blocks/generated/class_wpilib.XboxController.Axis';
-import * as wpilib_XboxController_Button from '../../blocks/generated/class_wpilib.XboxController.Button';
-import * as wpilib_cameraserver from '../../blocks/generated/module_wpilib.cameraserver';
-import * as wpilib_cameraserver_CameraServer from '../../blocks/generated/class_wpilib.cameraserver.CameraServer';
-import * as wpilib_counter from '../../blocks/generated/module_wpilib.counter';
-import * as wpilib_counter_ExternalDirectionCounter from '../../blocks/generated/class_wpilib.counter.ExternalDirectionCounter';
-import * as wpilib_counter_Tachometer from '../../blocks/generated/class_wpilib.counter.Tachometer';
-import * as wpilib_counter_UpDownCounter from '../../blocks/generated/class_wpilib.counter.UpDownCounter';
-import * as wpilib_drive from '../../blocks/generated/module_wpilib.drive';
-import * as wpilib_drive_DifferentialDrive from '../../blocks/generated/class_wpilib.drive.DifferentialDrive';
-import * as wpilib_drive_DifferentialDrive_WheelSpeeds from '../../blocks/generated/class_wpilib.drive.DifferentialDrive.WheelSpeeds';
-import * as wpilib_drive_MecanumDrive from '../../blocks/generated/class_wpilib.drive.MecanumDrive';
-import * as wpilib_drive_MecanumDrive_WheelSpeeds from '../../blocks/generated/class_wpilib.drive.MecanumDrive.WheelSpeeds';
-import * as wpilib_drive_RobotDriveBase from '../../blocks/generated/class_wpilib.drive.RobotDriveBase';
-import * as wpilib_event from '../../blocks/generated/module_wpilib.event';
-import * as wpilib_event_BooleanEvent from '../../blocks/generated/class_wpilib.event.BooleanEvent';
-import * as wpilib_event_EventLoop from '../../blocks/generated/class_wpilib.event.EventLoop';
-import * as wpilib_event_NetworkBooleanEvent from '../../blocks/generated/class_wpilib.event.NetworkBooleanEvent';
-import * as wpilib_interfaces from '../../blocks/generated/module_wpilib.interfaces';
-import * as wpilib_interfaces_CounterBase from '../../blocks/generated/class_wpilib.interfaces.CounterBase';
-import * as wpilib_interfaces_GenericHID from '../../blocks/generated/class_wpilib.interfaces.GenericHID';
-import * as wpilib_interfaces_MotorController from '../../blocks/generated/class_wpilib.interfaces.MotorController';
-import * as wpilib_shuffleboard from '../../blocks/generated/module_wpilib.shuffleboard';
-import * as wpilib_shuffleboard_ComplexWidget from '../../blocks/generated/class_wpilib.shuffleboard.ComplexWidget';
-import * as wpilib_shuffleboard_LayoutType from '../../blocks/generated/class_wpilib.shuffleboard.LayoutType';
-import * as wpilib_shuffleboard_Shuffleboard from '../../blocks/generated/class_wpilib.shuffleboard.Shuffleboard';
-import * as wpilib_shuffleboard_ShuffleboardComponentBase from '../../blocks/generated/class_wpilib.shuffleboard.ShuffleboardComponentBase';
-import * as wpilib_shuffleboard_ShuffleboardContainer from '../../blocks/generated/class_wpilib.shuffleboard.ShuffleboardContainer';
-import * as wpilib_shuffleboard_ShuffleboardLayout from '../../blocks/generated/class_wpilib.shuffleboard.ShuffleboardLayout';
-import * as wpilib_shuffleboard_ShuffleboardTab from '../../blocks/generated/class_wpilib.shuffleboard.ShuffleboardTab';
-import * as wpilib_shuffleboard_ShuffleboardValue from '../../blocks/generated/class_wpilib.shuffleboard.ShuffleboardValue';
-import * as wpilib_shuffleboard_SimpleWidget from '../../blocks/generated/class_wpilib.shuffleboard.SimpleWidget';
-import * as wpilib_shuffleboard_SuppliedBoolListValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedBoolListValueWidget';
-import * as wpilib_shuffleboard_SuppliedBoolValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedBoolValueWidget';
-import * as wpilib_shuffleboard_SuppliedDoubleListValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedDoubleListValueWidget';
-import * as wpilib_shuffleboard_SuppliedDoubleValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedDoubleValueWidget';
-import * as wpilib_shuffleboard_SuppliedFloatListValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedFloatListValueWidget';
-import * as wpilib_shuffleboard_SuppliedFloatValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedFloatValueWidget';
-import * as wpilib_shuffleboard_SuppliedIntListValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedIntListValueWidget';
-import * as wpilib_shuffleboard_SuppliedIntegerValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedIntegerValueWidget';
-import * as wpilib_shuffleboard_SuppliedRawValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedRawValueWidget';
-import * as wpilib_shuffleboard_SuppliedStringListValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedStringListValueWidget';
-import * as wpilib_shuffleboard_SuppliedStringValueWidget from '../../blocks/generated/class_wpilib.shuffleboard.SuppliedStringValueWidget';
-import * as wpilib_shuffleboard_WidgetType from '../../blocks/generated/class_wpilib.shuffleboard.WidgetType';
-import * as wpilib_shuffleboard__ComplexComponent from '../../blocks/generated/class_wpilib.shuffleboard._ComplexComponent';
-import * as wpilib_shuffleboard__ComplexWidget from '../../blocks/generated/class_wpilib.shuffleboard._ComplexWidget';
-import * as wpilib_shuffleboard__LayoutComponent from '../../blocks/generated/class_wpilib.shuffleboard._LayoutComponent';
-import * as wpilib_shuffleboard__SimpleComponent from '../../blocks/generated/class_wpilib.shuffleboard._SimpleComponent';
-import * as wpilib_shuffleboard__SimpleWidget from '../../blocks/generated/class_wpilib.shuffleboard._SimpleWidget';
-import * as wpilib_shuffleboard__SuppliedValueComponent_bool from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_bool';
-import * as wpilib_shuffleboard__SuppliedValueComponent_double from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_double';
-import * as wpilib_shuffleboard__SuppliedValueComponent_float from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_float';
-import * as wpilib_shuffleboard__SuppliedValueComponent_integer from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_integer';
-import * as wpilib_shuffleboard__SuppliedValueComponent_string from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_string';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_bool from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_bool';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_double from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_double';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_float from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_float';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_int from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_int';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_raw from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_raw';
-import * as wpilib_shuffleboard__SuppliedValueComponent_vector_string from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueComponent_vector_string';
-import * as wpilib_shuffleboard__SuppliedValueWidget_bool from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_bool';
-import * as wpilib_shuffleboard__SuppliedValueWidget_double from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_double';
-import * as wpilib_shuffleboard__SuppliedValueWidget_float from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_float';
-import * as wpilib_shuffleboard__SuppliedValueWidget_integer from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_integer';
-import * as wpilib_shuffleboard__SuppliedValueWidget_string from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_string';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_bool from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_bool';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_double from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_double';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_float from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_float';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_int from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_int';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_raw from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_raw';
-import * as wpilib_shuffleboard__SuppliedValueWidget_vector_string from '../../blocks/generated/class_wpilib.shuffleboard._SuppliedValueWidget_vector_string';
-import * as wpilib_simulation from '../../blocks/generated/module_wpilib.simulation';
-import * as wpilib_simulation_ADIS16448_IMUSim from '../../blocks/generated/class_wpilib.simulation.ADIS16448_IMUSim';
-import * as wpilib_simulation_ADIS16470_IMUSim from '../../blocks/generated/class_wpilib.simulation.ADIS16470_IMUSim';
-import * as wpilib_simulation_ADXL345Sim from '../../blocks/generated/class_wpilib.simulation.ADXL345Sim';
-import * as wpilib_simulation_ADXL362Sim from '../../blocks/generated/class_wpilib.simulation.ADXL362Sim';
-import * as wpilib_simulation_ADXRS450_GyroSim from '../../blocks/generated/class_wpilib.simulation.ADXRS450_GyroSim';
-import * as wpilib_simulation_AddressableLEDSim from '../../blocks/generated/class_wpilib.simulation.AddressableLEDSim';
-import * as wpilib_simulation_AnalogEncoderSim from '../../blocks/generated/class_wpilib.simulation.AnalogEncoderSim';
-import * as wpilib_simulation_AnalogGyroSim from '../../blocks/generated/class_wpilib.simulation.AnalogGyroSim';
-import * as wpilib_simulation_AnalogInputSim from '../../blocks/generated/class_wpilib.simulation.AnalogInputSim';
-import * as wpilib_simulation_AnalogOutputSim from '../../blocks/generated/class_wpilib.simulation.AnalogOutputSim';
-import * as wpilib_simulation_AnalogTriggerSim from '../../blocks/generated/class_wpilib.simulation.AnalogTriggerSim';
-import * as wpilib_simulation_BatterySim from '../../blocks/generated/class_wpilib.simulation.BatterySim';
-import * as wpilib_simulation_BuiltInAccelerometerSim from '../../blocks/generated/class_wpilib.simulation.BuiltInAccelerometerSim';
-import * as wpilib_simulation_CTREPCMSim from '../../blocks/generated/class_wpilib.simulation.CTREPCMSim';
-import * as wpilib_simulation_CallbackStore from '../../blocks/generated/class_wpilib.simulation.CallbackStore';
-import * as wpilib_simulation_DCMotorSim from '../../blocks/generated/class_wpilib.simulation.DCMotorSim';
-import * as wpilib_simulation_DIOSim from '../../blocks/generated/class_wpilib.simulation.DIOSim';
-import * as wpilib_simulation_DifferentialDrivetrainSim from '../../blocks/generated/class_wpilib.simulation.DifferentialDrivetrainSim';
-import * as wpilib_simulation_DifferentialDrivetrainSim_KitbotGearing from '../../blocks/generated/class_wpilib.simulation.DifferentialDrivetrainSim.KitbotGearing';
-import * as wpilib_simulation_DifferentialDrivetrainSim_KitbotMotor from '../../blocks/generated/class_wpilib.simulation.DifferentialDrivetrainSim.KitbotMotor';
-import * as wpilib_simulation_DifferentialDrivetrainSim_KitbotWheelSize from '../../blocks/generated/class_wpilib.simulation.DifferentialDrivetrainSim.KitbotWheelSize';
-import * as wpilib_simulation_DifferentialDrivetrainSim_State from '../../blocks/generated/class_wpilib.simulation.DifferentialDrivetrainSim.State';
-import * as wpilib_simulation_DigitalPWMSim from '../../blocks/generated/class_wpilib.simulation.DigitalPWMSim';
-import * as wpilib_simulation_DoubleSolenoidSim from '../../blocks/generated/class_wpilib.simulation.DoubleSolenoidSim';
-import * as wpilib_simulation_DriverStationSim from '../../blocks/generated/class_wpilib.simulation.DriverStationSim';
-import * as wpilib_simulation_DutyCycleEncoderSim from '../../blocks/generated/class_wpilib.simulation.DutyCycleEncoderSim';
-import * as wpilib_simulation_DutyCycleSim from '../../blocks/generated/class_wpilib.simulation.DutyCycleSim';
-import * as wpilib_simulation_ElevatorSim from '../../blocks/generated/class_wpilib.simulation.ElevatorSim';
-import * as wpilib_simulation_EncoderSim from '../../blocks/generated/class_wpilib.simulation.EncoderSim';
-import * as wpilib_simulation_FlywheelSim from '../../blocks/generated/class_wpilib.simulation.FlywheelSim';
-import * as wpilib_simulation_GenericHIDSim from '../../blocks/generated/class_wpilib.simulation.GenericHIDSim';
-import * as wpilib_simulation_JoystickSim from '../../blocks/generated/class_wpilib.simulation.JoystickSim';
-import * as wpilib_simulation_LinearSystemSim_1_1_1 from '../../blocks/generated/class_wpilib.simulation.LinearSystemSim_1_1_1';
-import * as wpilib_simulation_LinearSystemSim_1_1_2 from '../../blocks/generated/class_wpilib.simulation.LinearSystemSim_1_1_2';
-import * as wpilib_simulation_LinearSystemSim_2_1_1 from '../../blocks/generated/class_wpilib.simulation.LinearSystemSim_2_1_1';
-import * as wpilib_simulation_LinearSystemSim_2_1_2 from '../../blocks/generated/class_wpilib.simulation.LinearSystemSim_2_1_2';
-import * as wpilib_simulation_LinearSystemSim_2_2_1 from '../../blocks/generated/class_wpilib.simulation.LinearSystemSim_2_2_1';
-import * as wpilib_simulation_LinearSystemSim_2_2_2 from '../../blocks/generated/class_wpilib.simulation.LinearSystemSim_2_2_2';
-import * as wpilib_simulation_PS4ControllerSim from '../../blocks/generated/class_wpilib.simulation.PS4ControllerSim';
-import * as wpilib_simulation_PS5ControllerSim from '../../blocks/generated/class_wpilib.simulation.PS5ControllerSim';
-import * as wpilib_simulation_PWMSim from '../../blocks/generated/class_wpilib.simulation.PWMSim';
-import * as wpilib_simulation_PneumaticsBaseSim from '../../blocks/generated/class_wpilib.simulation.PneumaticsBaseSim';
-import * as wpilib_simulation_PowerDistributionSim from '../../blocks/generated/class_wpilib.simulation.PowerDistributionSim';
-import * as wpilib_simulation_REVPHSim from '../../blocks/generated/class_wpilib.simulation.REVPHSim';
-import * as wpilib_simulation_RelaySim from '../../blocks/generated/class_wpilib.simulation.RelaySim';
-import * as wpilib_simulation_RoboRioSim from '../../blocks/generated/class_wpilib.simulation.RoboRioSim';
-import * as wpilib_simulation_SPIAccelerometerSim from '../../blocks/generated/class_wpilib.simulation.SPIAccelerometerSim';
-import * as wpilib_simulation_SendableChooserSim from '../../blocks/generated/class_wpilib.simulation.SendableChooserSim';
-import * as wpilib_simulation_SharpIRSim from '../../blocks/generated/class_wpilib.simulation.SharpIRSim';
-import * as wpilib_simulation_SimDeviceSim from '../../blocks/generated/class_wpilib.simulation.SimDeviceSim';
-import * as wpilib_simulation_SingleJointedArmSim from '../../blocks/generated/class_wpilib.simulation.SingleJointedArmSim';
-import * as wpilib_simulation_SolenoidSim from '../../blocks/generated/class_wpilib.simulation.SolenoidSim';
-import * as wpilib_simulation_StadiaControllerSim from '../../blocks/generated/class_wpilib.simulation.StadiaControllerSim';
-import * as wpilib_simulation_UltrasonicSim from '../../blocks/generated/class_wpilib.simulation.UltrasonicSim';
-import * as wpilib_simulation_XboxControllerSim from '../../blocks/generated/class_wpilib.simulation.XboxControllerSim';
-import * as wpilib_sysid_SysIdRoutineLog from '../../blocks/generated/class_wpilib.sysid.SysIdRoutineLog';
-import * as wpilib_sysid_SysIdRoutineLog_MotorLog from '../../blocks/generated/class_wpilib.sysid.SysIdRoutineLog.MotorLog';
-import * as wpimath from '../../blocks/generated/module_wpimath';
-import * as wpimath_controller from '../../blocks/generated/module_wpimath.controller';
-import * as wpimath_controller_ArmFeedforward from '../../blocks/generated/class_wpimath.controller.ArmFeedforward';
-import * as wpimath_controller_BangBangController from '../../blocks/generated/class_wpimath.controller.BangBangController';
-import * as wpimath_controller_ControlAffinePlantInversionFeedforward_1_1 from '../../blocks/generated/class_wpimath.controller.ControlAffinePlantInversionFeedforward_1_1';
-import * as wpimath_controller_ControlAffinePlantInversionFeedforward_2_1 from '../../blocks/generated/class_wpimath.controller.ControlAffinePlantInversionFeedforward_2_1';
-import * as wpimath_controller_ControlAffinePlantInversionFeedforward_2_2 from '../../blocks/generated/class_wpimath.controller.ControlAffinePlantInversionFeedforward_2_2';
-import * as wpimath_controller_DifferentialDriveAccelerationLimiter from '../../blocks/generated/class_wpimath.controller.DifferentialDriveAccelerationLimiter';
-import * as wpimath_controller_DifferentialDriveWheelVoltages from '../../blocks/generated/class_wpimath.controller.DifferentialDriveWheelVoltages';
-import * as wpimath_controller_ElevatorFeedforward from '../../blocks/generated/class_wpimath.controller.ElevatorFeedforward';
-import * as wpimath_controller_HolonomicDriveController from '../../blocks/generated/class_wpimath.controller.HolonomicDriveController';
-import * as wpimath_controller_ImplicitModelFollower_1_1 from '../../blocks/generated/class_wpimath.controller.ImplicitModelFollower_1_1';
-import * as wpimath_controller_ImplicitModelFollower_2_1 from '../../blocks/generated/class_wpimath.controller.ImplicitModelFollower_2_1';
-import * as wpimath_controller_ImplicitModelFollower_2_2 from '../../blocks/generated/class_wpimath.controller.ImplicitModelFollower_2_2';
-import * as wpimath_controller_LTVDifferentialDriveController from '../../blocks/generated/class_wpimath.controller.LTVDifferentialDriveController';
-import * as wpimath_controller_LTVUnicycleController from '../../blocks/generated/class_wpimath.controller.LTVUnicycleController';
-import * as wpimath_controller_LinearPlantInversionFeedforward_1_1 from '../../blocks/generated/class_wpimath.controller.LinearPlantInversionFeedforward_1_1';
-import * as wpimath_controller_LinearPlantInversionFeedforward_2_1 from '../../blocks/generated/class_wpimath.controller.LinearPlantInversionFeedforward_2_1';
-import * as wpimath_controller_LinearPlantInversionFeedforward_2_2 from '../../blocks/generated/class_wpimath.controller.LinearPlantInversionFeedforward_2_2';
-import * as wpimath_controller_LinearPlantInversionFeedforward_3_2 from '../../blocks/generated/class_wpimath.controller.LinearPlantInversionFeedforward_3_2';
-import * as wpimath_controller_LinearQuadraticRegulator_1_1 from '../../blocks/generated/class_wpimath.controller.LinearQuadraticRegulator_1_1';
-import * as wpimath_controller_LinearQuadraticRegulator_2_1 from '../../blocks/generated/class_wpimath.controller.LinearQuadraticRegulator_2_1';
-import * as wpimath_controller_LinearQuadraticRegulator_2_2 from '../../blocks/generated/class_wpimath.controller.LinearQuadraticRegulator_2_2';
-import * as wpimath_controller_LinearQuadraticRegulator_3_2 from '../../blocks/generated/class_wpimath.controller.LinearQuadraticRegulator_3_2';
-import * as wpimath_controller_PIDController from '../../blocks/generated/class_wpimath.controller.PIDController';
-import * as wpimath_controller_ProfiledPIDController from '../../blocks/generated/class_wpimath.controller.ProfiledPIDController';
-import * as wpimath_controller_ProfiledPIDControllerRadians from '../../blocks/generated/class_wpimath.controller.ProfiledPIDControllerRadians';
-import * as wpimath_controller_RamseteController from '../../blocks/generated/class_wpimath.controller.RamseteController';
-import * as wpimath_controller_SimpleMotorFeedforwardMeters from '../../blocks/generated/class_wpimath.controller.SimpleMotorFeedforwardMeters';
-import * as wpimath_controller_SimpleMotorFeedforwardRadians from '../../blocks/generated/class_wpimath.controller.SimpleMotorFeedforwardRadians';
-import * as wpimath_estimator from '../../blocks/generated/module_wpimath.estimator';
-import * as wpimath_estimator_DifferentialDrivePoseEstimator from '../../blocks/generated/class_wpimath.estimator.DifferentialDrivePoseEstimator';
-import * as wpimath_estimator_DifferentialDrivePoseEstimator3d from '../../blocks/generated/class_wpimath.estimator.DifferentialDrivePoseEstimator3d';
-import * as wpimath_estimator_DifferentialDrivePoseEstimator3dBase from '../../blocks/generated/class_wpimath.estimator.DifferentialDrivePoseEstimator3dBase';
-import * as wpimath_estimator_DifferentialDrivePoseEstimatorBase from '../../blocks/generated/class_wpimath.estimator.DifferentialDrivePoseEstimatorBase';
-import * as wpimath_estimator_ExtendedKalmanFilter_1_1_1 from '../../blocks/generated/class_wpimath.estimator.ExtendedKalmanFilter_1_1_1';
-import * as wpimath_estimator_ExtendedKalmanFilter_2_1_1 from '../../blocks/generated/class_wpimath.estimator.ExtendedKalmanFilter_2_1_1';
-import * as wpimath_estimator_ExtendedKalmanFilter_2_2_2 from '../../blocks/generated/class_wpimath.estimator.ExtendedKalmanFilter_2_2_2';
-import * as wpimath_estimator_KalmanFilter_1_1_1 from '../../blocks/generated/class_wpimath.estimator.KalmanFilter_1_1_1';
-import * as wpimath_estimator_KalmanFilter_2_1_1 from '../../blocks/generated/class_wpimath.estimator.KalmanFilter_2_1_1';
-import * as wpimath_estimator_KalmanFilter_2_2_2 from '../../blocks/generated/class_wpimath.estimator.KalmanFilter_2_2_2';
-import * as wpimath_estimator_KalmanFilter_3_2_3 from '../../blocks/generated/class_wpimath.estimator.KalmanFilter_3_2_3';
-import * as wpimath_estimator_MecanumDrivePoseEstimator from '../../blocks/generated/class_wpimath.estimator.MecanumDrivePoseEstimator';
-import * as wpimath_estimator_MecanumDrivePoseEstimator3d from '../../blocks/generated/class_wpimath.estimator.MecanumDrivePoseEstimator3d';
-import * as wpimath_estimator_MecanumDrivePoseEstimator3dBase from '../../blocks/generated/class_wpimath.estimator.MecanumDrivePoseEstimator3dBase';
-import * as wpimath_estimator_MecanumDrivePoseEstimatorBase from '../../blocks/generated/class_wpimath.estimator.MecanumDrivePoseEstimatorBase';
-import * as wpimath_estimator_SwerveDrive2PoseEstimator from '../../blocks/generated/class_wpimath.estimator.SwerveDrive2PoseEstimator';
-import * as wpimath_estimator_SwerveDrive2PoseEstimator3d from '../../blocks/generated/class_wpimath.estimator.SwerveDrive2PoseEstimator3d';
-import * as wpimath_estimator_SwerveDrive2PoseEstimator3dBase from '../../blocks/generated/class_wpimath.estimator.SwerveDrive2PoseEstimator3dBase';
-import * as wpimath_estimator_SwerveDrive2PoseEstimatorBase from '../../blocks/generated/class_wpimath.estimator.SwerveDrive2PoseEstimatorBase';
-import * as wpimath_estimator_SwerveDrive3PoseEstimator from '../../blocks/generated/class_wpimath.estimator.SwerveDrive3PoseEstimator';
-import * as wpimath_estimator_SwerveDrive3PoseEstimator3d from '../../blocks/generated/class_wpimath.estimator.SwerveDrive3PoseEstimator3d';
-import * as wpimath_estimator_SwerveDrive3PoseEstimator3dBase from '../../blocks/generated/class_wpimath.estimator.SwerveDrive3PoseEstimator3dBase';
-import * as wpimath_estimator_SwerveDrive3PoseEstimatorBase from '../../blocks/generated/class_wpimath.estimator.SwerveDrive3PoseEstimatorBase';
-import * as wpimath_estimator_SwerveDrive4PoseEstimator from '../../blocks/generated/class_wpimath.estimator.SwerveDrive4PoseEstimator';
-import * as wpimath_estimator_SwerveDrive4PoseEstimator3d from '../../blocks/generated/class_wpimath.estimator.SwerveDrive4PoseEstimator3d';
-import * as wpimath_estimator_SwerveDrive4PoseEstimator3dBase from '../../blocks/generated/class_wpimath.estimator.SwerveDrive4PoseEstimator3dBase';
-import * as wpimath_estimator_SwerveDrive4PoseEstimatorBase from '../../blocks/generated/class_wpimath.estimator.SwerveDrive4PoseEstimatorBase';
-import * as wpimath_estimator_SwerveDrive6PoseEstimator from '../../blocks/generated/class_wpimath.estimator.SwerveDrive6PoseEstimator';
-import * as wpimath_estimator_SwerveDrive6PoseEstimator3d from '../../blocks/generated/class_wpimath.estimator.SwerveDrive6PoseEstimator3d';
-import * as wpimath_estimator_SwerveDrive6PoseEstimator3dBase from '../../blocks/generated/class_wpimath.estimator.SwerveDrive6PoseEstimator3dBase';
-import * as wpimath_estimator_SwerveDrive6PoseEstimatorBase from '../../blocks/generated/class_wpimath.estimator.SwerveDrive6PoseEstimatorBase';
-import * as wpimath_filter from '../../blocks/generated/module_wpimath.filter';
-import * as wpimath_filter_Debouncer from '../../blocks/generated/class_wpimath.filter.Debouncer';
-import * as wpimath_filter_LinearFilter from '../../blocks/generated/class_wpimath.filter.LinearFilter';
-import * as wpimath_filter_MedianFilter from '../../blocks/generated/class_wpimath.filter.MedianFilter';
-import * as wpimath_filter_SlewRateLimiter from '../../blocks/generated/class_wpimath.filter.SlewRateLimiter';
-import * as wpimath_geometry from '../../blocks/generated/module_wpimath.geometry';
-import * as wpimath_geometry_CoordinateAxis from '../../blocks/generated/class_wpimath.geometry.CoordinateAxis';
-import * as wpimath_geometry_CoordinateSystem from '../../blocks/generated/class_wpimath.geometry.CoordinateSystem';
-import * as wpimath_geometry_Ellipse2d from '../../blocks/generated/class_wpimath.geometry.Ellipse2d';
-import * as wpimath_geometry_Pose2d from '../../blocks/generated/class_wpimath.geometry.Pose2d';
-import * as wpimath_geometry_Pose3d from '../../blocks/generated/class_wpimath.geometry.Pose3d';
-import * as wpimath_geometry_Quaternion from '../../blocks/generated/class_wpimath.geometry.Quaternion';
-import * as wpimath_geometry_Rectangle2d from '../../blocks/generated/class_wpimath.geometry.Rectangle2d';
-import * as wpimath_geometry_Rotation2d from '../../blocks/generated/class_wpimath.geometry.Rotation2d';
-import * as wpimath_geometry_Rotation3d from '../../blocks/generated/class_wpimath.geometry.Rotation3d';
-import * as wpimath_geometry_Transform2d from '../../blocks/generated/class_wpimath.geometry.Transform2d';
-import * as wpimath_geometry_Transform3d from '../../blocks/generated/class_wpimath.geometry.Transform3d';
-import * as wpimath_geometry_Translation2d from '../../blocks/generated/class_wpimath.geometry.Translation2d';
-import * as wpimath_geometry_Translation3d from '../../blocks/generated/class_wpimath.geometry.Translation3d';
-import * as wpimath_geometry_Twist2d from '../../blocks/generated/class_wpimath.geometry.Twist2d';
-import * as wpimath_geometry_Twist3d from '../../blocks/generated/class_wpimath.geometry.Twist3d';
-import * as wpimath_interpolation from '../../blocks/generated/module_wpimath.interpolation';
-import * as wpimath_interpolation_TimeInterpolatableFloatBuffer from '../../blocks/generated/class_wpimath.interpolation.TimeInterpolatableFloatBuffer';
-import * as wpimath_interpolation_TimeInterpolatablePose2dBuffer from '../../blocks/generated/class_wpimath.interpolation.TimeInterpolatablePose2dBuffer';
-import * as wpimath_interpolation_TimeInterpolatablePose3dBuffer from '../../blocks/generated/class_wpimath.interpolation.TimeInterpolatablePose3dBuffer';
-import * as wpimath_interpolation_TimeInterpolatableRotation2dBuffer from '../../blocks/generated/class_wpimath.interpolation.TimeInterpolatableRotation2dBuffer';
-import * as wpimath_interpolation_TimeInterpolatableRotation3dBuffer from '../../blocks/generated/class_wpimath.interpolation.TimeInterpolatableRotation3dBuffer';
-import * as wpimath_interpolation_TimeInterpolatableTranslation2dBuffer from '../../blocks/generated/class_wpimath.interpolation.TimeInterpolatableTranslation2dBuffer';
-import * as wpimath_interpolation_TimeInterpolatableTranslation3dBuffer from '../../blocks/generated/class_wpimath.interpolation.TimeInterpolatableTranslation3dBuffer';
-import * as wpimath_kinematics from '../../blocks/generated/module_wpimath.kinematics';
-import * as wpimath_kinematics_ChassisSpeeds from '../../blocks/generated/class_wpimath.kinematics.ChassisSpeeds';
-import * as wpimath_kinematics_DifferentialDriveKinematics from '../../blocks/generated/class_wpimath.kinematics.DifferentialDriveKinematics';
-import * as wpimath_kinematics_DifferentialDriveKinematicsBase from '../../blocks/generated/class_wpimath.kinematics.DifferentialDriveKinematicsBase';
-import * as wpimath_kinematics_DifferentialDriveOdometry from '../../blocks/generated/class_wpimath.kinematics.DifferentialDriveOdometry';
-import * as wpimath_kinematics_DifferentialDriveOdometry3d from '../../blocks/generated/class_wpimath.kinematics.DifferentialDriveOdometry3d';
-import * as wpimath_kinematics_DifferentialDriveOdometry3dBase from '../../blocks/generated/class_wpimath.kinematics.DifferentialDriveOdometry3dBase';
-import * as wpimath_kinematics_DifferentialDriveOdometryBase from '../../blocks/generated/class_wpimath.kinematics.DifferentialDriveOdometryBase';
-import * as wpimath_kinematics_DifferentialDriveWheelPositions from '../../blocks/generated/class_wpimath.kinematics.DifferentialDriveWheelPositions';
-import * as wpimath_kinematics_DifferentialDriveWheelSpeeds from '../../blocks/generated/class_wpimath.kinematics.DifferentialDriveWheelSpeeds';
-import * as wpimath_kinematics_MecanumDriveKinematics from '../../blocks/generated/class_wpimath.kinematics.MecanumDriveKinematics';
-import * as wpimath_kinematics_MecanumDriveKinematicsBase from '../../blocks/generated/class_wpimath.kinematics.MecanumDriveKinematicsBase';
-import * as wpimath_kinematics_MecanumDriveOdometry from '../../blocks/generated/class_wpimath.kinematics.MecanumDriveOdometry';
-import * as wpimath_kinematics_MecanumDriveOdometry3d from '../../blocks/generated/class_wpimath.kinematics.MecanumDriveOdometry3d';
-import * as wpimath_kinematics_MecanumDriveOdometry3dBase from '../../blocks/generated/class_wpimath.kinematics.MecanumDriveOdometry3dBase';
-import * as wpimath_kinematics_MecanumDriveOdometryBase from '../../blocks/generated/class_wpimath.kinematics.MecanumDriveOdometryBase';
-import * as wpimath_kinematics_MecanumDriveWheelPositions from '../../blocks/generated/class_wpimath.kinematics.MecanumDriveWheelPositions';
-import * as wpimath_kinematics_MecanumDriveWheelSpeeds from '../../blocks/generated/class_wpimath.kinematics.MecanumDriveWheelSpeeds';
-import * as wpimath_kinematics_SwerveDrive2Kinematics from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive2Kinematics';
-import * as wpimath_kinematics_SwerveDrive2KinematicsBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive2KinematicsBase';
-import * as wpimath_kinematics_SwerveDrive2Odometry from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive2Odometry';
-import * as wpimath_kinematics_SwerveDrive2Odometry3d from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive2Odometry3d';
-import * as wpimath_kinematics_SwerveDrive2Odometry3dBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive2Odometry3dBase';
-import * as wpimath_kinematics_SwerveDrive2OdometryBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive2OdometryBase';
-import * as wpimath_kinematics_SwerveDrive3Kinematics from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive3Kinematics';
-import * as wpimath_kinematics_SwerveDrive3KinematicsBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive3KinematicsBase';
-import * as wpimath_kinematics_SwerveDrive3Odometry from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive3Odometry';
-import * as wpimath_kinematics_SwerveDrive3Odometry3d from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive3Odometry3d';
-import * as wpimath_kinematics_SwerveDrive3Odometry3dBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive3Odometry3dBase';
-import * as wpimath_kinematics_SwerveDrive3OdometryBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive3OdometryBase';
-import * as wpimath_kinematics_SwerveDrive4Kinematics from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive4Kinematics';
-import * as wpimath_kinematics_SwerveDrive4KinematicsBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive4KinematicsBase';
-import * as wpimath_kinematics_SwerveDrive4Odometry from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive4Odometry';
-import * as wpimath_kinematics_SwerveDrive4Odometry3d from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive4Odometry3d';
-import * as wpimath_kinematics_SwerveDrive4Odometry3dBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive4Odometry3dBase';
-import * as wpimath_kinematics_SwerveDrive4OdometryBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive4OdometryBase';
-import * as wpimath_kinematics_SwerveDrive6Kinematics from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive6Kinematics';
-import * as wpimath_kinematics_SwerveDrive6KinematicsBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive6KinematicsBase';
-import * as wpimath_kinematics_SwerveDrive6Odometry from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive6Odometry';
-import * as wpimath_kinematics_SwerveDrive6Odometry3d from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive6Odometry3d';
-import * as wpimath_kinematics_SwerveDrive6Odometry3dBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive6Odometry3dBase';
-import * as wpimath_kinematics_SwerveDrive6OdometryBase from '../../blocks/generated/class_wpimath.kinematics.SwerveDrive6OdometryBase';
-import * as wpimath_kinematics_SwerveModulePosition from '../../blocks/generated/class_wpimath.kinematics.SwerveModulePosition';
-import * as wpimath_kinematics_SwerveModuleState from '../../blocks/generated/class_wpimath.kinematics.SwerveModuleState';
-import * as wpimath_optimization from '../../blocks/generated/module_wpimath.optimization';
-import * as wpimath_optimization_SimulatedAnnealing from '../../blocks/generated/class_wpimath.optimization.SimulatedAnnealing';
-import * as wpimath_path from '../../blocks/generated/module_wpimath.path';
-import * as wpimath_path_TravelingSalesman from '../../blocks/generated/class_wpimath.path.TravelingSalesman';
-import * as wpimath_spline from '../../blocks/generated/module_wpimath.spline';
-import * as wpimath_spline_CubicHermiteSpline from '../../blocks/generated/class_wpimath.spline.CubicHermiteSpline';
-import * as wpimath_spline_QuinticHermiteSpline from '../../blocks/generated/class_wpimath.spline.QuinticHermiteSpline';
-import * as wpimath_spline_Spline3 from '../../blocks/generated/class_wpimath.spline.Spline3';
-import * as wpimath_spline_Spline3_ControlVector from '../../blocks/generated/class_wpimath.spline.Spline3.ControlVector';
-import * as wpimath_spline_Spline5 from '../../blocks/generated/class_wpimath.spline.Spline5';
-import * as wpimath_spline_Spline5_ControlVector from '../../blocks/generated/class_wpimath.spline.Spline5.ControlVector';
-import * as wpimath_spline_SplineHelper from '../../blocks/generated/class_wpimath.spline.SplineHelper';
-import * as wpimath_spline_SplineParameterizer from '../../blocks/generated/class_wpimath.spline.SplineParameterizer';
-import * as wpimath_system from '../../blocks/generated/module_wpimath.system';
-import * as wpimath_system_LinearSystemLoop_1_1_1 from '../../blocks/generated/class_wpimath.system.LinearSystemLoop_1_1_1';
-import * as wpimath_system_LinearSystemLoop_2_1_1 from '../../blocks/generated/class_wpimath.system.LinearSystemLoop_2_1_1';
-import * as wpimath_system_LinearSystemLoop_2_2_2 from '../../blocks/generated/class_wpimath.system.LinearSystemLoop_2_2_2';
-import * as wpimath_system_LinearSystemLoop_3_2_3 from '../../blocks/generated/class_wpimath.system.LinearSystemLoop_3_2_3';
-import * as wpimath_system_LinearSystem_1_1_1 from '../../blocks/generated/class_wpimath.system.LinearSystem_1_1_1';
-import * as wpimath_system_LinearSystem_1_1_2 from '../../blocks/generated/class_wpimath.system.LinearSystem_1_1_2';
-import * as wpimath_system_LinearSystem_1_1_3 from '../../blocks/generated/class_wpimath.system.LinearSystem_1_1_3';
-import * as wpimath_system_LinearSystem_2_1_1 from '../../blocks/generated/class_wpimath.system.LinearSystem_2_1_1';
-import * as wpimath_system_LinearSystem_2_1_2 from '../../blocks/generated/class_wpimath.system.LinearSystem_2_1_2';
-import * as wpimath_system_LinearSystem_2_1_3 from '../../blocks/generated/class_wpimath.system.LinearSystem_2_1_3';
-import * as wpimath_system_LinearSystem_2_2_1 from '../../blocks/generated/class_wpimath.system.LinearSystem_2_2_1';
-import * as wpimath_system_LinearSystem_2_2_2 from '../../blocks/generated/class_wpimath.system.LinearSystem_2_2_2';
-import * as wpimath_system_LinearSystem_2_2_3 from '../../blocks/generated/class_wpimath.system.LinearSystem_2_2_3';
-import * as wpimath_system_LinearSystem_3_2_1 from '../../blocks/generated/class_wpimath.system.LinearSystem_3_2_1';
-import * as wpimath_system_LinearSystem_3_2_2 from '../../blocks/generated/class_wpimath.system.LinearSystem_3_2_2';
-import * as wpimath_system_LinearSystem_3_2_3 from '../../blocks/generated/class_wpimath.system.LinearSystem_3_2_3';
-import * as wpimath_system_plant from '../../blocks/generated/module_wpimath.system.plant';
-import * as wpimath_system_plant_DCMotor from '../../blocks/generated/class_wpimath.system.plant.DCMotor';
-import * as wpimath_system_plant_LinearSystemId from '../../blocks/generated/class_wpimath.system.plant.LinearSystemId';
-import * as wpimath_trajectory from '../../blocks/generated/module_wpimath.trajectory';
-import * as wpimath_trajectory_ExponentialProfileMeterVolts from '../../blocks/generated/class_wpimath.trajectory.ExponentialProfileMeterVolts';
-import * as wpimath_trajectory_ExponentialProfileMeterVolts_Constraints from '../../blocks/generated/class_wpimath.trajectory.ExponentialProfileMeterVolts.Constraints';
-import * as wpimath_trajectory_ExponentialProfileMeterVolts_ProfileTiming from '../../blocks/generated/class_wpimath.trajectory.ExponentialProfileMeterVolts.ProfileTiming';
-import * as wpimath_trajectory_ExponentialProfileMeterVolts_State from '../../blocks/generated/class_wpimath.trajectory.ExponentialProfileMeterVolts.State';
-import * as wpimath_trajectory_Trajectory from '../../blocks/generated/class_wpimath.trajectory.Trajectory';
-import * as wpimath_trajectory_Trajectory_State from '../../blocks/generated/class_wpimath.trajectory.Trajectory.State';
-import * as wpimath_trajectory_TrajectoryConfig from '../../blocks/generated/class_wpimath.trajectory.TrajectoryConfig';
-import * as wpimath_trajectory_TrajectoryGenerator from '../../blocks/generated/class_wpimath.trajectory.TrajectoryGenerator';
-import * as wpimath_trajectory_TrajectoryParameterizer from '../../blocks/generated/class_wpimath.trajectory.TrajectoryParameterizer';
-import * as wpimath_trajectory_TrajectoryUtil from '../../blocks/generated/class_wpimath.trajectory.TrajectoryUtil';
-import * as wpimath_trajectory_TrapezoidProfile from '../../blocks/generated/class_wpimath.trajectory.TrapezoidProfile';
-import * as wpimath_trajectory_TrapezoidProfile_Constraints from '../../blocks/generated/class_wpimath.trajectory.TrapezoidProfile.Constraints';
-import * as wpimath_trajectory_TrapezoidProfile_State from '../../blocks/generated/class_wpimath.trajectory.TrapezoidProfile.State';
-import * as wpimath_trajectory_TrapezoidProfileRadians from '../../blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians';
-import * as wpimath_trajectory_TrapezoidProfileRadians_Constraints from '../../blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.Constraints';
-import * as wpimath_trajectory_TrapezoidProfileRadians_State from '../../blocks/generated/class_wpimath.trajectory.TrapezoidProfileRadians.State';
-import * as wpimath_trajectory_constraint from '../../blocks/generated/module_wpimath.trajectory.constraint';
-import * as wpimath_trajectory_constraint_CentripetalAccelerationConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.CentripetalAccelerationConstraint';
-import * as wpimath_trajectory_constraint_DifferentialDriveKinematicsConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.DifferentialDriveKinematicsConstraint';
-import * as wpimath_trajectory_constraint_DifferentialDriveVoltageConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.DifferentialDriveVoltageConstraint';
-import * as wpimath_trajectory_constraint_EllipticalRegionConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.EllipticalRegionConstraint';
-import * as wpimath_trajectory_constraint_MaxVelocityConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.MaxVelocityConstraint';
-import * as wpimath_trajectory_constraint_MecanumDriveKinematicsConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.MecanumDriveKinematicsConstraint';
-import * as wpimath_trajectory_constraint_RectangularRegionConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.RectangularRegionConstraint';
-import * as wpimath_trajectory_constraint_SwerveDrive2KinematicsConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive2KinematicsConstraint';
-import * as wpimath_trajectory_constraint_SwerveDrive3KinematicsConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive3KinematicsConstraint';
-import * as wpimath_trajectory_constraint_SwerveDrive4KinematicsConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive4KinematicsConstraint';
-import * as wpimath_trajectory_constraint_SwerveDrive6KinematicsConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.SwerveDrive6KinematicsConstraint';
-import * as wpimath_trajectory_constraint_TrajectoryConstraint from '../../blocks/generated/class_wpimath.trajectory.constraint.TrajectoryConstraint';
-import * as wpimath_trajectory_constraint_TrajectoryConstraint_MinMax from '../../blocks/generated/class_wpimath.trajectory.constraint.TrajectoryConstraint.MinMax';
-import * as wpimath_units from '../../blocks/generated/module_wpimath.units';
-
-import {Category} from "../../toolbox/items";
-
-export function getToolboxCategories(): Category[] {
- return [
- hal.getToolboxCategory([
- hal_AddressableLEDData.getToolboxCategory(),
- hal_CANStreamMessage.getToolboxCategory(),
- hal_ControlWord.getToolboxCategory(),
- hal_JoystickAxes.getToolboxCategory(),
- hal_JoystickButtons.getToolboxCategory(),
- hal_JoystickDescriptor.getToolboxCategory(),
- hal_JoystickPOVs.getToolboxCategory(),
- hal_MatchInfo.getToolboxCategory(),
- hal_PowerDistributionFaults.getToolboxCategory(),
- hal_PowerDistributionStickyFaults.getToolboxCategory(),
- hal_PowerDistributionVersion.getToolboxCategory(),
- hal_REVPHCompressorConfig.getToolboxCategory(),
- hal_REVPHFaults.getToolboxCategory(),
- hal_REVPHStickyFaults.getToolboxCategory(),
- hal_REVPHVersion.getToolboxCategory(),
- hal_SimBoolean.getToolboxCategory(),
- hal_SimDevice.getToolboxCategory(),
- hal_SimDouble.getToolboxCategory(),
- hal_SimEnum.getToolboxCategory(),
- hal_SimInt.getToolboxCategory(),
- hal_SimLong.getToolboxCategory(),
- hal_SimValue.getToolboxCategory(),
- hal_Value.getToolboxCategory(),
- hal_exceptions.getToolboxCategory([
- hal_exceptions_HALError.getToolboxCategory(),
- ]),
- hal_simulation.getToolboxCategory([
- hal_simulation_NotifierInfo.getToolboxCategory(),
- hal_simulation_SimCB.getToolboxCategory(),
- hal_simulation_SimValueCB.getToolboxCategory(),
- ]),
- ]),
- wpilib.getToolboxCategory([
- wpilib_ADIS16448_IMU.getToolboxCategory(),
- wpilib_ADIS16470_IMU.getToolboxCategory(),
- wpilib_ADXL345_I2C.getToolboxCategory([
- wpilib_ADXL345_I2C_AllAxes.getToolboxCategory(),
- ]),
- wpilib_ADXL345_SPI.getToolboxCategory([
- wpilib_ADXL345_SPI_AllAxes.getToolboxCategory(),
- ]),
- wpilib_ADXL362.getToolboxCategory([
- wpilib_ADXL362_AllAxes.getToolboxCategory(),
- ]),
- wpilib_ADXRS450_Gyro.getToolboxCategory(),
- wpilib_AddressableLED.getToolboxCategory([
- wpilib_AddressableLED_LEDData.getToolboxCategory(),
- ]),
- wpilib_Alert.getToolboxCategory(),
- wpilib_AnalogAccelerometer.getToolboxCategory(),
- wpilib_AnalogEncoder.getToolboxCategory(),
- wpilib_AnalogGyro.getToolboxCategory(),
- wpilib_AnalogInput.getToolboxCategory(),
- wpilib_AnalogOutput.getToolboxCategory(),
- wpilib_AnalogPotentiometer.getToolboxCategory(),
- wpilib_AnalogTrigger.getToolboxCategory(),
- wpilib_AnalogTriggerOutput.getToolboxCategory(),
- wpilib_BuiltInAccelerometer.getToolboxCategory(),
- wpilib_CAN.getToolboxCategory(),
- wpilib_CANData.getToolboxCategory(),
- wpilib_CANStatus.getToolboxCategory(),
- wpilib_Color.getToolboxCategory(),
- wpilib_Color8Bit.getToolboxCategory(),
- wpilib_Compressor.getToolboxCategory(),
- wpilib_Counter.getToolboxCategory(),
- wpilib_DMC60.getToolboxCategory(),
- wpilib_DSControlWord.getToolboxCategory(),
- wpilib_DataLogManager.getToolboxCategory(),
- wpilib_DigitalGlitchFilter.getToolboxCategory(),
- wpilib_DigitalInput.getToolboxCategory(),
- wpilib_DigitalOutput.getToolboxCategory(),
- wpilib_DigitalSource.getToolboxCategory(),
- wpilib_DoubleSolenoid.getToolboxCategory(),
- wpilib_DriverStation.getToolboxCategory(),
- wpilib_DutyCycle.getToolboxCategory(),
- wpilib_DutyCycleEncoder.getToolboxCategory(),
- wpilib_Encoder.getToolboxCategory(),
- wpilib_Field2d.getToolboxCategory(),
- wpilib_FieldObject2d.getToolboxCategory(),
- wpilib_I2C.getToolboxCategory(),
- wpilib_IterativeRobotBase.getToolboxCategory(),
- wpilib_Jaguar.getToolboxCategory(),
- wpilib_Joystick.getToolboxCategory(),
- wpilib_LEDPattern.getToolboxCategory([
- wpilib_LEDPattern_LEDReader.getToolboxCategory(),
- ]),
- wpilib_LiveWindow.getToolboxCategory(),
- wpilib_Mechanism2d.getToolboxCategory(),
- wpilib_MechanismLigament2d.getToolboxCategory(),
- wpilib_MechanismObject2d.getToolboxCategory(),
- wpilib_MechanismRoot2d.getToolboxCategory(),
- wpilib_MotorControllerGroup.getToolboxCategory(),
- wpilib_MotorSafety.getToolboxCategory(),
- wpilib_NidecBrushless.getToolboxCategory(),
- wpilib_Notifier.getToolboxCategory(),
- wpilib_PS4Controller.getToolboxCategory([
- wpilib_PS4Controller_Axis.getToolboxCategory(),
- wpilib_PS4Controller_Button.getToolboxCategory(),
- ]),
- wpilib_PS5Controller.getToolboxCategory([
- wpilib_PS5Controller_Axis.getToolboxCategory(),
- wpilib_PS5Controller_Button.getToolboxCategory(),
- ]),
- wpilib_PWM.getToolboxCategory(),
- wpilib_PWMMotorController.getToolboxCategory(),
- wpilib_PWMSparkFlex.getToolboxCategory(),
- wpilib_PWMSparkMax.getToolboxCategory(),
- wpilib_PWMTalonFX.getToolboxCategory(),
- wpilib_PWMTalonSRX.getToolboxCategory(),
- wpilib_PWMVenom.getToolboxCategory(),
- wpilib_PWMVictorSPX.getToolboxCategory(),
- wpilib_PneumaticHub.getToolboxCategory([
- wpilib_PneumaticHub_Faults.getToolboxCategory(),
- wpilib_PneumaticHub_StickyFaults.getToolboxCategory(),
- wpilib_PneumaticHub_Version.getToolboxCategory(),
- ]),
- wpilib_PneumaticsBase.getToolboxCategory(),
- wpilib_PneumaticsControlModule.getToolboxCategory(),
- wpilib_PowerDistribution.getToolboxCategory([
- wpilib_PowerDistribution_Faults.getToolboxCategory(),
- wpilib_PowerDistribution_StickyFaults.getToolboxCategory(),
- wpilib_PowerDistribution_Version.getToolboxCategory(),
- ]),
- wpilib_Preferences.getToolboxCategory(),
- wpilib_Relay.getToolboxCategory(),
- wpilib_RobotBase.getToolboxCategory(),
- wpilib_RobotController.getToolboxCategory(),
- wpilib_RobotState.getToolboxCategory(),
- wpilib_SD540.getToolboxCategory(),
- wpilib_SPI.getToolboxCategory(),
- wpilib_SendableBuilderImpl.getToolboxCategory(),
- wpilib_SendableChooser.getToolboxCategory(),
- wpilib_SendableChooserBase.getToolboxCategory(),
- wpilib_SensorUtil.getToolboxCategory(),
- wpilib_SerialPort.getToolboxCategory(),
- wpilib_Servo.getToolboxCategory(),
- wpilib_SharpIR.getToolboxCategory(),
- wpilib_SmartDashboard.getToolboxCategory(),
- wpilib_Solenoid.getToolboxCategory(),
- wpilib_Spark.getToolboxCategory(),
- wpilib_StadiaController.getToolboxCategory([
- wpilib_StadiaController_Axis.getToolboxCategory(),
- wpilib_StadiaController_Button.getToolboxCategory(),
- ]),
- wpilib_SynchronousInterrupt.getToolboxCategory(),
- wpilib_Talon.getToolboxCategory(),
- wpilib_TimedRobot.getToolboxCategory(),
- wpilib_Timer.getToolboxCategory(),
- wpilib_TimesliceRobot.getToolboxCategory(),
- wpilib_Tracer.getToolboxCategory(),
- wpilib_Ultrasonic.getToolboxCategory(),
- wpilib_Victor.getToolboxCategory(),
- wpilib_VictorSP.getToolboxCategory(),
- wpilib_Watchdog.getToolboxCategory(),
- wpilib_XboxController.getToolboxCategory([
- wpilib_XboxController_Axis.getToolboxCategory(),
- wpilib_XboxController_Button.getToolboxCategory(),
- ]),
- wpilib_cameraserver.getToolboxCategory([
- wpilib_cameraserver_CameraServer.getToolboxCategory(),
- ]),
- wpilib_counter.getToolboxCategory([
- wpilib_counter_ExternalDirectionCounter.getToolboxCategory(),
- wpilib_counter_Tachometer.getToolboxCategory(),
- wpilib_counter_UpDownCounter.getToolboxCategory(),
- ]),
- wpilib_drive.getToolboxCategory([
- wpilib_drive_DifferentialDrive.getToolboxCategory([
- wpilib_drive_DifferentialDrive_WheelSpeeds.getToolboxCategory(),
- ]),
- wpilib_drive_MecanumDrive.getToolboxCategory([
- wpilib_drive_MecanumDrive_WheelSpeeds.getToolboxCategory(),
- ]),
- wpilib_drive_RobotDriveBase.getToolboxCategory(),
- ]),
- wpilib_event.getToolboxCategory([
- wpilib_event_BooleanEvent.getToolboxCategory(),
- wpilib_event_EventLoop.getToolboxCategory(),
- wpilib_event_NetworkBooleanEvent.getToolboxCategory(),
- ]),
- wpilib_interfaces.getToolboxCategory([
- wpilib_interfaces_CounterBase.getToolboxCategory(),
- wpilib_interfaces_GenericHID.getToolboxCategory(),
- wpilib_interfaces_MotorController.getToolboxCategory(),
- ]),
- wpilib_shuffleboard.getToolboxCategory([
- wpilib_shuffleboard_ComplexWidget.getToolboxCategory(),
- wpilib_shuffleboard_LayoutType.getToolboxCategory(),
- wpilib_shuffleboard_Shuffleboard.getToolboxCategory(),
- wpilib_shuffleboard_ShuffleboardComponentBase.getToolboxCategory(),
- wpilib_shuffleboard_ShuffleboardContainer.getToolboxCategory(),
- wpilib_shuffleboard_ShuffleboardLayout.getToolboxCategory(),
- wpilib_shuffleboard_ShuffleboardTab.getToolboxCategory(),
- wpilib_shuffleboard_ShuffleboardValue.getToolboxCategory(),
- wpilib_shuffleboard_SimpleWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedBoolListValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedBoolValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedDoubleListValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedDoubleValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedFloatListValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedFloatValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedIntListValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedIntegerValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedRawValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedStringListValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_SuppliedStringValueWidget.getToolboxCategory(),
- wpilib_shuffleboard_WidgetType.getToolboxCategory(),
- wpilib_shuffleboard__ComplexComponent.getToolboxCategory(),
- wpilib_shuffleboard__ComplexWidget.getToolboxCategory(),
- wpilib_shuffleboard__LayoutComponent.getToolboxCategory(),
- wpilib_shuffleboard__SimpleComponent.getToolboxCategory(),
- wpilib_shuffleboard__SimpleWidget.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_bool.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_double.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_float.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_integer.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_string.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_vector_bool.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_vector_double.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_vector_float.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_vector_int.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_vector_raw.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueComponent_vector_string.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_bool.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_double.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_float.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_integer.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_string.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_vector_bool.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_vector_double.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_vector_float.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_vector_int.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_vector_raw.getToolboxCategory(),
- wpilib_shuffleboard__SuppliedValueWidget_vector_string.getToolboxCategory(),
- ]),
- wpilib_simulation.getToolboxCategory([
- wpilib_simulation_ADIS16448_IMUSim.getToolboxCategory(),
- wpilib_simulation_ADIS16470_IMUSim.getToolboxCategory(),
- wpilib_simulation_ADXL345Sim.getToolboxCategory(),
- wpilib_simulation_ADXL362Sim.getToolboxCategory(),
- wpilib_simulation_ADXRS450_GyroSim.getToolboxCategory(),
- wpilib_simulation_AddressableLEDSim.getToolboxCategory(),
- wpilib_simulation_AnalogEncoderSim.getToolboxCategory(),
- wpilib_simulation_AnalogGyroSim.getToolboxCategory(),
- wpilib_simulation_AnalogInputSim.getToolboxCategory(),
- wpilib_simulation_AnalogOutputSim.getToolboxCategory(),
- wpilib_simulation_AnalogTriggerSim.getToolboxCategory(),
- wpilib_simulation_BatterySim.getToolboxCategory(),
- wpilib_simulation_BuiltInAccelerometerSim.getToolboxCategory(),
- wpilib_simulation_CTREPCMSim.getToolboxCategory(),
- wpilib_simulation_CallbackStore.getToolboxCategory(),
- wpilib_simulation_DCMotorSim.getToolboxCategory(),
- wpilib_simulation_DIOSim.getToolboxCategory(),
- wpilib_simulation_DifferentialDrivetrainSim.getToolboxCategory([
- wpilib_simulation_DifferentialDrivetrainSim_KitbotGearing.getToolboxCategory(),
- wpilib_simulation_DifferentialDrivetrainSim_KitbotMotor.getToolboxCategory(),
- wpilib_simulation_DifferentialDrivetrainSim_KitbotWheelSize.getToolboxCategory(),
- wpilib_simulation_DifferentialDrivetrainSim_State.getToolboxCategory(),
- ]),
- wpilib_simulation_DigitalPWMSim.getToolboxCategory(),
- wpilib_simulation_DoubleSolenoidSim.getToolboxCategory(),
- wpilib_simulation_DriverStationSim.getToolboxCategory(),
- wpilib_simulation_DutyCycleEncoderSim.getToolboxCategory(),
- wpilib_simulation_DutyCycleSim.getToolboxCategory(),
- wpilib_simulation_ElevatorSim.getToolboxCategory(),
- wpilib_simulation_EncoderSim.getToolboxCategory(),
- wpilib_simulation_FlywheelSim.getToolboxCategory(),
- wpilib_simulation_GenericHIDSim.getToolboxCategory(),
- wpilib_simulation_JoystickSim.getToolboxCategory(),
- wpilib_simulation_LinearSystemSim_1_1_1.getToolboxCategory(),
- wpilib_simulation_LinearSystemSim_1_1_2.getToolboxCategory(),
- wpilib_simulation_LinearSystemSim_2_1_1.getToolboxCategory(),
- wpilib_simulation_LinearSystemSim_2_1_2.getToolboxCategory(),
- wpilib_simulation_LinearSystemSim_2_2_1.getToolboxCategory(),
- wpilib_simulation_LinearSystemSim_2_2_2.getToolboxCategory(),
- wpilib_simulation_PS4ControllerSim.getToolboxCategory(),
- wpilib_simulation_PS5ControllerSim.getToolboxCategory(),
- wpilib_simulation_PWMSim.getToolboxCategory(),
- wpilib_simulation_PneumaticsBaseSim.getToolboxCategory(),
- wpilib_simulation_PowerDistributionSim.getToolboxCategory(),
- wpilib_simulation_REVPHSim.getToolboxCategory(),
- wpilib_simulation_RelaySim.getToolboxCategory(),
- wpilib_simulation_RoboRioSim.getToolboxCategory(),
- wpilib_simulation_SPIAccelerometerSim.getToolboxCategory(),
- wpilib_simulation_SendableChooserSim.getToolboxCategory(),
- wpilib_simulation_SharpIRSim.getToolboxCategory(),
- wpilib_simulation_SimDeviceSim.getToolboxCategory(),
- wpilib_simulation_SingleJointedArmSim.getToolboxCategory(),
- wpilib_simulation_SolenoidSim.getToolboxCategory(),
- wpilib_simulation_StadiaControllerSim.getToolboxCategory(),
- wpilib_simulation_UltrasonicSim.getToolboxCategory(),
- wpilib_simulation_XboxControllerSim.getToolboxCategory(),
- ]),
- { kind: "category", name: "sysid", contents: [
- wpilib_sysid_SysIdRoutineLog.getToolboxCategory([
- wpilib_sysid_SysIdRoutineLog_MotorLog.getToolboxCategory(),
- ]),
- ]},
- ]),
- wpimath.getToolboxCategory([
- wpimath_controller.getToolboxCategory([
- wpimath_controller_ArmFeedforward.getToolboxCategory(),
- wpimath_controller_BangBangController.getToolboxCategory(),
- wpimath_controller_ControlAffinePlantInversionFeedforward_1_1.getToolboxCategory(),
- wpimath_controller_ControlAffinePlantInversionFeedforward_2_1.getToolboxCategory(),
- wpimath_controller_ControlAffinePlantInversionFeedforward_2_2.getToolboxCategory(),
- wpimath_controller_DifferentialDriveAccelerationLimiter.getToolboxCategory(),
- wpimath_controller_DifferentialDriveWheelVoltages.getToolboxCategory(),
- wpimath_controller_ElevatorFeedforward.getToolboxCategory(),
- wpimath_controller_HolonomicDriveController.getToolboxCategory(),
- wpimath_controller_ImplicitModelFollower_1_1.getToolboxCategory(),
- wpimath_controller_ImplicitModelFollower_2_1.getToolboxCategory(),
- wpimath_controller_ImplicitModelFollower_2_2.getToolboxCategory(),
- wpimath_controller_LTVDifferentialDriveController.getToolboxCategory(),
- wpimath_controller_LTVUnicycleController.getToolboxCategory(),
- wpimath_controller_LinearPlantInversionFeedforward_1_1.getToolboxCategory(),
- wpimath_controller_LinearPlantInversionFeedforward_2_1.getToolboxCategory(),
- wpimath_controller_LinearPlantInversionFeedforward_2_2.getToolboxCategory(),
- wpimath_controller_LinearPlantInversionFeedforward_3_2.getToolboxCategory(),
- wpimath_controller_LinearQuadraticRegulator_1_1.getToolboxCategory(),
- wpimath_controller_LinearQuadraticRegulator_2_1.getToolboxCategory(),
- wpimath_controller_LinearQuadraticRegulator_2_2.getToolboxCategory(),
- wpimath_controller_LinearQuadraticRegulator_3_2.getToolboxCategory(),
- wpimath_controller_PIDController.getToolboxCategory(),
- wpimath_controller_ProfiledPIDController.getToolboxCategory(),
- wpimath_controller_ProfiledPIDControllerRadians.getToolboxCategory(),
- wpimath_controller_RamseteController.getToolboxCategory(),
- wpimath_controller_SimpleMotorFeedforwardMeters.getToolboxCategory(),
- wpimath_controller_SimpleMotorFeedforwardRadians.getToolboxCategory(),
- ]),
- wpimath_estimator.getToolboxCategory([
- wpimath_estimator_DifferentialDrivePoseEstimator.getToolboxCategory(),
- wpimath_estimator_DifferentialDrivePoseEstimator3d.getToolboxCategory(),
- wpimath_estimator_DifferentialDrivePoseEstimator3dBase.getToolboxCategory(),
- wpimath_estimator_DifferentialDrivePoseEstimatorBase.getToolboxCategory(),
- wpimath_estimator_ExtendedKalmanFilter_1_1_1.getToolboxCategory(),
- wpimath_estimator_ExtendedKalmanFilter_2_1_1.getToolboxCategory(),
- wpimath_estimator_ExtendedKalmanFilter_2_2_2.getToolboxCategory(),
- wpimath_estimator_KalmanFilter_1_1_1.getToolboxCategory(),
- wpimath_estimator_KalmanFilter_2_1_1.getToolboxCategory(),
- wpimath_estimator_KalmanFilter_2_2_2.getToolboxCategory(),
- wpimath_estimator_KalmanFilter_3_2_3.getToolboxCategory(),
- wpimath_estimator_MecanumDrivePoseEstimator.getToolboxCategory(),
- wpimath_estimator_MecanumDrivePoseEstimator3d.getToolboxCategory(),
- wpimath_estimator_MecanumDrivePoseEstimator3dBase.getToolboxCategory(),
- wpimath_estimator_MecanumDrivePoseEstimatorBase.getToolboxCategory(),
- wpimath_estimator_SwerveDrive2PoseEstimator.getToolboxCategory(),
- wpimath_estimator_SwerveDrive2PoseEstimator3d.getToolboxCategory(),
- wpimath_estimator_SwerveDrive2PoseEstimator3dBase.getToolboxCategory(),
- wpimath_estimator_SwerveDrive2PoseEstimatorBase.getToolboxCategory(),
- wpimath_estimator_SwerveDrive3PoseEstimator.getToolboxCategory(),
- wpimath_estimator_SwerveDrive3PoseEstimator3d.getToolboxCategory(),
- wpimath_estimator_SwerveDrive3PoseEstimator3dBase.getToolboxCategory(),
- wpimath_estimator_SwerveDrive3PoseEstimatorBase.getToolboxCategory(),
- wpimath_estimator_SwerveDrive4PoseEstimator.getToolboxCategory(),
- wpimath_estimator_SwerveDrive4PoseEstimator3d.getToolboxCategory(),
- wpimath_estimator_SwerveDrive4PoseEstimator3dBase.getToolboxCategory(),
- wpimath_estimator_SwerveDrive4PoseEstimatorBase.getToolboxCategory(),
- wpimath_estimator_SwerveDrive6PoseEstimator.getToolboxCategory(),
- wpimath_estimator_SwerveDrive6PoseEstimator3d.getToolboxCategory(),
- wpimath_estimator_SwerveDrive6PoseEstimator3dBase.getToolboxCategory(),
- wpimath_estimator_SwerveDrive6PoseEstimatorBase.getToolboxCategory(),
- ]),
- wpimath_filter.getToolboxCategory([
- wpimath_filter_Debouncer.getToolboxCategory(),
- wpimath_filter_LinearFilter.getToolboxCategory(),
- wpimath_filter_MedianFilter.getToolboxCategory(),
- wpimath_filter_SlewRateLimiter.getToolboxCategory(),
- ]),
- wpimath_geometry.getToolboxCategory([
- wpimath_geometry_CoordinateAxis.getToolboxCategory(),
- wpimath_geometry_CoordinateSystem.getToolboxCategory(),
- wpimath_geometry_Ellipse2d.getToolboxCategory(),
- wpimath_geometry_Pose2d.getToolboxCategory(),
- wpimath_geometry_Pose3d.getToolboxCategory(),
- wpimath_geometry_Quaternion.getToolboxCategory(),
- wpimath_geometry_Rectangle2d.getToolboxCategory(),
- wpimath_geometry_Rotation2d.getToolboxCategory(),
- wpimath_geometry_Rotation3d.getToolboxCategory(),
- wpimath_geometry_Transform2d.getToolboxCategory(),
- wpimath_geometry_Transform3d.getToolboxCategory(),
- wpimath_geometry_Translation2d.getToolboxCategory(),
- wpimath_geometry_Translation3d.getToolboxCategory(),
- wpimath_geometry_Twist2d.getToolboxCategory(),
- wpimath_geometry_Twist3d.getToolboxCategory(),
- ]),
- wpimath_interpolation.getToolboxCategory([
- wpimath_interpolation_TimeInterpolatableFloatBuffer.getToolboxCategory(),
- wpimath_interpolation_TimeInterpolatablePose2dBuffer.getToolboxCategory(),
- wpimath_interpolation_TimeInterpolatablePose3dBuffer.getToolboxCategory(),
- wpimath_interpolation_TimeInterpolatableRotation2dBuffer.getToolboxCategory(),
- wpimath_interpolation_TimeInterpolatableRotation3dBuffer.getToolboxCategory(),
- wpimath_interpolation_TimeInterpolatableTranslation2dBuffer.getToolboxCategory(),
- wpimath_interpolation_TimeInterpolatableTranslation3dBuffer.getToolboxCategory(),
- ]),
- wpimath_kinematics.getToolboxCategory([
- wpimath_kinematics_ChassisSpeeds.getToolboxCategory(),
- wpimath_kinematics_DifferentialDriveKinematics.getToolboxCategory(),
- wpimath_kinematics_DifferentialDriveKinematicsBase.getToolboxCategory(),
- wpimath_kinematics_DifferentialDriveOdometry.getToolboxCategory(),
- wpimath_kinematics_DifferentialDriveOdometry3d.getToolboxCategory(),
- wpimath_kinematics_DifferentialDriveOdometry3dBase.getToolboxCategory(),
- wpimath_kinematics_DifferentialDriveOdometryBase.getToolboxCategory(),
- wpimath_kinematics_DifferentialDriveWheelPositions.getToolboxCategory(),
- wpimath_kinematics_DifferentialDriveWheelSpeeds.getToolboxCategory(),
- wpimath_kinematics_MecanumDriveKinematics.getToolboxCategory(),
- wpimath_kinematics_MecanumDriveKinematicsBase.getToolboxCategory(),
- wpimath_kinematics_MecanumDriveOdometry.getToolboxCategory(),
- wpimath_kinematics_MecanumDriveOdometry3d.getToolboxCategory(),
- wpimath_kinematics_MecanumDriveOdometry3dBase.getToolboxCategory(),
- wpimath_kinematics_MecanumDriveOdometryBase.getToolboxCategory(),
- wpimath_kinematics_MecanumDriveWheelPositions.getToolboxCategory(),
- wpimath_kinematics_MecanumDriveWheelSpeeds.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive2Kinematics.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive2KinematicsBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive2Odometry.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive2Odometry3d.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive2Odometry3dBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive2OdometryBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive3Kinematics.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive3KinematicsBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive3Odometry.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive3Odometry3d.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive3Odometry3dBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive3OdometryBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive4Kinematics.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive4KinematicsBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive4Odometry.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive4Odometry3d.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive4Odometry3dBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive4OdometryBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive6Kinematics.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive6KinematicsBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive6Odometry.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive6Odometry3d.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive6Odometry3dBase.getToolboxCategory(),
- wpimath_kinematics_SwerveDrive6OdometryBase.getToolboxCategory(),
- wpimath_kinematics_SwerveModulePosition.getToolboxCategory(),
- wpimath_kinematics_SwerveModuleState.getToolboxCategory(),
- ]),
- wpimath_optimization.getToolboxCategory([
- wpimath_optimization_SimulatedAnnealing.getToolboxCategory(),
- ]),
- wpimath_path.getToolboxCategory([
- wpimath_path_TravelingSalesman.getToolboxCategory(),
- ]),
- wpimath_spline.getToolboxCategory([
- wpimath_spline_CubicHermiteSpline.getToolboxCategory(),
- wpimath_spline_QuinticHermiteSpline.getToolboxCategory(),
- wpimath_spline_Spline3.getToolboxCategory([
- wpimath_spline_Spline3_ControlVector.getToolboxCategory(),
- ]),
- wpimath_spline_Spline5.getToolboxCategory([
- wpimath_spline_Spline5_ControlVector.getToolboxCategory(),
- ]),
- wpimath_spline_SplineHelper.getToolboxCategory(),
- wpimath_spline_SplineParameterizer.getToolboxCategory(),
- ]),
- wpimath_system.getToolboxCategory([
- wpimath_system_LinearSystemLoop_1_1_1.getToolboxCategory(),
- wpimath_system_LinearSystemLoop_2_1_1.getToolboxCategory(),
- wpimath_system_LinearSystemLoop_2_2_2.getToolboxCategory(),
- wpimath_system_LinearSystemLoop_3_2_3.getToolboxCategory(),
- wpimath_system_LinearSystem_1_1_1.getToolboxCategory(),
- wpimath_system_LinearSystem_1_1_2.getToolboxCategory(),
- wpimath_system_LinearSystem_1_1_3.getToolboxCategory(),
- wpimath_system_LinearSystem_2_1_1.getToolboxCategory(),
- wpimath_system_LinearSystem_2_1_2.getToolboxCategory(),
- wpimath_system_LinearSystem_2_1_3.getToolboxCategory(),
- wpimath_system_LinearSystem_2_2_1.getToolboxCategory(),
- wpimath_system_LinearSystem_2_2_2.getToolboxCategory(),
- wpimath_system_LinearSystem_2_2_3.getToolboxCategory(),
- wpimath_system_LinearSystem_3_2_1.getToolboxCategory(),
- wpimath_system_LinearSystem_3_2_2.getToolboxCategory(),
- wpimath_system_LinearSystem_3_2_3.getToolboxCategory(),
- wpimath_system_plant.getToolboxCategory([
- wpimath_system_plant_DCMotor.getToolboxCategory(),
- wpimath_system_plant_LinearSystemId.getToolboxCategory(),
- ]),
- ]),
- wpimath_trajectory.getToolboxCategory([
- wpimath_trajectory_ExponentialProfileMeterVolts.getToolboxCategory([
- wpimath_trajectory_ExponentialProfileMeterVolts_Constraints.getToolboxCategory(),
- wpimath_trajectory_ExponentialProfileMeterVolts_ProfileTiming.getToolboxCategory(),
- wpimath_trajectory_ExponentialProfileMeterVolts_State.getToolboxCategory(),
- ]),
- wpimath_trajectory_Trajectory.getToolboxCategory([
- wpimath_trajectory_Trajectory_State.getToolboxCategory(),
- ]),
- wpimath_trajectory_TrajectoryConfig.getToolboxCategory(),
- wpimath_trajectory_TrajectoryGenerator.getToolboxCategory(),
- wpimath_trajectory_TrajectoryParameterizer.getToolboxCategory(),
- wpimath_trajectory_TrajectoryUtil.getToolboxCategory(),
- wpimath_trajectory_TrapezoidProfile.getToolboxCategory([
- wpimath_trajectory_TrapezoidProfile_Constraints.getToolboxCategory(),
- wpimath_trajectory_TrapezoidProfile_State.getToolboxCategory(),
- ]),
- wpimath_trajectory_TrapezoidProfileRadians.getToolboxCategory([
- wpimath_trajectory_TrapezoidProfileRadians_Constraints.getToolboxCategory(),
- wpimath_trajectory_TrapezoidProfileRadians_State.getToolboxCategory(),
- ]),
- wpimath_trajectory_constraint.getToolboxCategory([
- wpimath_trajectory_constraint_CentripetalAccelerationConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_DifferentialDriveKinematicsConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_DifferentialDriveVoltageConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_EllipticalRegionConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_MaxVelocityConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_MecanumDriveKinematicsConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_RectangularRegionConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_SwerveDrive2KinematicsConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_SwerveDrive3KinematicsConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_SwerveDrive4KinematicsConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_SwerveDrive6KinematicsConstraint.getToolboxCategory(),
- wpimath_trajectory_constraint_TrajectoryConstraint.getToolboxCategory([
- wpimath_trajectory_constraint_TrajectoryConstraint_MinMax.getToolboxCategory(),
- ]),
- ]),
- ]),
- wpimath_units.getToolboxCategory(),
- ]),
- ];
-}
diff --git a/src/toolbox/items.ts b/src/toolbox/items.ts
index 47c3a4d8..4a83c714 100644
--- a/src/toolbox/items.ts
+++ b/src/toolbox/items.ts
@@ -51,14 +51,20 @@ export class Block extends Item {
constructor(
type: string,
- extraState: {[key: string]: any},
- fields: {[key: string]: any},
- inputs: {[key: string]: any}) {
+ extraState: {[key: string]: any} | null,
+ fields: {[key: string]: any} | null,
+ inputs: {[key: string]: any} | null) {
super('block');
this.type = type;
- this.extraState = extraState;
- this.fields = fields;
- this.inputs = inputs;
+ if (extraState) {
+ this.extraState = extraState;
+ }
+ if (fields) {
+ this.fields = fields;
+ }
+ if (inputs) {
+ this.inputs = inputs;
+ }
}
}
@@ -73,11 +79,12 @@ export class Category extends Item {
/** The blocks for this category. */
contents?: ContentsType[];
- constructor(name: string, contents: ContentsType[]);
constructor(name: string, contents: ContentsType[], categorystyle?: string, custom?: string) {
super('category');
this.name = name;
- this.contents = contents;
+ if (contents) {
+ this.contents = contents;
+ }
if (categorystyle) {
this.categorystyle = categorystyle;
}
@@ -87,13 +94,9 @@ export class Category extends Item {
}
}
-// TODO(lizlooney): Figure out if PythonModuleCategory should actually be called PythonPackageCategory.
-
export class PythonModuleCategory extends Category {
moduleName: string;
- packageName?: string
- constructor(moduleName: string, name: string, contents: ContentsType[]);
constructor(moduleName: string, name: string, contents: ContentsType[], categorystyle?: string, custom?: string) {
super(name, contents);
if (categorystyle) {
diff --git a/src/toolbox/robotpy_toolbox.ts b/src/toolbox/robotpy_toolbox.ts
new file mode 100644
index 00000000..8f75f09a
--- /dev/null
+++ b/src/toolbox/robotpy_toolbox.ts
@@ -0,0 +1,156 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @author lizlooney@google.com (Liz Looney)
+ */
+
+import { addEnumBlocks } from '../blocks/mrc_get_python_enum_value';
+import {
+ addClassVariableBlocks,
+ addInstanceVariableBlocks,
+ addModuleVariableBlocks } from '../blocks/mrc_get_python_variable';
+import {
+ addConstructorBlocks,
+ addInstanceMethodBlocks,
+ addModuleFunctionBlocks,
+ addStaticMethodBlocks } from '../blocks/mrc_call_python_function';
+import {
+ robotPyData,
+ ClassData,
+ ModuleData,
+ organizeVarDataByType,
+ VariableGettersAndSetters } from '../blocks/utils/robotpy_data';
+import * as toolboxItems from './items';
+
+
+export function getToolboxCategories(): toolboxItems.Category[] {
+ const contents: toolboxItems.Category[] = [];
+
+ const mapPathToCategory: {[key: string]: toolboxItems.Category} = {};
+
+ // Process RobotPy modules.
+ for (const moduleData of robotPyData.modules) {
+ const path = moduleData.moduleName;
+ const lastDot = path.lastIndexOf('.');
+ const name = (lastDot != -1) ? path.substring(lastDot + 1) : path;
+
+ const moduleCategory: toolboxItems.PythonModuleCategory = {
+ kind: 'category',
+ name: name,
+ moduleName: moduleData.moduleName,
+ };
+ moduleCategory.contents = [];
+ addModuleBlocks(moduleData, moduleCategory.contents);
+ mapPathToCategory[path] = moduleCategory;
+ }
+
+ // Process RobotPy classes.
+ for (const classData of robotPyData.classes) {
+ const path = classData.className;
+ const lastDot = path.lastIndexOf('.');
+ const parentPath = (lastDot != -1) ? path.substring(0, lastDot) : '';
+ const name = (lastDot != -1) ? path.substring(lastDot + 1) : path;
+
+ const classCategory: toolboxItems.PythonClassCategory = {
+ kind: 'category',
+ name: name,
+ className: classData.className,
+ };
+ classCategory.contents = [];
+ addClassBlocks(classData, classCategory.contents);
+ mapPathToCategory[path] = classCategory;
+ if (parentPath) {
+ const parentCategory = mapPathToCategory[parentPath];
+ if (parentCategory.contents) {
+ parentCategory.contents.push(classCategory);
+ }
+ } else {
+ contents.push(classCategory);
+ }
+ }
+
+ for (const path in mapPathToCategory) {
+ const category = mapPathToCategory[path];
+ if ('className' in category) {
+ continue;
+ }
+ const lastDot = path.lastIndexOf('.');
+ const parentPath = (lastDot != -1) ? path.substring(0, lastDot) : '';
+ if (parentPath) {
+ const parentCategory = mapPathToCategory[parentPath];
+ if (parentCategory.contents) {
+ parentCategory.contents.push(category);
+ }
+ } else {
+ contents.push(category);
+ }
+ }
+
+ return contents;
+}
+
+function addModuleBlocks(moduleData: ModuleData, contents: toolboxItems.ContentsType[]) {
+ // Module variable blocks.
+ if (moduleData.moduleVariables.length) {
+ const varsByType: {[key: string]: VariableGettersAndSetters} =
+ organizeVarDataByType(moduleData.moduleVariables);
+ addModuleVariableBlocks(moduleData.moduleName, varsByType, contents);
+ }
+
+ // Module function blocks
+ if (moduleData.functions.length) {
+ addModuleFunctionBlocks(moduleData.moduleName, moduleData.functions, contents);
+ }
+
+ // Enum blocks
+ if (moduleData.enums.length) {
+ addEnumBlocks(moduleData.enums, contents);
+ }
+}
+
+function addClassBlocks(classData: ClassData, contents: toolboxItems.ContentsType[]) {
+ // Function blocks (constructors, instance methods, static methods)
+ if (classData.constructors.length) {
+ addConstructorBlocks(classData.moduleName, classData.constructors, contents);
+ }
+ if (classData.instanceMethods.length) {
+ addInstanceMethodBlocks(classData.instanceMethods, contents);
+ }
+ if (classData.staticMethods.length) {
+ addStaticMethodBlocks(classData.moduleName, classData.staticMethods, contents);
+ }
+
+ // Instance variable blocks
+ if (classData.instanceVariables.length) {
+ const varsByType: {[key: string]: VariableGettersAndSetters} =
+ organizeVarDataByType(classData.instanceVariables);
+ addInstanceVariableBlocks(classData.className, varsByType, contents);
+ }
+
+ // Class variable blocks.
+ if (classData.classVariables.length) {
+ const varsByType: {[key: string]: VariableGettersAndSetters} =
+ organizeVarDataByType(classData.classVariables);
+ addClassVariableBlocks(classData.moduleName, classData.className, varsByType, contents);
+ }
+
+ // Enum blocks
+ if (classData.enums.length) {
+ addEnumBlocks(classData.enums, contents);
+ }
+}
diff --git a/src/toolbox/toolbox.ts b/src/toolbox/toolbox.ts
index ed17a591..a456ed45 100644
--- a/src/toolbox/toolbox.ts
+++ b/src/toolbox/toolbox.ts
@@ -19,7 +19,7 @@
* @author lizlooney@google.com (Liz Looney)
*/
-import * as generatedToolbox from './generated/toolbox';
+import * as robotPyToolbox from './robotpy_toolbox';
import * as toolboxItems from './items';
import {category as logicCategory} from './logic_category';
import {category as loopCategory} from './loop_category';
@@ -33,8 +33,11 @@ import {category as componentSampleCategory} from './component_samples_category'
export function getToolboxJSON(
opt_includeExportedBlocksFromProject: toolboxItems.ContentsType[],
shownPythonToolboxCategories: Set | null) {
- const contents: toolboxItems.ContentsType[] = generatedToolbox.getToolboxCategories();
- filterGeneratedCategories(contents, shownPythonToolboxCategories);
+ const contents: toolboxItems.ContentsType[] = [];
+
+ const robotPyCategories: toolboxItems.ContentsType[] = robotPyToolbox.getToolboxCategories();
+ filterGeneratedCategories(robotPyCategories, shownPythonToolboxCategories);
+ contents.push.apply(contents, robotPyCategories);
if (opt_includeExportedBlocksFromProject.length) {
contents.push.apply(