YAMS
Yet Another Mechanism System
Loading...
Searching...
No Matches
yams::Rivet Class Referencefinal

#include <Rivet.hpp>

Public Member Functions

 Rivet ()=delete

Static Public Member Functions

static void Show ()
static std::string_view GetVersion ()

Detailed Description

Rivet, the YASS mascot, says hi on the Driver Station display when YAMS starts up.

The splash is written once, the first time a YAMS motor controller or swerve drive is built. The Display panel docked in the Driver Station shows about 26 columns by 9 rows, so it gets a short welcome with the YAMS version, yassrobotics.com and the live tuner, plus an arrow to the panel's pop-out button. Popping the display out (or scrolling right) shows Rivet at full resolution with a random phrase from Rivet under it. It uses wpi::DriverStationDisplay line mode, so robot code that writes its own lines afterwards simply replaces it.

Constructor & Destructor Documentation

◆ Rivet()

yams::Rivet::Rivet ( )
delete

Member Function Documentation

◆ GetVersion()

std::string_view yams::Rivet::GetVersion ( )
static

Get the YAMS version this library was built as.

Returns
The release version, such as 2026.11.14, or "dev" when YAMS was built from source.

◆ Show()

void yams::Rivet::Show ( )
static

Show the welcome and Rivet on the Driver Station display. Only the first call does anything.


The documentation for this class was generated from the following file:
  • /home/runner/work/YAMS/YAMS/yams/cpp/include/yams/Rivet.hpp