Oblog Documentation

Welcome to the documentation for Oblog, an annotation-based Shuffleboard logging tool for FRC teams!

For an overview of what Oblog is and why you should use it, see the introduction page. For a quick start guide, see Getting Started with Oblog.

The Oblog API docs can be found here.

An example project (based on the WPILib FrisbeeBot example project) demonstrating the usage of several Oblog features can be found here.

Contents

• Introduction to Oblog
  • What Is Oblog?
  • Why Use Oblog?
  • Contributing to Oblog
• Getting Started with Oblog
  • Adding Oblog as a Dependency
  • Configuring the Logger
  • Logging a Field
  • Configuring a Field
  • Creating Additional Tabs
• Oblog Log Annotations
  • Using the Log Annotations
    • The @Log Annotation
    • Sendable Widgets
  • Parameters
    • Value Name
    • Tab Name
    • Method Name
    • Display Size
    • Display Location
• Oblog Config Annotations
  • Using the Config Annotations
    • The @Config Annotation
    • Multi-Parameter Setters
    • Sendable Widgets
  • Parameters
    • Value Name
    • Tab Name
    • Method Name/Types
    • Default Values
    • Multi-Parameter Layout Type
    • Display Size
    • Display Location
• Creating Loggable Classes
  • Using the Loggable Interface
    • Making a Class Loggable
    • Configuring Loggable Names
    • Configuring Loggable Layouts
      • Layout Type
      • Layout Size
      • Layout Position
      • Skipping Layouts
    • Adding Custom Logging
  • Excluding and Re-Including Loggables
  • Arrays/Lists of Loggables
• The Oblog Logger
  • Initial Logger Configuration
    • Configuring Logging and Config
    • Configuring Logging Only
    • Configure Logging Only (NT Only)
    • Configuring Config Only
  • Updating the Logged Fields
  • Disabling Cycle Warnings