511 lines
28 KiB
TeX
511 lines
28 KiB
TeX
\hypertarget{class_b_n_o08x_rpt}{}\doxysection{BNO08x\+Rpt Class Reference}
|
|
\label{class_b_n_o08x_rpt}\index{BNO08xRpt@{BNO08xRpt}}
|
|
|
|
|
|
Class to represent and manage reports returned from \mbox{\hyperlink{class_b_n_o08x}{BNO08x}}.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$report/\+BNO08x\+Rpt.\+hpp$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for BNO08x\+Rpt\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{class_b_n_o08x_rpt__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for BNO08x\+Rpt\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=199pt]{class_b_n_o08x_rpt__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
bool \mbox{\hyperlink{class_b_n_o08x_rpt_a7d147e7540a4c6aa19749844e14cdadc}{disable}} (sh2\+\_\+\+Sensor\+Config\+\_\+t sensor\+\_\+cfg=BNO08x\+Private\+Types\+::default\+\_\+sensor\+\_\+cfg)
|
|
\begin{DoxyCompactList}\small\item\em Disables a sensor report by setting its period to 0us such that the \mbox{\hyperlink{class_b_n_o08x}{BNO08x}} stops sending it. \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{class_b_n_o08x_rpt_a5b542b28c81fcd05cf2e3f3d2d437d46}{register\+\_\+cb}} (std\+::function$<$ void(void)$>$ cb\+\_\+fxn)
|
|
\begin{DoxyCompactList}\small\item\em Registers a callback to execute when new data from a specific report is received. \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{class_b_n_o08x_rpt_a74f6037286b51382535bab61680297ed}{has\+\_\+new\+\_\+data}} ()
|
|
\begin{DoxyCompactList}\small\item\em Checks if a new report has been received since the last time this function was called. \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{class_b_n_o08x_rpt_ab3bb962696b135841ef7313bc631fc72}{flush}} ()
|
|
\begin{DoxyCompactList}\small\item\em Flush all buffered reports for this sensor/report module. \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{class_b_n_o08x_rpt_a7ce8e48cadf59f49068af7f1cb680b38}{get\+\_\+sample\+\_\+counts}} (\mbox{\hyperlink{structbno08x__sample__counts__t}{bno08x\+\_\+sample\+\_\+counts\+\_\+t}} \&sample\+\_\+counts)
|
|
\begin{DoxyCompactList}\small\item\em Gets sample counts for this sensor (see SH-\/2 ref manual 6.\+4.\+3.\+1) \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{class_b_n_o08x_rpt_a1418be33824d3102dbc8f92558a402a6}{clear\+\_\+sample\+\_\+counts}} ()
|
|
\begin{DoxyCompactList}\small\item\em Clears \mbox{\hyperlink{class_b_n_o08x}{BNO08x}} internal sample counts for this sensor. (see SH-\/2 ref manual 6.\+4.\+3.\+1) \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{class_b_n_o08x_rpt_ad5b054279b01204f61b4c0408acf51cf}{get\+\_\+meta\+\_\+data}} (\mbox{\hyperlink{structbno08x__meta__data__t}{bno08x\+\_\+meta\+\_\+data\+\_\+t}} \&meta\+\_\+data)
|
|
\begin{DoxyCompactList}\small\item\em Retrieves meta data for this sensor/report by reading respective record in FRS (flash record system). \end{DoxyCompactList}\item
|
|
virtual bool \mbox{\hyperlink{class_b_n_o08x_rpt_a4ee529725467412df396d5c610ff7bb4}{enable}} (uint32\+\_\+t time\+\_\+between\+\_\+reports, sh2\+\_\+\+Sensor\+Config\+\_\+t sensor\+\_\+cfg=BNO08x\+Private\+Types\+::default\+\_\+sensor\+\_\+cfg)=0
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Protected Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
bool \mbox{\hyperlink{class_b_n_o08x_rpt_aa0bed98a9a497d1f39e8245d05b02e9c}{rpt\+\_\+enable}} (uint32\+\_\+t time\+\_\+between\+\_\+reports, sh2\+\_\+\+Sensor\+Config\+\_\+t sensor\+\_\+cfg=BNO08x\+Private\+Types\+::default\+\_\+sensor\+\_\+cfg)
|
|
\begin{DoxyCompactList}\small\item\em Enables a sensor report such that the \mbox{\hyperlink{class_b_n_o08x}{BNO08x}} begins sending it. \end{DoxyCompactList}\item
|
|
virtual void \mbox{\hyperlink{class_b_n_o08x_rpt_a970fb7e7d3745c62fec626f0ccf0759f}{update\+\_\+data}} (sh2\+\_\+\+Sensor\+Value\+\_\+t $\ast$sensor\+\_\+val)=0
|
|
\item
|
|
\mbox{\hyperlink{class_b_n_o08x_rpt_a15e8eebe3fe90ac19837e3860c76374c}{BNO08x\+Rpt}} (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}})
|
|
\begin{DoxyCompactList}\small\item\em \mbox{\hyperlink{class_b_n_o08x_rpt}{BNO08x\+Rpt}} report constructor. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{class_b_n_o08x_rpt_a61e3451e93806e1b7eaf5f1387726765}{unlock\+\_\+sh2\+\_\+\+HAL}} ()
|
|
\begin{DoxyCompactList}\small\item\em Unlocks sh2 HAL lib to allow other tasks to call its APIs. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{class_b_n_o08x_rpt_a7a5619a74c1237c5abde2e4bd6619d12}{lock\+\_\+sh2\+\_\+\+HAL}} ()
|
|
\begin{DoxyCompactList}\small\item\em Locks sh2 HAL lib to only allow the calling task to call its APIs. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{class_b_n_o08x_rpt_a26bacc572187119339ec248bb4e7d6f3}{unlock\+\_\+user\+\_\+data}} ()
|
|
\begin{DoxyCompactList}\small\item\em Unlocks user data to allow other tasks to read/modify it. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{class_b_n_o08x_rpt_a48e7b1a2c2ebc6b1f2f292735c0832a0}{lock\+\_\+user\+\_\+data}} ()
|
|
\begin{DoxyCompactList}\small\item\em Locks locks user data to only allow the calling task to read/modify it. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{class_b_n_o08x_rpt_a47a623eb0a1db51af76a03a103c32329}{signal\+\_\+data\+\_\+available}} ()
|
|
\begin{DoxyCompactList}\small\item\em Signals to \mbox{\hyperlink{class_b_n_o08x_a367d525d1c0ba119b3dca3067bb5bccc}{BNO08x\+::data\+\_\+available()}} that a new report has arrived. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsection*{Protected Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
uint8\+\_\+t \mbox{\hyperlink{class_b_n_o08x_rpt_a63cd4ac9e96baa43eebe580f03307512}{ID}}
|
|
\begin{DoxyCompactList}\small\item\em Report ID, ex. SH2\+\_\+\+ACCELERATION. \end{DoxyCompactList}\item
|
|
Event\+Bits\+\_\+t \mbox{\hyperlink{class_b_n_o08x_rpt_ae78feab5682a4697c5acad3ca6f12c2e}{rpt\+\_\+bit}}
|
|
\begin{DoxyCompactList}\small\item\em Respective enable and data bit for report in evt\+\_\+grp\+\_\+rpt\+\_\+en and evt\+\_\+grp\+\_\+rpt\+\_\+data. \end{DoxyCompactList}\item
|
|
uint32\+\_\+t \mbox{\hyperlink{class_b_n_o08x_rpt_a1d4d6f4cc6f1eae503863eedf7fb9f52}{period\+\_\+us}}
|
|
\begin{DoxyCompactList}\small\item\em The period/interval of the report in microseconds. \end{DoxyCompactList}\item
|
|
\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}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Static Protected Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
static const constexpr float \mbox{\hyperlink{class_b_n_o08x_rpt_a201aeb71fefb0d9d485914176a82dd80}{RAD\+\_\+2\+\_\+\+DEG}}
|
|
\begin{DoxyCompactList}\small\item\em Constant for radian to degree conversions, sed in quaternion to euler function conversions. \end{DoxyCompactList}\item
|
|
static const constexpr char $\ast$ \mbox{\hyperlink{class_b_n_o08x_rpt_a2c57f370fb08b793bb10ec22d5acca45}{TAG}} = \char`\"{}BNO08x\+Rpt\char`\"{}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Friends}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{class_b_n_o08x_rpt_a9313d906399750f09e3fe4dae87cec15}{BNO08x}}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
Class to represent and manage reports returned from \mbox{\hyperlink{class_b_n_o08x}{BNO08x}}.
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a15e8eebe3fe90ac19837e3860c76374c}\label{class_b_n_o08x_rpt_a15e8eebe3fe90ac19837e3860c76374c}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!BNO08xRpt@{BNO08xRpt}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{BNO08xRpt()}{BNO08xRpt()}}
|
|
{\footnotesize\ttfamily BNO08x\+Rpt\+::\+BNO08x\+Rpt (\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]}, {\ttfamily [protected]}}
|
|
|
|
|
|
|
|
\mbox{\hyperlink{class_b_n_o08x_rpt}{BNO08x\+Rpt}} report constructor.
|
|
|
|
Construct a \mbox{\hyperlink{class_b_n_o08x_rpt}{BNO08x\+Rpt}} object for managing a \mbox{\hyperlink{class_b_n_o08x}{BNO08x}} sensor report.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em imu} & Pointer to \mbox{\hyperlink{class_b_n_o08x}{BNO08x}} imu object. \\
|
|
\hline
|
|
{\em report\+\_\+\+ID} & Report ID, ex. SH2\+\_\+\+ACCELERATION. \\
|
|
\hline
|
|
{\em rpt\+\_\+bit} & Respective enable bit for report in BNO08x\+::evt\+\_\+grp\+\_\+report\+\_\+en. \\
|
|
\hline
|
|
{\em period\+\_\+us} & The period/interval of the report in microseconds.\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
void, nothing to return
|
|
\end{DoxyReturn}
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a1418be33824d3102dbc8f92558a402a6}\label{class_b_n_o08x_rpt_a1418be33824d3102dbc8f92558a402a6}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!clear\_sample\_counts@{clear\_sample\_counts}}
|
|
\index{clear\_sample\_counts@{clear\_sample\_counts}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{clear\_sample\_counts()}{clear\_sample\_counts()}}
|
|
{\footnotesize\ttfamily bool BNO08x\+Rpt\+::clear\+\_\+sample\+\_\+counts (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Clears \mbox{\hyperlink{class_b_n_o08x}{BNO08x}} internal sample counts for this sensor. (see SH-\/2 ref manual 6.\+4.\+3.\+1)
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
True clear counts operation succeeded.
|
|
\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_a1418be33824d3102dbc8f92558a402a6_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a7d147e7540a4c6aa19749844e14cdadc}\label{class_b_n_o08x_rpt_a7d147e7540a4c6aa19749844e14cdadc}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!disable@{disable}}
|
|
\index{disable@{disable}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{disable()}{disable()}}
|
|
{\footnotesize\ttfamily bool BNO08x\+Rpt\+::disable (\begin{DoxyParamCaption}\item[{sh2\+\_\+\+Sensor\+Config\+\_\+t}]{sensor\+\_\+cfg = {\ttfamily BNO08xPrivateTypes\+:\+:default\+\_\+sensor\+\_\+cfg} }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Disables a sensor report by setting its period to 0us such that the \mbox{\hyperlink{class_b_n_o08x}{BNO08x}} stops sending it.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em sensor\+\_\+\+ID} & The ID of the sensor for the respective report to be disabled. \\
|
|
\hline
|
|
{\em sensor\+\_\+cfg} & Sensor special configuration.\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
ESP\+\_\+\+OK if report was successfully disabled.
|
|
\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_a7d147e7540a4c6aa19749844e14cdadc_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a4ee529725467412df396d5c610ff7bb4}\label{class_b_n_o08x_rpt_a4ee529725467412df396d5c610ff7bb4}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!enable@{enable}}
|
|
\index{enable@{enable}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{enable()}{enable()}}
|
|
{\footnotesize\ttfamily virtual bool BNO08x\+Rpt\+::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 [pure virtual]}}
|
|
|
|
|
|
|
|
Implemented in \mbox{\hyperlink{class_b_n_o08x_rpt_acceleration_a8fde5eefac5f9d714263047426eeee4f}{BNO08x\+Rpt\+Acceleration}}, \mbox{\hyperlink{class_b_n_o08x_rpt_activity_classifier_a631329523ddaf17f2e93cd0546a42823}{BNO08x\+Rpt\+Activity\+Classifier}}, \mbox{\hyperlink{class_b_n_o08x_rpt_cal_gyro_aeb49d86610427c915dc9e58fcba6fddc}{BNO08x\+Rpt\+Cal\+Gyro}}, \mbox{\hyperlink{class_b_n_o08x_rpt_cal_magnetometer_a9a371f613ff5053d2227faeebe941393}{BNO08x\+Rpt\+Cal\+Magnetometer}}, \mbox{\hyperlink{class_b_n_o08x_rpt_gravity_a5bb33cf233c6721fac992e447bd5b571}{BNO08x\+Rpt\+Gravity}}, \mbox{\hyperlink{class_b_n_o08x_rpt_linear_acceleration_a4584a181ae543919a851f8f288a316ed}{BNO08x\+Rpt\+Linear\+Acceleration}}, \mbox{\hyperlink{class_b_n_o08x_rpt_raw_m_e_m_s_accelerometer_a3cfc735c048700fe79a5674ad92b4b03}{BNO08x\+Rpt\+Raw\+MEMSAccelerometer}}, \mbox{\hyperlink{class_b_n_o08x_rpt_raw_m_e_m_s_gyro_ae872f24befd81352f812bc998acb573d}{BNO08x\+Rpt\+Raw\+MEMSGyro}}, \mbox{\hyperlink{class_b_n_o08x_rpt_raw_m_e_m_s_magnetometer_a92832fd0bff6abddbbd87779de5b57fb}{BNO08x\+Rpt\+Raw\+MEMSMagnetometer}}, \mbox{\hyperlink{class_b_n_o08x_rpt_r_v_generic_a17c6cf89a5f7bf5c3fb9f8ff3ed74e8e}{BNO08x\+Rpt\+RVGeneric}}, \mbox{\hyperlink{class_b_n_o08x_rpt_shake_detector_aa28fa73b51bd892f0239e647aa6ceeb8}{BNO08x\+Rpt\+Shake\+Detector}}, \mbox{\hyperlink{class_b_n_o08x_rpt_stability_classifier_a4959110a01f638d04d87696d8a03dd60}{BNO08x\+Rpt\+Stability\+Classifier}}, \mbox{\hyperlink{class_b_n_o08x_rpt_step_counter_adf0a697561b064a7dd90a44009efbcf1}{BNO08x\+Rpt\+Step\+Counter}}, \mbox{\hyperlink{class_b_n_o08x_rpt_tap_detector_ad8b716b7a2f2c2f52113eaaf75a391dc}{BNO08x\+Rpt\+Tap\+Detector}}, \mbox{\hyperlink{class_b_n_o08x_rpt_uncal_gyro_a404d36091a61af543c6fec7b6e077706}{BNO08x\+Rpt\+Uncal\+Gyro}}, and \mbox{\hyperlink{class_b_n_o08x_rpt_uncal_magnetometer_a80ae48107ca1cc27551fd799625f2867}{BNO08x\+Rpt\+Uncal\+Magnetometer}}.
|
|
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_ab3bb962696b135841ef7313bc631fc72}\label{class_b_n_o08x_rpt_ab3bb962696b135841ef7313bc631fc72}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!flush@{flush}}
|
|
\index{flush@{flush}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{flush()}{flush()}}
|
|
{\footnotesize\ttfamily bool BNO08x\+Rpt\+::flush (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Flush all buffered reports for this sensor/report module.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
True if flush operation succeeded.
|
|
\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_ab3bb962696b135841ef7313bc631fc72_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_ad5b054279b01204f61b4c0408acf51cf}\label{class_b_n_o08x_rpt_ad5b054279b01204f61b4c0408acf51cf}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!get\_meta\_data@{get\_meta\_data}}
|
|
\index{get\_meta\_data@{get\_meta\_data}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{get\_meta\_data()}{get\_meta\_data()}}
|
|
{\footnotesize\ttfamily bool BNO08x\+Rpt\+::get\+\_\+meta\+\_\+data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structbno08x__meta__data__t}{bno08x\+\_\+meta\+\_\+data\+\_\+t}} \&}]{meta\+\_\+data }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Retrieves meta data for this sensor/report by reading respective record in FRS (flash record system).
|
|
|
|
Can be used to retrieve the minimum period, maximum period, actual Q points, resolution, and other info for a given sensor.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
True clear get meta data operation succeeded.
|
|
\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_ad5b054279b01204f61b4c0408acf51cf_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a7ce8e48cadf59f49068af7f1cb680b38}\label{class_b_n_o08x_rpt_a7ce8e48cadf59f49068af7f1cb680b38}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!get\_sample\_counts@{get\_sample\_counts}}
|
|
\index{get\_sample\_counts@{get\_sample\_counts}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{get\_sample\_counts()}{get\_sample\_counts()}}
|
|
{\footnotesize\ttfamily bool BNO08x\+Rpt\+::get\+\_\+sample\+\_\+counts (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structbno08x__sample__counts__t}{bno08x\+\_\+sample\+\_\+counts\+\_\+t}} \&}]{sample\+\_\+counts }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Gets sample counts for this sensor (see SH-\/2 ref manual 6.\+4.\+3.\+1)
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em Struct} & to store requested data.\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
True get counts operation succeeded.
|
|
\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_a7ce8e48cadf59f49068af7f1cb680b38_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a74f6037286b51382535bab61680297ed}\label{class_b_n_o08x_rpt_a74f6037286b51382535bab61680297ed}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!has\_new\_data@{has\_new\_data}}
|
|
\index{has\_new\_data@{has\_new\_data}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{has\_new\_data()}{has\_new\_data()}}
|
|
{\footnotesize\ttfamily bool BNO08x\+Rpt\+::has\+\_\+new\+\_\+data (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Checks if a new report has been received since the last time this function was called.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
True if a new report was received since the last time this function was called.
|
|
\end{DoxyReturn}
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{class_b_n_o08x_rpt_a74f6037286b51382535bab61680297ed_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a7a5619a74c1237c5abde2e4bd6619d12}\label{class_b_n_o08x_rpt_a7a5619a74c1237c5abde2e4bd6619d12}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!lock\_sh2\_HAL@{lock\_sh2\_HAL}}
|
|
\index{lock\_sh2\_HAL@{lock\_sh2\_HAL}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{lock\_sh2\_HAL()}{lock\_sh2\_HAL()}}
|
|
{\footnotesize\ttfamily void BNO08x\+Rpt\+::lock\+\_\+sh2\+\_\+\+HAL (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
|
|
|
|
Locks sh2 HAL lib to only allow the calling task to call its APIs.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
void, nothing to return
|
|
\end{DoxyReturn}
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{class_b_n_o08x_rpt_a7a5619a74c1237c5abde2e4bd6619d12_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a48e7b1a2c2ebc6b1f2f292735c0832a0}\label{class_b_n_o08x_rpt_a48e7b1a2c2ebc6b1f2f292735c0832a0}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!lock\_user\_data@{lock\_user\_data}}
|
|
\index{lock\_user\_data@{lock\_user\_data}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{lock\_user\_data()}{lock\_user\_data()}}
|
|
{\footnotesize\ttfamily void BNO08x\+Rpt\+::lock\+\_\+user\+\_\+data (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
|
|
|
|
Locks locks user data to only allow the calling task to read/modify it.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
void, nothing to return
|
|
\end{DoxyReturn}
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=550pt]{class_b_n_o08x_rpt_a48e7b1a2c2ebc6b1f2f292735c0832a0_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a5b542b28c81fcd05cf2e3f3d2d437d46}\label{class_b_n_o08x_rpt_a5b542b28c81fcd05cf2e3f3d2d437d46}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!register\_cb@{register\_cb}}
|
|
\index{register\_cb@{register\_cb}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{register\_cb()}{register\_cb()}}
|
|
{\footnotesize\ttfamily bool BNO08x\+Rpt\+::register\+\_\+cb (\begin{DoxyParamCaption}\item[{std\+::function$<$ void(void)$>$}]{cb\+\_\+fxn }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Registers a callback to execute when new data from a specific report is received.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em cb\+\_\+fxn} & Pointer to the call-\/back function should be of void return type void input param.\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
void, nothing to return
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_aa0bed98a9a497d1f39e8245d05b02e9c}\label{class_b_n_o08x_rpt_aa0bed98a9a497d1f39e8245d05b02e9c}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!rpt\_enable@{rpt\_enable}}
|
|
\index{rpt\_enable@{rpt\_enable}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{rpt\_enable()}{rpt\_enable()}}
|
|
{\footnotesize\ttfamily bool BNO08x\+Rpt\+::rpt\+\_\+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 [protected]}}
|
|
|
|
|
|
|
|
Enables a sensor report such that the \mbox{\hyperlink{class_b_n_o08x}{BNO08x}} begins sending it.
|
|
|
|
|
|
\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}
|
|
Here is the call graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{class_b_n_o08x_rpt_aa0bed98a9a497d1f39e8245d05b02e9c_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{class_b_n_o08x_rpt_aa0bed98a9a497d1f39e8245d05b02e9c_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a47a623eb0a1db51af76a03a103c32329}\label{class_b_n_o08x_rpt_a47a623eb0a1db51af76a03a103c32329}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!signal\_data\_available@{signal\_data\_available}}
|
|
\index{signal\_data\_available@{signal\_data\_available}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{signal\_data\_available()}{signal\_data\_available()}}
|
|
{\footnotesize\ttfamily void BNO08x\+Rpt\+::signal\+\_\+data\+\_\+available (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
|
|
|
|
Signals to \mbox{\hyperlink{class_b_n_o08x_a367d525d1c0ba119b3dca3067bb5bccc}{BNO08x\+::data\+\_\+available()}} that a new report has arrived.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
void, nothing to return
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a61e3451e93806e1b7eaf5f1387726765}\label{class_b_n_o08x_rpt_a61e3451e93806e1b7eaf5f1387726765}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!unlock\_sh2\_HAL@{unlock\_sh2\_HAL}}
|
|
\index{unlock\_sh2\_HAL@{unlock\_sh2\_HAL}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{unlock\_sh2\_HAL()}{unlock\_sh2\_HAL()}}
|
|
{\footnotesize\ttfamily void BNO08x\+Rpt\+::unlock\+\_\+sh2\+\_\+\+HAL (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
|
|
|
|
Unlocks sh2 HAL lib to allow other tasks to call its APIs.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
void, nothing to return
|
|
\end{DoxyReturn}
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{class_b_n_o08x_rpt_a61e3451e93806e1b7eaf5f1387726765_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a26bacc572187119339ec248bb4e7d6f3}\label{class_b_n_o08x_rpt_a26bacc572187119339ec248bb4e7d6f3}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!unlock\_user\_data@{unlock\_user\_data}}
|
|
\index{unlock\_user\_data@{unlock\_user\_data}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{unlock\_user\_data()}{unlock\_user\_data()}}
|
|
{\footnotesize\ttfamily void BNO08x\+Rpt\+::unlock\+\_\+user\+\_\+data (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
|
|
|
|
Unlocks user data to allow other tasks to read/modify it.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
void, nothing to return
|
|
\end{DoxyReturn}
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=550pt]{class_b_n_o08x_rpt_a26bacc572187119339ec248bb4e7d6f3_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a970fb7e7d3745c62fec626f0ccf0759f}\label{class_b_n_o08x_rpt_a970fb7e7d3745c62fec626f0ccf0759f}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!update\_data@{update\_data}}
|
|
\index{update\_data@{update\_data}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{update\_data()}{update\_data()}}
|
|
{\footnotesize\ttfamily virtual void BNO08x\+Rpt\+::update\+\_\+data (\begin{DoxyParamCaption}\item[{sh2\+\_\+\+Sensor\+Value\+\_\+t $\ast$}]{sensor\+\_\+val }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [pure virtual]}}
|
|
|
|
|
|
|
|
\doxysubsection{Friends And Related Function Documentation}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a9313d906399750f09e3fe4dae87cec15}\label{class_b_n_o08x_rpt_a9313d906399750f09e3fe4dae87cec15}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!BNO08x@{BNO08x}}
|
|
\index{BNO08x@{BNO08x}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{BNO08x}{BNO08x}}
|
|
{\footnotesize\ttfamily friend class \mbox{\hyperlink{class_b_n_o08x}{BNO08x}}\hspace{0.3cm}{\ttfamily [friend]}}
|
|
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a63cd4ac9e96baa43eebe580f03307512}\label{class_b_n_o08x_rpt_a63cd4ac9e96baa43eebe580f03307512}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!ID@{ID}}
|
|
\index{ID@{ID}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{ID}{ID}}
|
|
{\footnotesize\ttfamily uint8\+\_\+t BNO08x\+Rpt\+::\+ID\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
|
|
|
|
Report ID, ex. SH2\+\_\+\+ACCELERATION.
|
|
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a1d4d6f4cc6f1eae503863eedf7fb9f52}\label{class_b_n_o08x_rpt_a1d4d6f4cc6f1eae503863eedf7fb9f52}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!period\_us@{period\_us}}
|
|
\index{period\_us@{period\_us}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{period\_us}{period\_us}}
|
|
{\footnotesize\ttfamily uint32\+\_\+t BNO08x\+Rpt\+::period\+\_\+us\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
|
|
|
|
The period/interval of the report in microseconds.
|
|
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a201aeb71fefb0d9d485914176a82dd80}\label{class_b_n_o08x_rpt_a201aeb71fefb0d9d485914176a82dd80}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!RAD\_2\_DEG@{RAD\_2\_DEG}}
|
|
\index{RAD\_2\_DEG@{RAD\_2\_DEG}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{RAD\_2\_DEG}{RAD\_2\_DEG}}
|
|
{\footnotesize\ttfamily const constexpr float BNO08x\+Rpt\+::\+RAD\+\_\+2\+\_\+\+DEG\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [constexpr]}, {\ttfamily [protected]}}
|
|
|
|
{\bfseries Initial value\+:}
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{=}
|
|
\DoxyCodeLine{ (180.0f / M\_PI)}
|
|
|
|
\end{DoxyCode}
|
|
|
|
|
|
Constant for radian to degree conversions, sed in quaternion to euler function conversions.
|
|
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_ae78feab5682a4697c5acad3ca6f12c2e}\label{class_b_n_o08x_rpt_ae78feab5682a4697c5acad3ca6f12c2e}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!rpt\_bit@{rpt\_bit}}
|
|
\index{rpt\_bit@{rpt\_bit}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{rpt\_bit}{rpt\_bit}}
|
|
{\footnotesize\ttfamily Event\+Bits\+\_\+t BNO08x\+Rpt\+::rpt\+\_\+bit\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
|
|
|
|
Respective enable and data bit for report in evt\+\_\+grp\+\_\+rpt\+\_\+en and evt\+\_\+grp\+\_\+rpt\+\_\+data.
|
|
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a5a1404a08918d66bb0f41f55220db6e5}\label{class_b_n_o08x_rpt_a5a1404a08918d66bb0f41f55220db6e5}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!sync\_ctx@{sync\_ctx}}
|
|
\index{sync\_ctx@{sync\_ctx}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{sync\_ctx}{sync\_ctx}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t}{BNO08x\+Private\+Types\+::bno08x\+\_\+sync\+\_\+ctx\+\_\+t}}$\ast$ BNO08x\+Rpt\+::sync\+\_\+ctx\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
\mbox{\Hypertarget{class_b_n_o08x_rpt_a2c57f370fb08b793bb10ec22d5acca45}\label{class_b_n_o08x_rpt_a2c57f370fb08b793bb10ec22d5acca45}}
|
|
\index{BNO08xRpt@{BNO08xRpt}!TAG@{TAG}}
|
|
\index{TAG@{TAG}!BNO08xRpt@{BNO08xRpt}}
|
|
\doxysubsubsection{\texorpdfstring{TAG}{TAG}}
|
|
{\footnotesize\ttfamily const constexpr char$\ast$ BNO08x\+Rpt\+::\+TAG = \char`\"{}BNO08x\+Rpt\char`\"{}\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [constexpr]}, {\ttfamily [protected]}}
|
|
|
|
|
|
|
|
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_8hpp}{BNO08x\+Rpt.\+hpp}}\item
|
|
\mbox{\hyperlink{_b_n_o08x_rpt_8cpp}{BNO08x\+Rpt.\+cpp}}\end{DoxyCompactItemize}
|