mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-26 01:51:41 +00:00
86 lines
1.8 KiB
C++
86 lines
1.8 KiB
C++
// Copyright (c) FIRST and other WPILib contributors.
|
|
// Open Source Software; you can modify and/or share it under the terms of
|
|
// the WPILib BSD license file in the root directory of this project.
|
|
|
|
#pragma once
|
|
|
|
#include <functional>
|
|
|
|
namespace wpi {
|
|
class Sendable;
|
|
} // namespace wpi
|
|
|
|
namespace frc {
|
|
|
|
/**
|
|
* The LiveWindow class is the public interface for putting sensors and
|
|
* actuators on the LiveWindow.
|
|
*/
|
|
class LiveWindow final {
|
|
public:
|
|
/**
|
|
* Set function to be called when LiveWindow is enabled.
|
|
*
|
|
* @param func function (or nullptr for none)
|
|
*/
|
|
static void SetEnabledCallback(std::function<void()> func);
|
|
|
|
/**
|
|
* Set function to be called when LiveWindow is disabled.
|
|
*
|
|
* @param func function (or nullptr for none)
|
|
*/
|
|
static void SetDisabledCallback(std::function<void()> func);
|
|
|
|
/**
|
|
* Enable telemetry for a single component.
|
|
*
|
|
* @param component sendable
|
|
*/
|
|
static void EnableTelemetry(wpi::Sendable* component);
|
|
|
|
/**
|
|
* Disable telemetry for a single component.
|
|
*
|
|
* @param component sendable
|
|
*/
|
|
static void DisableTelemetry(wpi::Sendable* component);
|
|
|
|
/**
|
|
* Disable ALL telemetry.
|
|
*/
|
|
static void DisableAllTelemetry();
|
|
|
|
/**
|
|
* Enable ALL telemetry.
|
|
*/
|
|
static void EnableAllTelemetry();
|
|
|
|
static bool IsEnabled();
|
|
|
|
/**
|
|
* Change the enabled status of LiveWindow.
|
|
*
|
|
* If it changes to enabled, start livewindow running otherwise stop it
|
|
*/
|
|
static void SetEnabled(bool enabled);
|
|
|
|
/**
|
|
* Tell all the sensors to update (send) their values.
|
|
*
|
|
* Actuators are handled through callbacks on their value changing from the
|
|
* SmartDashboard widgets.
|
|
*/
|
|
static void UpdateValues();
|
|
|
|
private:
|
|
LiveWindow() = default;
|
|
|
|
/**
|
|
* Updates the entries, without using a mutex or lock.
|
|
*/
|
|
static void UpdateValuesUnsafe();
|
|
};
|
|
|
|
} // namespace frc
|