Interface ParamTransport

All Known Implementing Classes:

NetworkTablesTransport

public interface ParamTransport

How params reach a dashboard for live tuning. NetworkTablesTransport is today's (on AdvantageKit's LoggedNetwork inputs); WPILib's Tunables can replace it without touching any code that declares or reads a param.

Whatever the transport, what it reads is only a request: Params applies it on the main thread, only while disabled, and logs the applied value as an input.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ParamTransport.LiveValue	A published value: what the dashboard last set, and a way to show a value there.

Method Summary

Modifier and Type	Method	Description
ParamTransport.LiveValue	button(String name)	Publishes a button (a Boolean the dashboard sets true; the code sets it back).
ParamTransport.LiveValue	publish(Param<?> param)	Publishes a param with its current value.

Method Details

publish

ParamTransport.LiveValue publish(Param<?> param)

Publishes a param with its current value. Called on the main thread.

button

ParamTransport.LiveValue button(String name)

Publishes a button (a Boolean the dashboard sets true; the code sets it back).