|
YAMS
Yet Another Mechanism System
|
#include <SwerveModuleTelemetryConfig.hpp>
Public Types | |
| enum class | DoubleTelemetryField { AbsoluteEncoder } |
| enum class | StructTelemetryField { State } |
| using | TelemetryVerbosity = motorcontrollers::SmartMotorControllerConfig::TelemetryVerbosity |
Swerve module telemetry configuration.
Use this builder to select exactly which fields are published to NetworkTables and/or DataLog. Every field is disabled by default; call the individual With*() methods to opt in, or use WithTelemetryVerbosity() to enable a predefined set.
| using yams::telemetry::SwerveModuleTelemetryConfig::TelemetryVerbosity = motorcontrollers::SmartMotorControllerConfig::TelemetryVerbosity |
|
strong |
|
strong |
| yams::telemetry::SwerveModuleTelemetryConfig::SwerveModuleTelemetryConfig | ( | ) |
|
explicit |
Construct with a verbosity preset.
| verbosity | TelemetryVerbosity to use by default. |
| std::optional< std::string > yams::telemetry::SwerveModuleTelemetryConfig::GetDataLogName | ( | ) | const |
| std::unordered_map< DoubleTelemetryField, DoubleTelemetry< DoubleTelemetryField > > & yams::telemetry::SwerveModuleTelemetryConfig::GetDoubleFields | ( | ) |
| bool yams::telemetry::SwerveModuleTelemetryConfig::GetNT4Enabled | ( | ) | const |
| std::unordered_map< StructTelemetryField, StructTelemetry< wpi::math::SwerveModuleVelocity, StructTelemetryField > > & yams::telemetry::SwerveModuleTelemetryConfig::GetStructFields | ( | ) |
| SwerveModuleTelemetryConfig & yams::telemetry::SwerveModuleTelemetryConfig::WithAbsoluteEncoder | ( | ) |
Enables the absolute encoder angle logging.
| SwerveModuleTelemetryConfig & yams::telemetry::SwerveModuleTelemetryConfig::WithCustom | ( | const std::vector< DoubleTelemetryField > & | fields, |
| bool | value ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
| SwerveModuleTelemetryConfig & yams::telemetry::SwerveModuleTelemetryConfig::WithCustom | ( | const std::vector< StructTelemetryField > & | fields, |
| bool | value ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
| SwerveModuleTelemetryConfig & yams::telemetry::SwerveModuleTelemetryConfig::WithCustom | ( | DoubleTelemetryField | field, |
| bool | value ) |
Escape hatch for unimplemented fields which should be enabled or disabled.
| field | Field to configure. |
| value | Enable on true, disable on false. |
| SwerveModuleTelemetryConfig & yams::telemetry::SwerveModuleTelemetryConfig::WithCustom | ( | StructTelemetryField | field, |
| bool | value ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
| SwerveModuleTelemetryConfig & yams::telemetry::SwerveModuleTelemetryConfig::WithDataLogName | ( | const std::string & | dataLogName | ) |
Set up a DataLog entry for this module.
| dataLogName | DataLog entry name. |
| SwerveModuleTelemetryConfig & yams::telemetry::SwerveModuleTelemetryConfig::WithNetworkTables | ( | bool | enabled | ) |
Enable or disable NT4 telemetry. This will not create NT4 entries and is generally only advisable during competition matches.
| enabled | true to enable NT4 output. |
| SwerveModuleTelemetryConfig & yams::telemetry::SwerveModuleTelemetryConfig::WithoutNetworkTables | ( | ) |
Disable NetworkTable output.
| SwerveModuleTelemetryConfig & yams::telemetry::SwerveModuleTelemetryConfig::WithState | ( | ) |
Enables the SwerveModuleState logging.
| SwerveModuleTelemetryConfig & yams::telemetry::SwerveModuleTelemetryConfig::WithTelemetryVerbosity | ( | TelemetryVerbosity | verbosity | ) |
Enable a preset bundle of fields based on verbosity level.
| verbosity | Verbosity level to apply. |