BunyipsLib/au.edu.sa.mbhs.studentrobotics.bunyipslib.subsystems/BlinkinLights

BlinkinLights

open class BlinkinLights : BunyipsSubsystem

LED driver subsystem for the REV Blinkin Lights. Able to integrate with the Task system to schedule lighting patterns.

Author

Lachlan Paul, 2024

Lucas Bubner, 2024

Since

4.0.0

Constructors

Link copied to clipboard
constructor(@Nullable lights: RevBlinkinLedDriver, @NonNull defaultPattern: RevBlinkinLedDriver.BlinkinPattern)
Create a new BlinkinLights subsystem.

Types

Link copied to clipboard
open inner class Tasks
Tasks for BlinkinLights, access with tasks.
Link copied to clipboard
enum Voltage
REV Robotics Blinkin LED Driver voltage options.

Properties

Link copied to clipboard
@get:NonNull
@set:NonNull
open var defaultPattern: RevBlinkinLedDriver.BlinkinPattern
Link copied to clipboard
val tasks: BlinkinLights.Tasks
Tasks for BlinkinLights.

Inherited properties

Link copied to clipboard
@get:Nullable
open var currentTask: Task
Link copied to clipboard
@NonNull
protected open var name: String
Reference to the user-defined or default name of this subsystem.

Functions

Link copied to clipboard
@NonNull
open fun forceSetPattern(@NonNull pattern: RevBlinkinLedDriver.BlinkinPattern): BlinkinLights
Set the current pattern.
Link copied to clipboard
@NonNull
open fun getPattern(): RevBlinkinLedDriver.BlinkinPattern
Get the current pattern.
Link copied to clipboard
protected open fun onDisable()
User callback that runs once when this subsystem is disabled by a call to disable or by an assertion failure.
Link copied to clipboard
protected open fun onEnable()
User callback that runs once when this subsystem is enabled by a call to enable or the first active call to periodic.
Link copied to clipboard
protected open fun periodic()
To be updated periodically on every hardware loop.
Link copied to clipboard
@NonNull
open fun resetPattern(): BlinkinLights
Reset the pattern back to the default.
Link copied to clipboard
@NonNull
open fun setPattern(@NonNull pattern: RevBlinkinLedDriver.BlinkinPattern): BlinkinLights
Set the current pattern.
Link copied to clipboard
@NonNull
open fun setPwm(us: Double): BlinkinLights
Set the PWM value of the lights.
Link copied to clipboard
@NonNull
open fun turnOff(): BlinkinLights
Cancel tasks and turn off the lights.

Inherited functions

Link copied to clipboard
protected fun assertParamsNotNull(parameters: Array<Any>): Boolean
Utility function to run NullSafety.assertComponentArgs() on the given parameters, usually on the motors/hardware/critical objects passed into the constructor.
Link copied to clipboard
fun cancelCurrentTask()
Cancel the current task immediately and return to the default task, if available.
Link copied to clipboard
infix fun BunyipsSubsystem.default(defaultTask: Task)

Default task setter extension for BunyipsSubsystem to set the default task of a subsystem.

Link copied to clipboard
protected fun delegate(@NonNull child: BunyipsSubsystem)
Call to delegate the update of this subsystem, usually a component of another subsystem, to this subsystem.
Link copied to clipboard
fun disable()
Prevent a subsystem from running.
Link copied to clipboard
open fun disableAll()
Disable all BunyipsSubsystem instances that has been constructed since the last clearing.
Link copied to clipboard
fun enable()
Re-enable a subsystem if it was previously disabled via a disable call.
Link copied to clipboard
open fun enableAll()
Enable all BunyipsSubsystem instances that has been constructed since the last clearing.
Link copied to clipboard
@NonNull
protected fun forThisSubsystem(@NonNull name: Any): String
Formats a task name to follow the convention full_name:task.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun isIdle(): Boolean
Determine if the subsystem is idle, meaning an IdleTask (or no task) is running.
Link copied to clipboard
fun isRunningDefaultTask(): Boolean
Determine if the subsystem is running the default task.
Link copied to clipboard
fun setDefaultTask(@NonNull defaultTask: Task)
Set the default task for this subsystem, which will be run when no other task is running.
Link copied to clipboard
fun setHighPriorityCurrentTask(@NonNull currentTask: Task)
Set the current task to the given task, overriding any current task.
Link copied to clipboard
protected fun sout(@NonNull logger: Consumer<String>, @NonNull format: String, @Nullable objs: Array<Any>)
Log to Logcat using smart formatting with the current subsystem name.
Link copied to clipboard
fun startThread()
fun startThread(@NonNull loopSleepDuration: Measure<Time>)
Call to delegate all updates of this subsystem to a thread that will begin execution on this method call.
Link copied to clipboard
fun stopThread()
Call to stop delegating updates of this subsystem to a thread.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun update()
Update the subsystem and run the current task, if tasks are not set up this will just call periodic.
Link copied to clipboard
open fun updateAll()
Update all instances of BunyipsSubsystem that has been constructed since the last clearing.
Link copied to clipboard
fun <T : BunyipsSubsystem?> withName(@NonNull subsystemName: String): T
Set the name of this subsystem that will be used in telemetry and references.