Skip to content
Bradley Chumanov edited this page Apr 29, 2025 · 29 revisions
drawing
Badgerlog is a modern, annotation-based NetworkTables utility.

Getting Started

Installation

There are multiple steps in installation.

  1. Add a new vendor dependency to a robot project. https://raw.githubusercontent.com/team1306/badger-log/master/vendordep.json
  2. To enable annotation processing add annotationProcessor 'com.github.team1306:badger-log:2025.1.4' to dependencies in build.gradle

Annotation processing will ensure fields annotated with @Entry, any Configurable annotation or @MappingType match the requirements specified in Annotation Requirements

Badgerlog has many capabilities as a NetworkTables utility.

Initial Setup

There are 2 methods that need to be called at different points.

Dashboard.initialize must be called on robot startup (Usually Robot.robotInit)
Failure to configure the Dashboard will result in no entries being created, as well as no methods in Dashboard working.

Dashboard.update must be called periodically (Usually Robot.robotPeriodic)
Failure to run update periodically will result in NetworkTables entries not updating

Basic Usage

TODO

Annotation Requirements

TODO

Configuration Options

See Configuration

Documentation

The Javadoc can be found on Jitpack

Clone this wiki locally