esp32_BNO08x/documentation/latex/_b_n_o08x_8hpp.tex

146 lines
8.9 KiB
TeX

\doxysection{BNO08x.\+hpp File Reference}
\hypertarget{_b_n_o08x_8hpp}{}\label{_b_n_o08x_8hpp}\index{BNO08x.hpp@{BNO08x.hpp}}
{\ttfamily \#include $<$driver/gpio.\+h$>$}\newline
{\ttfamily \#include $<$driver/spi\+\_\+common.\+h$>$}\newline
{\ttfamily \#include $<$driver/spi\+\_\+master.\+h$>$}\newline
{\ttfamily \#include $<$esp\+\_\+log.\+h$>$}\newline
{\ttfamily \#include $<$esp\+\_\+rom\+\_\+gpio.\+h$>$}\newline
{\ttfamily \#include $<$esp\+\_\+timer.\+h$>$}\newline
{\ttfamily \#include $<$freertos/\+Free\+RTOS.\+h$>$}\newline
{\ttfamily \#include $<$freertos/task.\+h$>$}\newline
{\ttfamily \#include $<$freertos/event\+\_\+groups.\+h$>$}\newline
{\ttfamily \#include $<$freertos/queue.\+h$>$}\newline
{\ttfamily \#include $<$rom/ets\+\_\+sys.\+h$>$}\newline
{\ttfamily \#include $<$inttypes.\+h$>$}\newline
{\ttfamily \#include $<$math.\+h$>$}\newline
{\ttfamily \#include $<$stdio.\+h$>$}\newline
{\ttfamily \#include $<$cstring$>$}\newline
{\ttfamily \#include $<$functional$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
Include dependency graph for BNO08x.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{_b_n_o08x_8hpp__incl}
\end{center}
\end{figure}
This graph shows which files directly or indirectly include this file\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=152pt]{_b_n_o08x_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structbno08x__config__t}{bno08x\+\_\+config\+\_\+t}}
\begin{DoxyCompactList}\small\item\em IMU configuration settings passed into constructor. \end{DoxyCompactList}\item
class \mbox{\hyperlink{class_b_n_o08x}{BNO08x}}
\item
struct \mbox{\hyperlink{struct_b_n_o08x_1_1bno08x__rx__packet__t}{BNO08x\+::bno08x\+\_\+rx\+\_\+packet\+\_\+t}}
\begin{DoxyCompactList}\small\item\em Holds data that is received over spi. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{struct_b_n_o08x_1_1bno08x__tx__packet__t}{BNO08x\+::bno08x\+\_\+tx\+\_\+packet\+\_\+t}}
\begin{DoxyCompactList}\small\item\em Holds data that is sent over spi. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
typedef struct bno08x\+\_\+config\+\_\+t \mbox{\hyperlink{_b_n_o08x_8hpp_a648bbdbf22731476890dd8da977d7503}{bno08x\+\_\+config\+\_\+t}}
\begin{DoxyCompactList}\small\item\em IMU configuration settings passed into constructor. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum \mbox{\hyperlink{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556b}{channels\+\_\+t}} \{ \newline
\mbox{\hyperlink{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba1cb5955609063cff1ba49147e786e610}{CHANNEL\+\_\+\+COMMAND}}
, \mbox{\hyperlink{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba8a5de65712767758887f8fad9523bb72}{CHANNEL\+\_\+\+EXECUTABLE}}
, \mbox{\hyperlink{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba6c5ca5e5847c55b469afbb435e15b5f0}{CHANNEL\+\_\+\+CONTROL}}
, \mbox{\hyperlink{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba22f0b2ae6fcdc8618a078b0579d09e4a}{CHANNEL\+\_\+\+REPORTS}}
, \newline
\mbox{\hyperlink{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556bafbb907d12060466f58dd56d3e2430747}{CHANNEL\+\_\+\+WAKE\+\_\+\+REPORTS}}
, \mbox{\hyperlink{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556bafd513a698e54122cec579d9450482832}{CHANNEL\+\_\+\+GYRO}}
\}
\begin{DoxyCompactList}\small\item\em SHTP protocol channels. \end{DoxyCompactList}\item
enum class \mbox{\hyperlink{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279}{IMUAccuracy}} \{ \mbox{\hyperlink{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279a41bc94cbd8eebea13ce0491b2ac11b88}{LOW}} = 1
, \mbox{\hyperlink{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279a2ad6d5975c45da2e711c796f3a1b029c}{MED}}
, \mbox{\hyperlink{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279ab89de3b4b81c4facfac906edf29aec8c}{HIGH}}
\}
\begin{DoxyCompactList}\small\item\em Sensor accuracy returned during sensor calibration. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Typedef Documentation}
\Hypertarget{_b_n_o08x_8hpp_a648bbdbf22731476890dd8da977d7503}\label{_b_n_o08x_8hpp_a648bbdbf22731476890dd8da977d7503}
\index{BNO08x.hpp@{BNO08x.hpp}!bno08x\_config\_t@{bno08x\_config\_t}}
\index{bno08x\_config\_t@{bno08x\_config\_t}!BNO08x.hpp@{BNO08x.hpp}}
\doxysubsubsection{\texorpdfstring{bno08x\_config\_t}{bno08x\_config\_t}}
{\footnotesize\ttfamily typedef struct bno08x\+\_\+config\+\_\+t bno08x\+\_\+config\+\_\+t}
IMU configuration settings passed into constructor.
\doxysubsection{Enumeration Type Documentation}
\Hypertarget{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556b}\label{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556b}
\index{BNO08x.hpp@{BNO08x.hpp}!channels\_t@{channels\_t}}
\index{channels\_t@{channels\_t}!BNO08x.hpp@{BNO08x.hpp}}
\doxysubsubsection{\texorpdfstring{channels\_t}{channels\_t}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556b}{channels\+\_\+t}}}
SHTP protocol channels.
\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{CHANNEL\_COMMAND@{CHANNEL\_COMMAND}!BNO08x.hpp@{BNO08x.hpp}}\index{BNO08x.hpp@{BNO08x.hpp}!CHANNEL\_COMMAND@{CHANNEL\_COMMAND}}}\Hypertarget{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba1cb5955609063cff1ba49147e786e610}\label{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba1cb5955609063cff1ba49147e786e610}
CHANNEL\+\_\+\+COMMAND&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{CHANNEL\_EXECUTABLE@{CHANNEL\_EXECUTABLE}!BNO08x.hpp@{BNO08x.hpp}}\index{BNO08x.hpp@{BNO08x.hpp}!CHANNEL\_EXECUTABLE@{CHANNEL\_EXECUTABLE}}}\Hypertarget{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba8a5de65712767758887f8fad9523bb72}\label{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba8a5de65712767758887f8fad9523bb72}
CHANNEL\+\_\+\+EXECUTABLE&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{CHANNEL\_CONTROL@{CHANNEL\_CONTROL}!BNO08x.hpp@{BNO08x.hpp}}\index{BNO08x.hpp@{BNO08x.hpp}!CHANNEL\_CONTROL@{CHANNEL\_CONTROL}}}\Hypertarget{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba6c5ca5e5847c55b469afbb435e15b5f0}\label{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba6c5ca5e5847c55b469afbb435e15b5f0}
CHANNEL\+\_\+\+CONTROL&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{CHANNEL\_REPORTS@{CHANNEL\_REPORTS}!BNO08x.hpp@{BNO08x.hpp}}\index{BNO08x.hpp@{BNO08x.hpp}!CHANNEL\_REPORTS@{CHANNEL\_REPORTS}}}\Hypertarget{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba22f0b2ae6fcdc8618a078b0579d09e4a}\label{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556ba22f0b2ae6fcdc8618a078b0579d09e4a}
CHANNEL\+\_\+\+REPORTS&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{CHANNEL\_WAKE\_REPORTS@{CHANNEL\_WAKE\_REPORTS}!BNO08x.hpp@{BNO08x.hpp}}\index{BNO08x.hpp@{BNO08x.hpp}!CHANNEL\_WAKE\_REPORTS@{CHANNEL\_WAKE\_REPORTS}}}\Hypertarget{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556bafbb907d12060466f58dd56d3e2430747}\label{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556bafbb907d12060466f58dd56d3e2430747}
CHANNEL\+\_\+\+WAKE\+\_\+\+REPORTS&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{CHANNEL\_GYRO@{CHANNEL\_GYRO}!BNO08x.hpp@{BNO08x.hpp}}\index{BNO08x.hpp@{BNO08x.hpp}!CHANNEL\_GYRO@{CHANNEL\_GYRO}}}\Hypertarget{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556bafd513a698e54122cec579d9450482832}\label{_b_n_o08x_8hpp_aac50a1392dd0aa905500c755148c556bafd513a698e54122cec579d9450482832}
CHANNEL\+\_\+\+GYRO&\\
\hline
\end{DoxyEnumFields}
\Hypertarget{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279}\label{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279}
\index{BNO08x.hpp@{BNO08x.hpp}!IMUAccuracy@{IMUAccuracy}}
\index{IMUAccuracy@{IMUAccuracy}!BNO08x.hpp@{BNO08x.hpp}}
\doxysubsubsection{\texorpdfstring{IMUAccuracy}{IMUAccuracy}}
{\footnotesize\ttfamily enum class \mbox{\hyperlink{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279}{IMUAccuracy}}\hspace{0.3cm}{\ttfamily [strong]}}
Sensor accuracy returned during sensor calibration.
\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{LOW@{LOW}!BNO08x.hpp@{BNO08x.hpp}}\index{BNO08x.hpp@{BNO08x.hpp}!LOW@{LOW}}}\Hypertarget{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279a41bc94cbd8eebea13ce0491b2ac11b88}\label{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279a41bc94cbd8eebea13ce0491b2ac11b88}
LOW&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{MED@{MED}!BNO08x.hpp@{BNO08x.hpp}}\index{BNO08x.hpp@{BNO08x.hpp}!MED@{MED}}}\Hypertarget{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279a2ad6d5975c45da2e711c796f3a1b029c}\label{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279a2ad6d5975c45da2e711c796f3a1b029c}
MED&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{HIGH@{HIGH}!BNO08x.hpp@{BNO08x.hpp}}\index{BNO08x.hpp@{BNO08x.hpp}!HIGH@{HIGH}}}\Hypertarget{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279ab89de3b4b81c4facfac906edf29aec8c}\label{_b_n_o08x_8hpp_adb7d85b4fa619c860031f469261c6279ab89de3b4b81c4facfac906edf29aec8c}
HIGH&\\
\hline
\end{DoxyEnumFields}