hal.simulation functions

hal.simulation.cancelAllSimPeriodicCallbacks() → None

hal.simulation.cancelDriverStationAllianceStationIdCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelDriverStationDsAttachedCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelDriverStationEStopCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelDriverStationEnabledCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelDriverStationFmsAttachedCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelDriverStationMatchTimeCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelDriverStationNewDataCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelDriverStationOpModeCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelDriverStationRobotModeCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelGameDataCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelJoystickAxesCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelJoystickButtonsCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelJoystickDescriptorCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelJoystickLedsCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelJoystickPOVsCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelJoystickRumblesCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelJoystickTouchpadsCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelMatchInfoCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.cancelOpModeOptionsCallback(uid: SupportsInt | SupportsIndex) → None

hal.simulation.freeOpModeOptionsArray(arr: hal._wpiHal.OpModeOption, length: SupportsInt | SupportsIndex) → None

hal.simulation.getDriverStationAllianceStationId() → hal._wpiHal.AllianceStationID

hal.simulation.getDriverStationDsAttached() → int

hal.simulation.getDriverStationEStop() → int

hal.simulation.getDriverStationEnabled() → int

hal.simulation.getDriverStationFmsAttached() → int

hal.simulation.getDriverStationMatchTime() → float

hal.simulation.getDriverStationOpMode() → int

hal.simulation.getDriverStationRobotMode() → hal._wpiHal._RobotMode

hal.simulation.getGameData(gameData: hal._wpiHal.GameData) → None

hal.simulation.getJoystickAvailables(stick: SupportsInt | SupportsIndex) → tuple[int, int, int]

hal.simulation.getJoystickAxes(joystickNum: SupportsInt | SupportsIndex, axes: hal._wpiHal.JoystickAxes) → None

hal.simulation.getJoystickButtons(joystickNum: SupportsInt | SupportsIndex, buttons: hal._wpiHal.JoystickButtons) → None

hal.simulation.getJoystickDescriptor(joystickNum: SupportsInt | SupportsIndex, descriptor: hal._wpiHal.JoystickDescriptor) → None

hal.simulation.getJoystickLeds(joystickNum: SupportsInt | SupportsIndex) → int

hal.simulation.getJoystickPOVs(joystickNum: SupportsInt | SupportsIndex, povs: hal._wpiHal.JoystickPOVs) → None

hal.simulation.getJoystickRumbles(joystickNum: SupportsInt | SupportsIndex) → tuple[int, int, int, int]

hal.simulation.getJoystickTouchpads(joystickNum: SupportsInt | SupportsIndex, touchpads: hal._wpiHal.JoystickTouchpads) → None

hal.simulation.getMatchInfo(info: hal._wpiHal.MatchInfo) → None

hal.simulation.getNextNotifierTimeout() → int

hal.simulation.getNotifierInfo(arr: hal.simulation._simulation.NotifierInfo, size: SupportsInt | SupportsIndex) → int

Gets detailed information about each notifier.

Parameters:

arr – array of information to be filled
size – size of arr

Returns:

Number of notifiers; note: may be larger than passed-in size

hal.simulation.getNumNotifiers() → int

hal.simulation.getOpModeOptions() → tuple[hal._wpiHal.OpModeOption, int]

hal.simulation.getProgramStarted() → int

hal.simulation.getProgramState(*args, **kwargs)

Overloaded function.

getProgramState(controlWord: hal._wpiHal._ControlWord) -> None
getProgramState() -> hal._wpiHal.ControlWord

hal.simulation.getSimDeviceHandle(name: str) → int

hal.simulation.getSimDeviceName(handle: SupportsInt | SupportsIndex) → str

hal.simulation.getSimValueDeviceHandle(handle: SupportsInt | SupportsIndex) → int

hal.simulation.getSimValueHandle(device: SupportsInt | SupportsIndex, name: str) → int

hal.simulation.isSimDeviceEnabled(name: str) → int

hal.simulation.isTimingPaused() → int

hal.simulation.notifyDriverStationNewData() → None

hal.simulation.pauseTiming() → None

hal.simulation.registerSimPeriodicAfterCallback(callback: collections.abc.Callable[[], None]) → hal.simulation._simulation.SimCB

hal.simulation.registerSimPeriodicBeforeCallback(callback: collections.abc.Callable[[], None]) → hal.simulation._simulation.SimCB

hal.simulation.registerSimValueChangedCallback(value: hal._wpiHal.SimValue, callback: collections.abc.Callable[[str, SupportsInt | SupportsIndex, hal._wpiHal.SimValueDirection, hal._wpiHal.Value], None], initialNotify: bool) → hal.simulation._simulation.SimValueCB

hal.simulation.registerSimValueCreatedCallback(device: hal._wpiHal.SimDevice, callback: collections.abc.Callable[[str, SupportsInt | SupportsIndex, hal._wpiHal.SimValueDirection, hal._wpiHal.Value], None], initialNotify: bool) → hal.simulation._simulation.SimValueCB

hal.simulation.registerSimValueResetCallback(value: hal._wpiHal.SimValue, callback: collections.abc.Callable[[str, SupportsInt | SupportsIndex, hal._wpiHal.SimValueDirection, hal._wpiHal.Value], None], initialNotify: bool) → hal.simulation._simulation.SimValueCB

Register a callback for HAL_SimValueReset(). The callback is called with the old value.

Parameters:

value – simulated value handle
param – parameter for callback
callback – callback
initialNotify – ignored (present for consistency)

