2023-02-13 14:37:05 -06:00
<!DOCTYPE HTML>
< html lang = "en" >
< head >
2024-10-20 09:14:32 -05:00
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
2024-01-15 14:39:17 -06:00
< title > swervelib.encoders< / 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-10-20 09:14:32 -05:00
< meta name = "dc.created" content = "2024-10-20" >
2023-02-14 22:03:02 -06:00
< meta name = "description" content = "declaration: package: swervelib.encoders" >
< 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.encoders" class = "title" > Package swervelib.encoders< / h1 >
< / div >
< hr >
< div class = "package-signature" > package < span class = "element-name" > swervelib.encoders< / span > < / div >
2023-02-16 22:12:57 -06:00
< section class = "package-description" id = "package-description" >
< div class = "block" > Absolute encoders for the swerve drive, all implement < a href = "SwerveAbsoluteEncoder.html" title = "class in swervelib.encoders" > < code > SwerveAbsoluteEncoder< / code > < / a > .< / 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 = "../package-summary.html" > swervelib< / a > < / div >
2023-02-16 22:12:57 -06:00
< div class = "col-last even-row-color" >
< div class = "block" > Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.< / 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 >
2023-02-21 22:38:14 -06:00
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "AnalogAbsoluteEncoderSwerve.html" title = "class in swervelib.encoders" > AnalogAbsoluteEncoderSwerve< / a > < / div >
2023-02-14 22:03:02 -06:00
< div class = "col-last even-row-color class-summary class-summary-tab2" >
2023-02-21 22:38:14 -06:00
< div class = "block" > Swerve Absolute Encoder for Thrifty Encoders and other analog encoders.< / div >
2023-02-14 22:03:02 -06:00
< / div >
2024-09-03 14:46:24 -05:00
< div class = "col-first odd-row-color class-summary class-summary-tab2" > < a href = "CanAndMagSwerve.html" title = "class in swervelib.encoders" > CanAndMagSwerve< / a > < / div >
2023-02-14 22:03:02 -06:00
< div class = "col-last odd-row-color class-summary class-summary-tab2" >
2024-08-24 17:27:03 -05:00
< div class = "block" > HELIUM < code > Canandmag< / code > from ReduxRobotics absolute encoder, attached through the CAN bus.< / div >
2023-02-14 22:03:02 -06:00
< / div >
2023-08-09 16:23:30 -05:00
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "CANCoderSwerve.html" title = "class in swervelib.encoders" > CANCoderSwerve< / a > < / div >
2023-02-14 22:03:02 -06:00
< div class = "col-last even-row-color class-summary class-summary-tab2" >
2023-08-09 16:23:30 -05:00
< div class = "block" > Swerve Absolute Encoder for CTRE CANCoders.< / div >
2023-02-21 22:38:14 -06:00
< / div >
2023-09-01 00:21:16 -05:00
< div class = "col-first odd-row-color class-summary class-summary-tab2" > < a href = "PWMDutyCycleEncoderSwerve.html" title = "class in swervelib.encoders" > PWMDutyCycleEncoderSwerve< / a > < / div >
2023-02-21 22:38:14 -06:00
< div class = "col-last odd-row-color class-summary class-summary-tab2" >
2023-09-01 00:21:16 -05:00
< div class = "block" > DutyCycle encoders such as "US Digital MA3 with PWM Output, the CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag
Encoder." attached via a PWM lane.< / div >
2023-08-09 16:23:30 -05:00
< / div >
2023-12-05 16:25:42 -06:00
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "SparkMaxAnalogEncoderSwerve.html" title = "class in swervelib.encoders" > SparkMaxAnalogEncoderSwerve< / a > < / div >
2023-08-09 16:23:30 -05:00
< div class = "col-last even-row-color class-summary class-summary-tab2" >
2023-12-05 16:25:42 -06:00
< div class = "block" > SparkMax absolute encoder, attached through the data port analog pin.< / div >
2023-09-01 00:21:16 -05:00
< / div >
2023-12-05 16:25:42 -06:00
< div class = "col-first odd-row-color class-summary class-summary-tab2" > < a href = "SparkMaxEncoderSwerve.html" title = "class in swervelib.encoders" > SparkMaxEncoderSwerve< / a > < / div >
2023-09-01 00:21:16 -05:00
< div class = "col-last odd-row-color class-summary class-summary-tab2" >
2023-12-05 16:25:42 -06:00
< div class = "block" > SparkMax absolute encoder, attached through the data port.< / div >
< / div >
< div class = "col-first even-row-color class-summary class-summary-tab2" > < a href = "SwerveAbsoluteEncoder.html" title = "class in swervelib.encoders" > SwerveAbsoluteEncoder< / a > < / div >
< div class = "col-last even-row-color class-summary class-summary-tab2" >
2023-08-29 19:59:07 -05:00
< div class = "block" > Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..< / 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 >