Class HootTelemetryBackend

java.lang.Object

com.ctre.phoenix6.HootTelemetryBackend

All Implemented Interfaces:

AutoCloseable, TelemetryBackend

public final class HootTelemetryBackend
extends Object
implements TelemetryBackend

A telemetry backend implementation that saves information to a CTRE hoot file on disk using the Phoenix 6 SignalLogger.

Constructor Summary

Constructors

Constructor	Description
HootTelemetryBackend()	Creates a new hoot telemetry backend.
HootTelemetryBackend(String prefix)	Creates a new hoot telemetry backend.
HootTelemetryBackend(String prefix, String path)	Creates a new hoot telemetry backend with the target file path.

Method Summary

Modifier and Type	Method	Description
void	close()
TelemetryEntry	getEntry(String path)	Create an entry for the given path.
void	removeEntry(String path)	Removes an entry for the given path.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface TelemetryBackend

ownsBackend, sharesBackendWith

Constructor Details

HootTelemetryBackend

public HootTelemetryBackend()

Creates a new hoot telemetry backend. This immediately starts the SignalLogger and automatically stops it once close() has been called on all instances. This will use the default path documented in SignalLogger.setPath(String).

HootTelemetryBackend

public HootTelemetryBackend(String prefix)

Creates a new hoot telemetry backend. This immediately starts the SignalLogger and automatically stops it once close() has been called on all instances. This will use the default path documented in SignalLogger.setPath(String).

Parameters:

prefix - Prefix to prepend to all log entry names; defaults empty

HootTelemetryBackend

public HootTelemetryBackend(String prefix,
 String path)

Creates a new hoot telemetry backend with the target file path. This immediately starts the SignalLogger and automatically stops it once close() has been called on all instances.

Parameters:

prefix - Prefix to prepend to all log entry names; defaults empty

path - Folder path for the log files; path must exist

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

getEntry

public TelemetryEntry getEntry(String path)

Create an entry for the given path.

Specified by:

getEntry in interface TelemetryBackend

Parameters:

path - full name

Returns:

telemetry entry

removeEntry

public void removeEntry(String path)

Removes an entry for the given path.

Specified by:

removeEntry in interface TelemetryBackend

Parameters:

path - normalized full name