Command/com.amarcolini.joos.dashboard

Package-level declarations

Integrations with FTC Dashboard that make working with it much smoother

Types

class BetterArrayProvider<T>(array: () -> Array<*>, indices: Int) : ValueProvider<T?>

Singleton class that handles the JoosConfig annotation as well as FTC Dashboard configs for Pose2d, Vector2d, Angle, and other classes as specified by ImmutableConfigProvider and MutableConfigProvider.

ConfigUtils

object ConfigUtils

CustomProvider

class CustomProvider<T>(getter: () -> T, setter: (T) -> Unit) : ValueProvider<T>

A custom value provider using getter and setter for get and set.

Immutable

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])

annotation class Immutable

Specifies to the Joos annotation processor that this class, when used as a config variable, should be a mutable property/field.

ImmutableConfigProvider

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class ImmutableConfigProvider(val priority: Int = 0)

Specifies a custom config provider to be used by ConfigHandler. Functions with this annotation should take in two arguments (the property getter and setter, in that order) and return a ConfigVariable. They should also be static (In Kotlin, this means using JvmStatic, a companion object, or a top-level function).

JoosConfig

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])

annotation class JoosConfig(val name: String = "")

An alternative to Config that automatically handles more complex types like trajectories, poses, and angles, or even custom types using MutableConfigProvider or ImmutableConfigProvider. Its functionality is the same such that if a class has this annotation, all of its public, static, non-final fields will be added to FTC Dashboard (unless the class also has the Disabled annotation).

MutableConfigProvider

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class MutableConfigProvider(val priority: Int = 0)

Specifies a custom config provider to be used by ConfigHandler. Functions with this annotation should take in one argument (the value to generate a config for) and return a ConfigVariable. They should also be static (In Kotlin, this means using JvmStatic, a companion object, or a top-level function).

SuperTelemetry

object SuperTelemetry

A powerful telemetry for both the Driver Station and FTC Dashboard.