2023-02-13 14:37:05 -06:00
<!DOCTYPE HTML>
< html lang = "en" >
< head >
2024-01-23 20:53:17 -06:00
<!-- Generated by javadoc (17) on Tue Jan 23 20:51:53 CST 2024 -->
2024-01-15 14:39:17 -06:00
< title > swervelib< / title >
2023-02-14 22:03:02 -06:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2023-02-13 14:37:05 -06:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2024-01-23 20:53:17 -06:00
< meta name = "dc.created" content = "2024-01-23" >
2023-02-14 22:03:02 -06:00
< meta name = "description" content = "declaration: package: swervelib" >
< meta name = "generator" content = "javadoc/PackageWriterImpl" >
2023-02-13 15:03:55 -06:00
< link rel = "stylesheet" type = "text/css" href = "../stylesheet.css" title = "Style" >
2023-02-14 22:03:02 -06:00
< link rel = "stylesheet" type = "text/css" href = "../script-dir/jquery-ui.min.css" title = "Style" >
2023-02-13 15:03:55 -06:00
< link rel = "stylesheet" type = "text/css" href = "../jquery-ui.overrides.css" title = "Style" >
< script type = "text/javascript" src = "../script.js" > < / script >
2024-01-15 14:39:17 -06:00
< script type = "text/javascript" src = "../script-dir/jquery-3.5.1.min.js" > < / script >
2023-02-14 22:03:02 -06:00
< script type = "text/javascript" src = "../script-dir/jquery-ui.min.js" > < / script >
2023-02-13 14:37:05 -06:00
< / head >
2023-02-14 22:03:02 -06:00
< body class = "package-declaration-page" >
< script type = "text/javascript" > v a r p a t h t o r o o t = " . . / " ;
2023-02-13 14:37:05 -06:00
loadScripts(document, 'script');< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2023-02-14 22:03:02 -06:00
< div class = "flex-box" >
< header role = "banner" class = "flex-header" >
2023-02-13 14:37:05 -06:00
< nav role = "navigation" >
<!-- ========= START OF TOP NAVBAR ======= -->
2023-02-14 22:03:02 -06:00
< div class = "top-nav" id = "navbar-top" >
< div class = "skip-nav" > < a href = "#skip-navbar-top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< ul id = "navbar-top-firstrow" class = "nav-list" title = "Navigation" >
2023-02-13 15:03:55 -06:00
< li > < a href = "../index.html" > Overview< / a > < / li >
2023-02-14 22:03:02 -06:00
< li class = "nav-bar-cell1-rev" > Package< / li >
2023-02-13 14:37:05 -06:00
< li > Class< / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
2024-01-15 14:39:17 -06:00
< li > < a href = "../index-files/index-1.html" > Index< / a > < / li >
2023-02-14 22:03:02 -06:00
< li > < a href = "../help-doc.html#package" > Help< / a > < / li >
2023-02-13 14:37:05 -06:00
< / ul >
< / div >
2023-02-14 22:03:02 -06:00
< div class = "sub-nav" >
2023-02-13 14:37:05 -06:00
< div >
2023-02-14 22:03:02 -06:00
< ul class = "sub-nav-list" >
< li > Package: < / li >
2023-02-16 22:12:57 -06:00
< li > < a href = "#package-description" > Description< / a > | < / li >
2023-02-14 22:03:02 -06:00
< li > < a href = "#related-package-summary" > Related Packages< / a > | < / li >
< li > < a href = "#class-summary" > Classes and Interfaces< / a > < / li >
< / ul >
2023-02-13 14:37:05 -06:00
< / div >
2023-02-14 22:03:02 -06:00
< div class = "nav-list-search" > < label for = "search-input" > SEARCH:< / label >
< input type = "text" id = "search-input" value = "search" disabled = "disabled" >
< input type = "reset" id = "reset-button" value = "reset" disabled = "disabled" >
2023-02-13 14:37:05 -06:00
< / div >
2023-02-14 22:03:02 -06:00
< / div >
<!-- ========= END OF TOP NAVBAR ========= -->
< span class = "skip-nav" id = "skip-navbar-top" > < / span > < / nav >
2023-02-13 14:37:05 -06:00
< / header >
2023-02-14 22:03:02 -06:00
< div class = "flex-content" >
2023-02-13 14:37:05 -06:00
< main role = "main" >
< div class = "header" >
2023-02-14 22:03:02 -06:00
< h1 title = "Package swervelib" class = "title" > Package swervelib< / h1 >
< / div >
< hr >
< div class = "package-signature" > package < span class = "element-name" > swervelib< / span > < / div >
2023-02-16 22:12:57 -06:00
< section class = "package-description" id = "package-description" >
< div class = "block" > Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.< / div >
< / section >
2023-02-14 22:03:02 -06:00
< section class = "summary" >
< ul class = "summary-list" >
< li >
< div id = "related-package-summary" >
< div class = "caption" > < span > Related Packages< / span > < / div >
< div class = "summary-table two-column-summary" >
< div class = "table-header col-first" > Package< / div >
< div class = "table-header col-last" > Description< / div >
< div class = "col-first even-row-color" > < a href = "encoders/package-summary.html" > swervelib.encoders< / a > < / div >
2023-02-16 22:12:57 -06:00
< div class = "col-last even-row-color" >
< div class = "block" > Absolute encoders for the swerve drive, all implement < a href = "encoders/SwerveAbsoluteEncoder.html" title = "class in swervelib.encoders" > < code > SwerveAbsoluteEncoder< / code > < / a > .< / div >
< / div >
2023-02-14 22:03:02 -06:00
< div class = "col-first odd-row-color" > < a href = "imu/package-summary.html" > swervelib.imu< / a > < / div >
2023-02-16 22:12:57 -06:00
< div class = "col-last odd-row-color" >
< div class = "block" > IMUs used for controlling the robot heading.< / div >
< / div >
2023-02-14 22:03:02 -06:00
< div class = "col-first even-row-color" > < a href = "math/package-summary.html" > swervelib.math< / a > < / div >
2023-02-16 22:12:57 -06:00
< div class = "col-last even-row-color" >
< div class = "block" > Mathematics for swerve drives.< / div >
< / div >
2023-02-14 22:03:02 -06:00
< div class = "col-first odd-row-color" > < a href = "motors/package-summary.html" > swervelib.motors< / a > < / div >
2023-02-16 22:12:57 -06:00
< div class = "col-last odd-row-color" >
< div class = "block" > Swerve motor controller wrappers which implement < a href = "motors/SwerveMotor.html" title = "class in swervelib.motors" > < code > SwerveMotor< / code > < / a > .< / div >
< / div >
2023-02-14 22:03:02 -06:00
< div class = "col-first even-row-color" > < a href = "parser/package-summary.html" > swervelib.parser< / a > < / div >
2023-02-16 22:12:57 -06:00
< div class = "col-last even-row-color" >
< div class = "block" > JSON Parser for YAGSL configurations.< / div >
< / div >
2023-02-15 22:18:27 -06:00
< div class = "col-first odd-row-color" > < a href = "simulation/package-summary.html" > swervelib.simulation< / a > < / div >
2023-02-16 22:12:57 -06:00
< div class = "col-last odd-row-color" >
< div class = "block" > Classes used to simulate the swerve drive.< / div >
< / div >
2023-02-21 22:38:14 -06:00
< div class = "col-first even-row-color" > < a href = "telemetry/package-summary.html" > swervelib.telemetry< / a > < / div >
< div class = "col-last even-row-color" >
< div class = "block" > Telemetry package for sending data to NT4 or SmartDashboard.< / div >
< / div >
2023-02-14 22:03:02 -06:00
< / div >
2023-02-13 14:37:05 -06:00
< / div >
2023-02-14 22:03:02 -06:00
< / li >
< li >
< div id = "class-summary" >
< div class = "caption" > < span > Classes< / span > < / div >
< div class = "summary-table two-column-summary" >
< div class = "table-header col-first" > Class< / div >
< div class = "table-header col-last" > Description< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "SwerveController.html" title = "class in swervelib" > SwerveController< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
2023-02-13 14:37:05 -06:00
< div class = "block" > Controller class used to convert raw inputs into robot speeds.< / div >
2023-02-14 22:03:02 -06:00
< / div >
< div class = "col-first odd-row-color class-summary class-summary-tab2" > < a href = "SwerveDrive.html" title = "class in swervelib" > SwerveDrive< / a > < / div >
< div class = "col-last odd-row-color class-summary class-summary-tab2" >
2023-02-13 14:37:05 -06:00
< div class = "block" > Swerve Drive class representing and controlling the swerve drive.< / div >
2023-02-14 22:03:02 -06:00
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "SwerveModule.html" title = "class in swervelib" > SwerveModule< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
2023-02-13 14:37:05 -06:00
< div class = "block" > The Swerve Module class which represents and controls Swerve Modules for the swerve drive.< / div >
2023-02-14 22:03:02 -06:00
< / div >
< / div >
< / div >
2023-02-13 14:37:05 -06:00
< / li >
< / ul >
2023-02-14 22:03:02 -06:00
< / section >
2023-02-13 14:37:05 -06:00
< / main >
< / div >
< / div >
< / body >
< / html >
