Bunyips Op Mode
The gateway to the BunyipsLib framework, BunyipsOpMode is a wrapper around the FTC SDK's LinearOpMode.
This class provides a structured way to manage the lifecycle of an OpMode, and provides a number of utility functions to make development easier. This class is designed to be extended by the user to create their own OpModes, and has native support for linked Driver Station & FtcDashboard telemetry (DualTelemetry), native custom gamepads (Controller), timing utilities (timer), exception handling (Exceptions), and more through the BunyipsLib suite of tools (BunyipsSubsystem, Scheduler, etc.)
Author
Lucas Bubner, 2024
Since
1.0.0-pre
See also
Inheritors
Properties
BunyipsLib Gamepad 1: Driver
BunyipsLib Gamepad 2: Operator
Set how fast the OpMode is able to loop in the activeLoop or onInitLoop methods in Loops per Time Unit. This will dynamically adjust to be the target speed of how fast loops should be executed. Measures of less than or equal to zero will be ignored, and the OpMode will run as fast as possible.
A list of all LynxModules (Control + Expansion Hub) modules on the robot.
Shorthand field alias for the telemetry (DualTelemetry) field. Sometimes, this field is required to be used as the Kotlin compiler might have trouble distinguishing between the overridden field and the base field. This method is a direct alias to the DualTelemetry field.
BunyipsLib Driver Station & FtcDashboard Telemetry
The moving average timer for the OpMode, which is used to calculate time between hardware cycles. This is useful for debugging, performance monitoring, and calculating various time-based values (deltaTime, loopCount, elapsedTime, etc.)
Inherited properties
Functions
Code to run continuously after the START
button is pressed on the Driver Station.
Removes a Runnable that was added to the active loop via onActiveLoop. Calling this method will no-op on runnables that can't be found on the currently attached runnables, and will stop executing runnables on the active loop that could be found.
Dangerous method: call to IMMEDIATELY terminate the OpMode. No further code will run, and this should only be used in emergencies.
Dangerous method: call to shut down the OpMode as soon as possible. This will run any BunyipsOpMode cleanup code, much as if the user pressed the STOP
button.
Call to manually finish the OpMode.
Get the currently respected init-task that will run during dynamic_init
.
Call to temporarily halt all activeLoop-related updates from running. Note this will pause the entire activeLoop, but continue to update timers and telemetry. These events must be handled manually if needed, which include any conditional calls to resume.
Add a Runnable to the list of runnables to be executed just before the activeLoop. This is useful for running code that needs to be executed on the main thread, but is not a subsystem or task.
Perform one time clean-up operations after the activeLoop finishes all intentions gracefully.
Allow code to execute once after all initialisation has finished.
Run code in a loop AFTER onInit has completed, until start is pressed on the Driver Station and the init-task (setInitTask) is done. The boolean returned by this method will indicate the status of the imit-loop, if it returns true, the init-loop will finish early.
Call to resume the activeLoop after a halt call.
This method is the entry point for the BunyipsLib framework, and is called by the FTC SDK.
Dangerous method: Call to command all motors and servos on the robot to shut down. This is a method called by the SDK continuously when no OpMode is running. It is also automatically called via finish.
Set a task that will run as an init-task. This will run after your onInit has completed, allowing you to initialise hardware first. This is an optional method, and runs alongside onInitLoop.
Call to command all moving motors/CRServos to stop by method of setting their powers to zero. This does not impact normal servos.