116 lines
5.7 KiB
TeX
116 lines
5.7 KiB
TeX
\hypertarget{class_b_n_o08x_rpt_gravity}{}\doxysection{BNO08x\+Rpt\+Gravity Class Reference}
|
|
\label{class_b_n_o08x_rpt_gravity}\index{BNO08xRptGravity@{BNO08xRptGravity}}
|
|
|
|
|
|
Class to represent gravity reports. (See Ref. Manual 6.\+5.\+11)
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$report/\+BNO08x\+Rpt\+Gravity.\+hpp$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for BNO08x\+Rpt\+Gravity\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=189pt]{class_b_n_o08x_rpt_gravity__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for BNO08x\+Rpt\+Gravity\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=199pt]{class_b_n_o08x_rpt_gravity__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{class_b_n_o08x_rpt_gravity_a472ced1c466461f64dda3d9132813dba}{BNO08x\+Rpt\+Gravity}} (uint8\+\_\+t \mbox{\hyperlink{class_b_n_o08x_rpt_a63cd4ac9e96baa43eebe580f03307512}{ID}}, Event\+Bits\+\_\+t \mbox{\hyperlink{class_b_n_o08x_rpt_ae78feab5682a4697c5acad3ca6f12c2e}{rpt\+\_\+bit}}, \mbox{\hyperlink{struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t}{BNO08x\+Private\+Types\+::bno08x\+\_\+sync\+\_\+ctx\+\_\+t}} $\ast$\mbox{\hyperlink{class_b_n_o08x_rpt_a5a1404a08918d66bb0f41f55220db6e5}{sync\+\_\+ctx}})
|
|
\item
|
|
bool \mbox{\hyperlink{class_b_n_o08x_rpt_gravity_a5bb33cf233c6721fac992e447bd5b571}{enable}} (uint32\+\_\+t time\+\_\+between\+\_\+reports, sh2\+\_\+\+Sensor\+Config\+\_\+t sensor\+\_\+cfg=BNO08x\+Private\+Types\+::default\+\_\+sensor\+\_\+cfg) override
|
|
\begin{DoxyCompactList}\small\item\em Enables gravity reports such that the \mbox{\hyperlink{class_b_n_o08x}{BNO08x}} begins sending them. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{structbno08x__accel__t}{bno08x\+\_\+accel\+\_\+t}} \mbox{\hyperlink{class_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115}{get}} ()
|
|
\begin{DoxyCompactList}\small\item\em Grabs most recent gravity data, units are in m/s$^\wedge$2. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsection*{Additional Inherited Members}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
Class to represent gravity reports. (See Ref. Manual 6.\+5.\+11)
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_gravity_a472ced1c466461f64dda3d9132813dba}\label{class_b_n_o08x_rpt_gravity_a472ced1c466461f64dda3d9132813dba}}
|
|
\index{BNO08xRptGravity@{BNO08xRptGravity}!BNO08xRptGravity@{BNO08xRptGravity}}
|
|
\index{BNO08xRptGravity@{BNO08xRptGravity}!BNO08xRptGravity@{BNO08xRptGravity}}
|
|
\doxysubsubsection{\texorpdfstring{BNO08xRptGravity()}{BNO08xRptGravity()}}
|
|
{\footnotesize\ttfamily BNO08x\+Rpt\+Gravity\+::\+BNO08x\+Rpt\+Gravity (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{ID, }\item[{Event\+Bits\+\_\+t}]{rpt\+\_\+bit, }\item[{\mbox{\hyperlink{struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t}{BNO08x\+Private\+Types\+::bno08x\+\_\+sync\+\_\+ctx\+\_\+t}} $\ast$}]{sync\+\_\+ctx }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_gravity_a5bb33cf233c6721fac992e447bd5b571}\label{class_b_n_o08x_rpt_gravity_a5bb33cf233c6721fac992e447bd5b571}}
|
|
\index{BNO08xRptGravity@{BNO08xRptGravity}!enable@{enable}}
|
|
\index{enable@{enable}!BNO08xRptGravity@{BNO08xRptGravity}}
|
|
\doxysubsubsection{\texorpdfstring{enable()}{enable()}}
|
|
{\footnotesize\ttfamily bool BNO08x\+Rpt\+Gravity\+::enable (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{time\+\_\+between\+\_\+reports, }\item[{sh2\+\_\+\+Sensor\+Config\+\_\+t}]{sensor\+\_\+cfg = {\ttfamily BNO08xPrivateTypes\+:\+:default\+\_\+sensor\+\_\+cfg} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Enables gravity reports such that the \mbox{\hyperlink{class_b_n_o08x}{BNO08x}} begins sending them.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em report\+\_\+period\+\_\+us} & The period/interval of the report in microseconds. \\
|
|
\hline
|
|
{\em sensor\+\_\+cfg} & Sensor special configuration (optional, see BNO08x\+Private\+Types\+::default\+\_\+sensor\+\_\+cfg for defaults).\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
True if report was successfully enabled.
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Implements \mbox{\hyperlink{class_b_n_o08x_rpt_a4ee529725467412df396d5c610ff7bb4}{BNO08x\+Rpt}}.
|
|
|
|
Here is the call graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{class_b_n_o08x_rpt_gravity_a5bb33cf233c6721fac992e447bd5b571_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115}\label{class_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115}}
|
|
\index{BNO08xRptGravity@{BNO08xRptGravity}!get@{get}}
|
|
\index{get@{get}!BNO08xRptGravity@{BNO08xRptGravity}}
|
|
\doxysubsubsection{\texorpdfstring{get()}{get()}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{structbno08x__accel__t}{bno08x\+\_\+accel\+\_\+t}} BNO08x\+Rpt\+Gravity\+::get (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Grabs most recent gravity data, units are in m/s$^\wedge$2.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Struct containing requested data.
|
|
\end{DoxyReturn}
|
|
Here is the call graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{class_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
/media/develop/git/imu\+\_\+pr\+\_\+cleanup/components/esp32\+\_\+\+BNO08x/include/report/\mbox{\hyperlink{_b_n_o08x_rpt_gravity_8hpp}{BNO08x\+Rpt\+Gravity.\+hpp}}\item
|
|
report/\mbox{\hyperlink{_b_n_o08x_rpt_gravity_8cpp}{BNO08x\+Rpt\+Gravity.\+cpp}}\end{DoxyCompactItemize}
|