BunyipsOpMode

abstract class BunyipsOpMode : BOMInternal

BunyipsOpMode

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

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
lateinit var gamepad1: Controller

BunyipsLib Gamepad 1: Driver

Link copied to clipboard
lateinit var gamepad2: Controller

BunyipsLib Gamepad 2: Operator

Link copied to clipboard

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.

Link copied to clipboard
val robotControllers: List<LynxModule>

A list of all LynxModules (Control + Expansion Hub) modules on the robot.

Link copied to clipboard
lateinit var t: DualTelemetry

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.

Link copied to clipboard
lateinit var telemetry: DualTelemetry

BunyipsLib Driver Station & FtcDashboard Telemetry

Link copied to clipboard

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

Link copied to clipboard
var hardwareMap: HardwareMap
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
protected abstract fun activeLoop()

Code to run continuously after the START button is pressed on the Driver Station.

Link copied to clipboard

Dangerous method: call to IMMEDIATELY terminate the OpMode. No further code will run, and this should only be used in emergencies.

Link copied to clipboard
fun exit()

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.

Link copied to clipboard
fun finish(safeHaltHardwareOnStop: Boolean = true)

Call to manually finish the OpMode.

Link copied to clipboard

Get the currently respected init-task that will run during dynamic_init.

Link copied to clipboard
fun halt()

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.

Link copied to clipboard
fun onActiveLoop(vararg runnables: Runnable)

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.

Link copied to clipboard
protected open fun onFinish()

Perform one time clean-up operations after the activeLoop finishes all intentions gracefully.

Link copied to clipboard
protected abstract fun onInit()

Runs upon the pressing of the INIT button on the Driver Station.

Link copied to clipboard
protected open fun onInitDone()

Allow code to execute once after all initialisation has finished.

Link copied to clipboard
protected open fun onInitLoop(): Boolean

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.

Link copied to clipboard
protected open fun onStart()

Perform one time operations after start is pressed.

Link copied to clipboard
protected open fun onStop()

Perform one time clean-up operations as the OpMode is stopping.

Link copied to clipboard
fun resume()

Call to resume the activeLoop after a halt call.

Link copied to clipboard
protected override fun runBunyipsOpMode()

This method is the entry point for the BunyipsLib framework, and is called by the FTC SDK.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Call to command all moving motors/CRServos to stop by method of setting their powers to zero. This does not impact normal servos.

Inherited functions

Link copied to clipboard
open fun getRuntime(): Double
Link copied to clipboard
fun idle()
Link copied to clipboard
override fun init()
Link copied to clipboard
override fun init_loop()
Link copied to clipboard
Link copied to clipboard
open fun internalPostLoop()
Link copied to clipboard
open fun internalPreInit()
Link copied to clipboard
fun internalUpdateTelemetryNow(telemetry: TelemetryMessage)
Link copied to clipboard
override fun loop()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun resetRuntime()
Link copied to clipboard
open override fun runOpMode()
Link copied to clipboard
fun sleep(milliseconds: Long)
Link copied to clipboard
override fun start()
Link copied to clipboard
override fun stop()
Link copied to clipboard
Link copied to clipboard
open fun updateTelemetry(telemetry: Telemetry)
Link copied to clipboard
open fun waitForStart()