2023-02-13 14:37:05 -06:00
<!DOCTYPE HTML>
< html lang = "en" >
< head >
2024-01-15 14:37:13 -06:00
<!-- Generated by javadoc (17) -->
< title > NavXSwerve (YAGSL-Example API)< / 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" >
2023-02-14 22:03:02 -06:00
< meta name = "description" content = "declaration: package: swervelib.imu, class: NavXSwerve" >
< meta name = "generator" content = "javadoc/ClassWriterImpl" >
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:37:13 -06:00
< script type = "text/javascript" src = "../../script-dir/jquery-3.6.0.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 = "class-declaration-page" >
< script type = "text/javascript" > v a r e v e n R o w C o l o r = " e v e n - r o w - c o l o r " ;
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
2023-02-13 15:03:55 -06:00
var pathtoroot = "../../";
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-13 14:37:05 -06:00
< li > < a href = "package-summary.html" > Package< / a > < / li >
2023-02-14 22:03:02 -06:00
< li class = "nav-bar-cell1-rev" > Class< / li >
2023-02-13 14:37:05 -06:00
< li > < a href = "package-tree.html" > Tree< / a > < / li >
2024-01-15 14:37:13 -06:00
< li > < a href = "../../index-all.html" > Index< / a > < / li >
2023-02-14 22:03:02 -06:00
< li > < a href = "../../help-doc.html#class" > 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" >
2023-02-13 14:37:05 -06:00
< li > Summary: < / li >
< li > Nested | < / li >
2024-01-15 14:37:13 -06:00
< li > Field | < / li >
2023-02-14 22:03:02 -06:00
< li > < a href = "#constructor-summary" > Constr< / a > | < / li >
< li > < a href = "#method-summary" > Method< / a > < / li >
2023-02-13 14:37:05 -06:00
< / ul >
2023-02-14 22:03:02 -06:00
< ul class = "sub-nav-list" >
2023-02-13 14:37:05 -06:00
< li > Detail: < / li >
2024-01-15 14:37:13 -06:00
< li > Field | < / li >
2023-02-14 22:03:02 -06:00
< li > < a href = "#constructor-detail" > Constr< / a > | < / li >
< li > < a href = "#method-detail" > Method< / a > < / li >
2023-02-13 14:37:05 -06:00
< / ul >
< / 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" >
2023-02-14 22:03:02 -06:00
<!-- ======== START OF CLASS DATA ======== -->
2023-02-13 14:37:05 -06:00
< div class = "header" >
2023-02-14 22:03:02 -06:00
< div class = "sub-title" > < span class = "package-label-in-type" > Package< / span > < a href = "package-summary.html" > swervelib.imu< / a > < / div >
< h1 title = "Class NavXSwerve" class = "title" > Class NavXSwerve< / h1 >
2023-02-13 14:37:05 -06:00
< / div >
2023-02-14 22:03:02 -06:00
< div class = "inheritance" title = "Inheritance Tree" > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title = "class or interface in java.lang" class = "external-link" > java.lang.Object< / a >
< div class = "inheritance" > < a href = "SwerveIMU.html" title = "class in swervelib.imu" > swervelib.imu.SwerveIMU< / a >
< div class = "inheritance" > swervelib.imu.NavXSwerve< / div >
< / div >
< / div >
< section class = "class-description" id = "class-description" >
2023-02-13 14:37:05 -06:00
< hr >
2023-02-14 22:03:02 -06:00
< div class = "type-signature" > < span class = "modifiers" > public class < / span > < span class = "element-name type-name-label" > NavXSwerve< / span >
< span class = "extends-implements" > extends < a href = "SwerveIMU.html" title = "class in swervelib.imu" > SwerveIMU< / a > < / span > < / div >
2023-02-13 14:37:05 -06:00
< div class = "block" > Communicates with the NavX as the IMU.< / div >
2023-02-14 22:03:02 -06:00
< / section >
< section class = "summary" >
< ul class = "summary-list" >
2023-02-13 14:37:05 -06:00
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
2023-02-14 22:03:02 -06:00
< li >
< section class = "constructor-summary" id = "constructor-summary" >
< h2 > Constructor Summary< / h2 >
< div class = "caption" > < span > Constructors< / span > < / div >
< div class = "summary-table two-column-summary" >
< div class = "table-header col-first" > Constructor< / div >
< div class = "table-header col-last" > Description< / div >
2023-09-01 00:21:16 -05:00
< div class = "col-constructor-name even-row-color" > < code > < a href = "#%3Cinit%3E(edu.wpi.first.wpilibj.I2C.Port)" class = "member-name-link" > NavXSwerve< / a > < wbr > (edu.wpi.first.wpilibj.I2C.Port port)< / code > < / div >
< div class = "col-last even-row-color" >
< div class = "block" > Constructor for the NavX swerve.< / div >
< / div >
< div class = "col-constructor-name odd-row-color" > < code > < a href = "#%3Cinit%3E(edu.wpi.first.wpilibj.SerialPort.Port)" class = "member-name-link" > NavXSwerve< / a > < wbr > (edu.wpi.first.wpilibj.SerialPort.Port port)< / code > < / div >
< div class = "col-last odd-row-color" >
< div class = "block" > Constructor for the NavX swerve.< / div >
< / div >
< div class = "col-constructor-name even-row-color" > < code > < a href = "#%3Cinit%3E(edu.wpi.first.wpilibj.SPI.Port)" class = "member-name-link" > NavXSwerve< / a > < wbr > (edu.wpi.first.wpilibj.SPI.Port port)< / code > < / div >
2023-02-14 22:03:02 -06:00
< div class = "col-last even-row-color" >
2023-02-13 14:37:05 -06:00
< div class = "block" > Constructor for the NavX swerve.< / div >
2023-02-14 22:03:02 -06:00
< / div >
< / div >
2023-02-13 14:37:05 -06:00
< / section >
2023-02-14 22:03:02 -06:00
< / li >
2023-02-13 14:37:05 -06:00
<!-- ========== METHOD SUMMARY =========== -->
2023-02-14 22:03:02 -06:00
< li >
< section class = "method-summary" id = "method-summary" >
< h2 > Method Summary< / h2 >
< div id = "method-summary-table" >
< div class = "table-tabs" role = "tablist" aria-orientation = "horizontal" > < button id = "method-summary-table-tab0" role = "tab" aria-selected = "true" aria-controls = "method-summary-table.tabpanel" tabindex = "0" onkeydown = "switchTab(event)" onclick = "show('method-summary-table', 'method-summary-table', 3)" class = "active-table-tab" > All Methods< / button > < button id = "method-summary-table-tab2" role = "tab" aria-selected = "false" aria-controls = "method-summary-table.tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" onclick = "show('method-summary-table', 'method-summary-table-tab2', 3)" class = "table-tab" > Instance Methods< / button > < button id = "method-summary-table-tab4" role = "tab" aria-selected = "false" aria-controls = "method-summary-table.tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" onclick = "show('method-summary-table', 'method-summary-table-tab4', 3)" class = "table-tab" > Concrete Methods< / button > < / div >
< div id = "method-summary-table.tabpanel" role = "tabpanel" >
< div class = "summary-table three-column-summary" aria-labelledby = "method-summary-table-tab0" >
< div class = "table-header col-first" > Modifier and Type< / div >
< div class = "table-header col-second" > Method< / div >
< div class = "table-header col-last" > Description< / div >
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > void< / code > < / div >
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > < a href = "#clearStickyFaults()" class = "member-name-link" > clearStickyFaults< / a > ()< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" >
2023-02-13 14:37:05 -06:00
< div class = "block" > Clear sticky faults on IMU.< / div >
2023-02-14 22:03:02 -06:00
< / div >
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > void< / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > < a href = "#factoryDefault()" class = "member-name-link" > factoryDefault< / a > ()< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" >
2023-02-13 14:37:05 -06:00
< div class = "block" > Reset IMU to factory default.< / div >
2023-02-14 22:03:02 -06:00
< / div >
2023-03-06 20:45:54 -06:00
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title = "class or interface in java.util" class = "external-link" > Optional< / a > < edu.wpi.first.math.geometry.Translation3d> < / code > < / div >
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > < a href = "#getAccel()" class = "member-name-link" > getAccel< / a > ()< / code > < / div >
2023-02-14 22:03:02 -06:00
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" >
2023-03-06 20:45:54 -06:00
< div class = "block" > Fetch the acceleration [x, y, z] from the IMU in meters per second squared.< / div >
< / div >
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title = "class or interface in java.lang" class = "external-link" > Object< / a > < / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > < a href = "#getIMU()" class = "member-name-link" > getIMU< / a > ()< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" >
2023-02-13 14:37:05 -06:00
< div class = "block" > Get the instantiated IMU object.< / div >
2023-02-14 22:03:02 -06:00
< / div >
2023-03-06 20:45:54 -06:00
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > edu.wpi.first.math.geometry.Rotation3d< / code > < / div >
2023-03-08 23:34:33 -06:00
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > < a href = "#getRawRotation3d()" class = "member-name-link" > getRawRotation3d< / a > ()< / code > < / div >
2023-03-06 20:45:54 -06:00
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" >
2023-03-08 23:34:33 -06:00
< div class = "block" > Fetch the < code > Rotation3d< / code > from the IMU without any zeroing.< / div >
2023-03-06 20:45:54 -06:00
< / div >
2023-03-08 23:34:33 -06:00
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > edu.wpi.first.math.geometry.Rotation3d< / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > < a href = "#getRotation3d()" class = "member-name-link" > getRotation3d< / a > ()< / code > < / div >
2023-02-14 22:03:02 -06:00
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" >
2023-03-08 23:34:33 -06:00
< div class = "block" > Fetch the < code > Rotation3d< / code > from the IMU.< / div >
2023-02-14 22:03:02 -06:00
< / div >
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > void< / code > < / div >
2023-03-08 23:34:33 -06:00
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" > < code > < a href = "#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class = "member-name-link" > setOffset< / a > < wbr > (edu.wpi.first.math.geometry.Rotation3d offset)< / code > < / div >
2023-02-14 22:03:02 -06:00
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4" >
2023-03-08 23:34:33 -06:00
< div class = "block" > Set the gyro offset.< / div >
2023-02-14 22:03:02 -06:00
< / div >
< / div >
< / div >
< / div >
< div class = "inherited-list" >
< h3 id = "methods-inherited-from-class-java.lang.Object" > Methods inherited from class java.lang.< a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title = "class or interface in java.lang" class = "external-link" > Object< / a > < / h3 >
< code > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title = "class or interface in java.lang" class = "external-link" > clone< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title = "class or interface in java.lang" class = "external-link" > equals< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title = "class or interface in java.lang" class = "external-link" > finalize< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title = "class or interface in java.lang" class = "external-link" > getClass< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title = "class or interface in java.lang" class = "external-link" > hashCode< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title = "class or interface in java.lang" class = "external-link" > notify< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title = "class or interface in java.lang" class = "external-link" > notifyAll< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title = "class or interface in java.lang" class = "external-link" > toString< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title = "class or interface in java.lang" class = "external-link" > wait< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title = "class or interface in java.lang" class = "external-link" > wait< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title = "class or interface in java.lang" class = "external-link" > wait< / a > < / code > < / div >
2023-02-13 14:37:05 -06:00
< / section >
< / li >
< / ul >
2023-02-14 22:03:02 -06:00
< / section >
< section class = "details" >
< ul class = "details-list" >
2023-02-13 14:37:05 -06:00
<!-- ========= CONSTRUCTOR DETAIL ======== -->
2023-02-14 22:03:02 -06:00
< li >
< section class = "constructor-details" id = "constructor-detail" >
< h2 > Constructor Details< / h2 >
< ul class = "member-list" >
< li >
2023-02-23 21:12:29 -06:00
< section class = "detail" id = "<init>(edu.wpi.first.wpilibj.SerialPort.Port)" >
2023-02-14 22:03:02 -06:00
< h3 > NavXSwerve< / h3 >
2023-02-23 21:12:29 -06:00
< div class = "member-signature" > < span class = "modifiers" > public< / span > < span class = "element-name" > NavXSwerve< / span > < wbr > < span class = "parameters" > (edu.wpi.first.wpilibj.SerialPort.Port port)< / span > < / div >
2023-02-13 14:37:05 -06:00
< div class = "block" > Constructor for the NavX swerve.< / div >
2023-02-23 21:12:29 -06:00
< dl class = "notes" >
< dt > Parameters:< / dt >
< dd > < code > port< / code > - Serial Port to connect to.< / dd >
< / dl >
2023-02-14 22:03:02 -06:00
< / section >
2023-02-13 14:37:05 -06:00
< / li >
2023-09-01 00:21:16 -05:00
< li >
< section class = "detail" id = "<init>(edu.wpi.first.wpilibj.SPI.Port)" >
< h3 > NavXSwerve< / h3 >
< div class = "member-signature" > < span class = "modifiers" > public< / span > < span class = "element-name" > NavXSwerve< / span > < wbr > < span class = "parameters" > (edu.wpi.first.wpilibj.SPI.Port port)< / span > < / div >
< div class = "block" > Constructor for the NavX swerve.< / div >
< dl class = "notes" >
< dt > Parameters:< / dt >
< dd > < code > port< / code > - SPI Port to connect to.< / dd >
< / dl >
< / section >
< / li >
< li >
< section class = "detail" id = "<init>(edu.wpi.first.wpilibj.I2C.Port)" >
< h3 > NavXSwerve< / h3 >
< div class = "member-signature" > < span class = "modifiers" > public< / span > < span class = "element-name" > NavXSwerve< / span > < wbr > < span class = "parameters" > (edu.wpi.first.wpilibj.I2C.Port port)< / span > < / div >
< div class = "block" > Constructor for the NavX swerve.< / div >
< dl class = "notes" >
< dt > Parameters:< / dt >
< dd > < code > port< / code > - I2C Port to connect to.< / dd >
< / dl >
< / section >
< / li >
2023-02-13 14:37:05 -06:00
< / ul >
< / section >
2023-02-14 22:03:02 -06:00
< / li >
2023-02-13 14:37:05 -06:00
<!-- ============ METHOD DETAIL ========== -->
2023-02-14 22:03:02 -06:00
< li >
< section class = "method-details" id = "method-detail" >
< h2 > Method Details< / h2 >
< ul class = "member-list" >
< li >
< section class = "detail" id = "factoryDefault()" >
< h3 > factoryDefault< / h3 >
< div class = "member-signature" > < span class = "modifiers" > public< / span > < span class = "return-type" > void< / span > < span class = "element-name" > factoryDefault< / span > ()< / div >
2023-02-13 14:37:05 -06:00
< div class = "block" > Reset IMU to factory default.< / div >
2023-02-14 22:03:02 -06:00
< dl class = "notes" >
< dt > Specified by:< / dt >
2023-02-13 15:03:55 -06:00
< dd > < code > < a href = "SwerveIMU.html#factoryDefault()" > factoryDefault< / a > < / code > in class < code > < a href = "SwerveIMU.html" title = "class in swervelib.imu" > SwerveIMU< / a > < / code > < / dd >
2023-02-13 14:37:05 -06:00
< / dl >
2023-02-14 22:03:02 -06:00
< / section >
2023-02-13 14:37:05 -06:00
< / li >
2023-02-14 22:03:02 -06:00
< li >
< section class = "detail" id = "clearStickyFaults()" >
< h3 > clearStickyFaults< / h3 >
< div class = "member-signature" > < span class = "modifiers" > public< / span > < span class = "return-type" > void< / span > < span class = "element-name" > clearStickyFaults< / span > ()< / div >
2023-02-13 14:37:05 -06:00
< div class = "block" > Clear sticky faults on IMU.< / div >
2023-02-14 22:03:02 -06:00
< dl class = "notes" >
< dt > Specified by:< / dt >
2023-02-13 15:03:55 -06:00
< dd > < code > < a href = "SwerveIMU.html#clearStickyFaults()" > clearStickyFaults< / a > < / code > in class < code > < a href = "SwerveIMU.html" title = "class in swervelib.imu" > SwerveIMU< / a > < / code > < / dd >
2023-02-13 14:37:05 -06:00
< / dl >
2023-02-14 22:03:02 -06:00
< / section >
2023-02-13 14:37:05 -06:00
< / li >
2023-02-14 22:03:02 -06:00
< li >
2023-03-08 23:34:33 -06:00
< section class = "detail" id = "setOffset(edu.wpi.first.math.geometry.Rotation3d)" >
< h3 > setOffset< / h3 >
< div class = "member-signature" > < span class = "modifiers" > public< / span > < span class = "return-type" > void< / span > < span class = "element-name" > setOffset< / span > < wbr > < span class = "parameters" > (edu.wpi.first.math.geometry.Rotation3d offset)< / span > < / div >
< div class = "block" > Set the gyro offset.< / div >
2023-02-14 22:03:02 -06:00
< dl class = "notes" >
< dt > Specified by:< / dt >
2023-03-08 23:34:33 -06:00
< dd > < code > < a href = "SwerveIMU.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" > setOffset< / a > < / code > in class < code > < a href = "SwerveIMU.html" title = "class in swervelib.imu" > SwerveIMU< / a > < / code > < / dd >
2023-02-14 22:03:02 -06:00
< dt > Parameters:< / dt >
2023-03-08 23:34:33 -06:00
< dd > < code > offset< / code > - gyro offset as a < code > Rotation3d< / code > .< / dd >
2023-02-13 14:37:05 -06:00
< / dl >
2023-02-14 22:03:02 -06:00
< / section >
2023-02-13 14:37:05 -06:00
< / li >
2023-02-14 22:03:02 -06:00
< li >
2023-03-08 23:34:33 -06:00
< section class = "detail" id = "getRawRotation3d()" >
< h3 > getRawRotation3d< / h3 >
< div class = "member-signature" > < span class = "modifiers" > public< / span > < span class = "return-type" > edu.wpi.first.math.geometry.Rotation3d< / span > < span class = "element-name" > getRawRotation3d< / span > ()< / div >
< div class = "block" > Fetch the < code > Rotation3d< / code > from the IMU without any zeroing. Robot relative.< / div >
2023-02-14 22:03:02 -06:00
< dl class = "notes" >
< dt > Specified by:< / dt >
2023-03-08 23:34:33 -06:00
< dd > < code > < a href = "SwerveIMU.html#getRawRotation3d()" > getRawRotation3d< / a > < / code > in class < code > < a href = "SwerveIMU.html" title = "class in swervelib.imu" > SwerveIMU< / a > < / code > < / dd >
< dt > Returns:< / dt >
< dd > < code > Rotation3d< / code > from the IMU.< / dd >
2023-02-13 14:37:05 -06:00
< / dl >
2023-02-14 22:03:02 -06:00
< / section >
2023-02-13 14:37:05 -06:00
< / li >
2023-02-14 22:03:02 -06:00
< li >
2023-03-06 20:45:54 -06:00
< section class = "detail" id = "getRotation3d()" >
< h3 > getRotation3d< / h3 >
< div class = "member-signature" > < span class = "modifiers" > public< / span > < span class = "return-type" > edu.wpi.first.math.geometry.Rotation3d< / span > < span class = "element-name" > getRotation3d< / span > ()< / div >
< div class = "block" > Fetch the < code > Rotation3d< / code > from the IMU. Robot relative.< / div >
< dl class = "notes" >
< dt > Specified by:< / dt >
< dd > < code > < a href = "SwerveIMU.html#getRotation3d()" > getRotation3d< / a > < / code > in class < code > < a href = "SwerveIMU.html" title = "class in swervelib.imu" > SwerveIMU< / a > < / code > < / dd >
< dt > Returns:< / dt >
< dd > < code > Rotation3d< / code > from the IMU.< / dd >
< / dl >
< / section >
< / li >
< li >
< section class = "detail" id = "getAccel()" >
< h3 > getAccel< / h3 >
< div class = "member-signature" > < span class = "modifiers" > public< / span > < span class = "return-type" > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title = "class or interface in java.util" class = "external-link" > Optional< / a > < edu.wpi.first.math.geometry.Translation3d> < / span > < span class = "element-name" > getAccel< / span > ()< / div >
2023-08-29 19:59:07 -05:00
< div class = "block" > Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration isn't supported returns
empty.< / div >
2023-03-06 20:45:54 -06:00
< dl class = "notes" >
< dt > Specified by:< / dt >
< dd > < code > < a href = "SwerveIMU.html#getAccel()" > getAccel< / a > < / code > in class < code > < a href = "SwerveIMU.html" title = "class in swervelib.imu" > SwerveIMU< / a > < / code > < / dd >
< dt > Returns:< / dt >
< dd > < code > Translation3d< / code > of the acceleration as an < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title = "class or interface in java.util" class = "external-link" > < code > Optional< / code > < / a > .< / dd >
< / dl >
< / section >
< / li >
< li >
2023-02-14 22:03:02 -06:00
< section class = "detail" id = "getIMU()" >
< h3 > getIMU< / h3 >
< div class = "member-signature" > < span class = "modifiers" > public< / span > < span class = "return-type" > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title = "class or interface in java.lang" class = "external-link" > Object< / a > < / span > < span class = "element-name" > getIMU< / span > ()< / div >
2023-02-13 14:37:05 -06:00
< div class = "block" > Get the instantiated IMU object.< / div >
2023-02-14 22:03:02 -06:00
< dl class = "notes" >
< dt > Specified by:< / dt >
2023-02-13 15:03:55 -06:00
< dd > < code > < a href = "SwerveIMU.html#getIMU()" > getIMU< / a > < / code > in class < code > < a href = "SwerveIMU.html" title = "class in swervelib.imu" > SwerveIMU< / a > < / code > < / dd >
2023-02-14 22:03:02 -06:00
< dt > Returns:< / dt >
2023-02-13 14:37:05 -06:00
< dd > IMU object.< / dd >
< / dl >
2023-02-14 22:03:02 -06:00
< / section >
2023-02-13 14:37:05 -06:00
< / li >
< / ul >
< / section >
< / li >
< / ul >
2023-02-14 22:03:02 -06:00
< / section >
2023-02-13 14:37:05 -06:00
<!-- ========= END OF CLASS DATA ========= -->
2023-02-14 22:03:02 -06:00
< / main >
2023-02-13 14:37:05 -06:00
< / div >
< / div >
< / body >
< / html >