frc::LiveWindow Class Reference

The LiveWindow class is the public interface for putting sensors and actuators on the LiveWindow. More...

#include <frc/livewindow/LiveWindow.h>

Static Public Member Functions
static void	SetEnabledCallback (std::function< void()> func)
	Sets function to be called when LiveWindow is enabled. More...
static void	SetDisabledCallback (std::function< void()> func)
	Sets function to be called when LiveWindow is disabled. More...
static void	EnableTelemetry (wpi::Sendable *component)
	Enable telemetry for a single component. More...
static void	DisableTelemetry (wpi::Sendable *component)
	Disable telemetry for a single component. More...
static void	DisableAllTelemetry ()
	Disable ALL telemetry. More...
static void	EnableAllTelemetry ()
	Enable ALL telemetry. More...
static bool	IsEnabled ()
	Returns true if LiveWindow is enabled. More...
static void	SetEnabled (bool enabled)
	Change the enabled status of LiveWindow. More...
static void	UpdateValues ()
	Tell all the sensors to update (send) their values. More...

Detailed Description

The LiveWindow class is the public interface for putting sensors and actuators on the LiveWindow.

Member Function Documentation

DisableAllTelemetry()

static void frc::LiveWindow::DisableAllTelemetry ( )

static

Disable ALL telemetry.

DisableTelemetry()

static void frc::LiveWindow::DisableTelemetry ( wpi::Sendable *  component )

static

Disable telemetry for a single component.

Parameters

component

sendable

EnableAllTelemetry()

static void frc::LiveWindow::EnableAllTelemetry ( )

static

Enable ALL telemetry.

EnableTelemetry()

static void frc::LiveWindow::EnableTelemetry ( wpi::Sendable *  component )

static

Enable telemetry for a single component.

Parameters

component

sendable

IsEnabled()

static bool frc::LiveWindow::IsEnabled ( )

static

Returns true if LiveWindow is enabled.

Returns

True if LiveWindow is enabled.

SetDisabledCallback()

static void frc::LiveWindow::SetDisabledCallback ( std::function< void()>  func )

static

Sets function to be called when LiveWindow is disabled.

Parameters

func	function (or nullptr for none)

SetEnabled()

static void frc::LiveWindow::SetEnabled ( bool  enabled )

static

Change the enabled status of LiveWindow.

If it changes to enabled, start livewindow running otherwise stop it

SetEnabledCallback()

static void frc::LiveWindow::SetEnabledCallback ( std::function< void()>  func )

static

Sets function to be called when LiveWindow is enabled.

Parameters

func	function (or nullptr for none)

UpdateValues()

static void frc::LiveWindow::UpdateValues ( )

static

Tell all the sensors to update (send) their values.

Actuators are handled through callbacks on their value changing from the SmartDashboard widgets.

---

The documentation for this class was generated from the following file:

• frc/livewindow/LiveWindow.h