hal.simulation.resetAllSimData() → None

hal.simulation.resetDriverStationData() → None

hal.simulation.resetGlobalHandles() → None

hal.simulation.resetSimDeviceData() → None

hal.simulation.restartTiming() → None

hal.simulation.resumeTiming() → None

hal.simulation.setDriverStationAllianceStationId(allianceStationId: hal._wpiHal.AllianceStationID) → None

hal.simulation.setDriverStationDsAttached(dsAttached: SupportsInt | SupportsIndex) → None

hal.simulation.setDriverStationEStop(eStop: SupportsInt | SupportsIndex) → None

hal.simulation.setDriverStationEnabled(enabled: SupportsInt | SupportsIndex) → None

hal.simulation.setDriverStationFmsAttached(fmsAttached: SupportsInt | SupportsIndex) → None

hal.simulation.setDriverStationMatchTime(matchTime: SupportsFloat | SupportsIndex) → None

hal.simulation.setDriverStationOpMode(opmode: SupportsInt | SupportsIndex) → None

hal.simulation.setDriverStationRobotMode(mode: hal._wpiHal._RobotMode) → None

hal.simulation.setEventName(name: str) → None

hal.simulation.setGameData(gameData: hal._wpiHal.GameData) → None

hal.simulation.setGameDataString(name: str) → None

hal.simulation.setJoystickAxes(joystickNum: SupportsInt | SupportsIndex, axes: hal._wpiHal.JoystickAxes) → None

hal.simulation.setJoystickAxesAvailable(stick: SupportsInt | SupportsIndex, available: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickAxis(stick: SupportsInt | SupportsIndex, axis: SupportsInt | SupportsIndex, value: SupportsFloat | SupportsIndex) → None

hal.simulation.setJoystickButton(stick: SupportsInt | SupportsIndex, button: SupportsInt | SupportsIndex, state: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickButtons(joystickNum: SupportsInt | SupportsIndex, buttons: hal._wpiHal.JoystickButtons) → None

hal.simulation.setJoystickButtonsAvailable(stick: SupportsInt | SupportsIndex, available: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickButtonsValue(stick: SupportsInt | SupportsIndex, buttons: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickDescriptor(joystickNum: SupportsInt | SupportsIndex, descriptor: hal._wpiHal.JoystickDescriptor) → None

hal.simulation.setJoystickGamepadType(stick: SupportsInt | SupportsIndex, type: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickIsGamepad(stick: SupportsInt | SupportsIndex, isGamepad: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickLeds(joystickNum: SupportsInt | SupportsIndex, leds: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickName(stick: SupportsInt | SupportsIndex, name: str) → None

hal.simulation.setJoystickPOV(stick: SupportsInt | SupportsIndex, pov: SupportsInt | SupportsIndex, value: hal._wpiHal.JoystickPOV) → None

hal.simulation.setJoystickPOVs(joystickNum: SupportsInt | SupportsIndex, povs: hal._wpiHal.JoystickPOVs) → None

hal.simulation.setJoystickPOVsAvailable(stick: SupportsInt | SupportsIndex, available: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickRumbles(joystickNum: SupportsInt | SupportsIndex, leftRumble: SupportsInt | SupportsIndex, rightRumble: SupportsInt | SupportsIndex, leftTriggerRumble: SupportsInt | SupportsIndex, rightTriggerRumble: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickSupportedOutputs(stick: SupportsInt | SupportsIndex, supportedOutputs: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickTouchpadCounts(stick: SupportsInt | SupportsIndex, touchpadCount: SupportsInt | SupportsIndex, fingerCount: SupportsInt | SupportsIndex) → None

hal.simulation.setJoystickTouchpadFinger(stick: SupportsInt | SupportsIndex, touchpad: SupportsInt | SupportsIndex, finger: SupportsInt | SupportsIndex, down: SupportsInt | SupportsIndex, x: SupportsFloat | SupportsIndex, y: SupportsFloat | SupportsIndex) → None

hal.simulation.setJoystickTouchpads(joystickNum: SupportsInt | SupportsIndex, touchpads: hal._wpiHal.JoystickTouchpads) → None

hal.simulation.setMatchInfo(info: hal._wpiHal.MatchInfo) → None

hal.simulation.setMatchNumber(matchNumber: SupportsInt | SupportsIndex) → None

hal.simulation.setMatchType(type: hal._wpiHal.MatchType) → None

hal.simulation.setProgramStarted(started: SupportsInt | SupportsIndex) → None

hal.simulation.setProgramState(*args, **kwargs)

Overloaded function.

setProgramState(controlWord: hal._wpiHal._ControlWord) -> None
setProgramState(controlWord: hal._wpiHal.ControlWord) -> None

hal.simulation.setReplayNumber(replayNumber: SupportsInt | SupportsIndex) → None

hal.simulation.setRuntimeType(type: hal._wpiHal.RuntimeType) → None

hal.simulation.setSimDeviceEnabled(prefix: str, enabled: SupportsInt | SupportsIndex) → None

hal.simulation.stepTiming(delta: SupportsInt | SupportsIndex) → None

hal.simulation.stepTimingAsync(delta: SupportsInt | SupportsIndex) → None

hal.simulation.waitForProgramStart(timeout: float | None = None, delta: float = 0.001)[source]

Polls robot program and returns when it has reported that it started

Parameters:

timeout – Amount of time to wait
delta – Amount of time to sleep between checks