esp32_BNO08x/documentation/latex/annotated.tex

56 lines
12 KiB
TeX
Raw Normal View History

2024-12-06 04:09:30 +00:00
\doxysection{Class List}
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x}{BNO08x}} \\*\doxylink{class_b_n_o08x}{BNO08x} IMU driver class }{\pageref{class_b_n_o08x}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__accel__t}{bno08x\+\_\+accel\+\_\+t}} \\*Struct to represent acceleration data from acceleration, linear acceleration, and gravity reports }{\pageref{structbno08x__accel__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__activity__classifier__t}{bno08x\+\_\+activity\+\_\+classifier\+\_\+t}} \\*Struct to represent activity classifier data }{\pageref{structbno08x__activity__classifier__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__ang__vel__t}{bno08x\+\_\+ang\+\_\+vel\+\_\+t}} \\*Struct to represent angular velocity (units in rad/s) }{\pageref{structbno08x__ang__vel__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__config__t}{bno08x\+\_\+config\+\_\+t}} \\*IMU configuration settings passed into constructor }{\pageref{structbno08x__config__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__euler__angle__t}{bno08x\+\_\+euler\+\_\+angle\+\_\+t}} \\*Struct to represent euler angle (units in degrees or rads) }{\pageref{structbno08x__euler__angle__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__gyro__bias__t}{bno08x\+\_\+gyro\+\_\+bias\+\_\+t}} \\*Struct to represent gyro bias data (units in rad/s) }{\pageref{structbno08x__gyro__bias__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__gyro__t}{bno08x\+\_\+gyro\+\_\+t}} \\*Struct to represent gyro data (units in rad/s) }{\pageref{structbno08x__gyro__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{struct_b_n_o08x_private_types_1_1bno08x__init__status__t}{BNO08x\+Private\+Types\+::bno08x\+\_\+init\+\_\+status\+\_\+t}} \\*Holds info about which functionality has been successfully initialized (used by deconstructor during cleanup) }{\pageref{struct_b_n_o08x_private_types_1_1bno08x__init__status__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__magf__bias__t}{bno08x\+\_\+magf\+\_\+bias\+\_\+t}} \\*Struct to represent magnetic field bias data (units in u\+Tesla) }{\pageref{structbno08x__magf__bias__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__magf__t}{bno08x\+\_\+magf\+\_\+t}} \\*Struct to represent magnetic field data (units in u\+Tesla) }{\pageref{structbno08x__magf__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__meta__data__t}{bno08x\+\_\+meta\+\_\+data\+\_\+t}} \\*Struct to represent sensor/report meta data, returned from \doxylink{class_b_n_o08x_rpt_ad5b054279b01204f61b4c0408acf51cf}{BNO08x\+Rpt\+::get\+\_\+meta\+\_\+data()} }{\pageref{structbno08x__meta__data__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__quat__t}{bno08x\+\_\+quat\+\_\+t}} \\*Struct to represent unit quaternion }{\pageref{structbno08x__quat__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__raw__accel__t}{bno08x\+\_\+raw\+\_\+accel\+\_\+t}} \\*Struct to represent raw mems accelerometer data from raw accelerometer reports (units in ADC counts) }{\pageref{structbno08x__raw__accel__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__raw__gyro__t}{bno08x\+\_\+raw\+\_\+gyro\+\_\+t}} \\*Struct to represent raw mems gyro data from raw gyro reports (units in ADC counts) }{\pageref{structbno08x__raw__gyro__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__raw__magf__t}{bno08x\+\_\+raw\+\_\+magf\+\_\+t}} \\*Struct to represent raw mems magnetometer data from raw magnetometer reports (units in ADC counts) }{\pageref{structbno08x__raw__magf__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{struct_b_n_o08x_1_1bno08x__reports__t}{BNO08x\+::bno08x\+\_\+reports\+\_\+t}} \\*Contains report implementations }{\pageref{struct_b_n_o08x_1_1bno08x__reports__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__sample__counts__t}{bno08x\+\_\+sample\+\_\+counts\+\_\+t}} \\*Struct to represent sample counts, returned from \doxylink{class_b_n_o08x_rpt_a7ce8e48cadf59f49068af7f1cb680b38}{BNO08x\+Rpt\+::get\+\_\+sample\+\_\+counts()} }{\pageref{structbno08x__sample__counts__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__shake__detector__t}{bno08x\+\_\+shake\+\_\+detector\+\_\+t}} \\*Struct to represent shake detector data (flag meaning\+: 0 = no shake 1 = shake detected) }{\pageref{structbno08x__shake__detector__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__stability__classifier__t}{bno08x\+\_\+stability\+\_\+classifier\+\_\+t}} \\*Struct to represent stability classifier data from stability classifier reports }{\pageref{structbno08x__stability__classifier__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__step__counter__t}{bno08x\+\_\+step\+\_\+counter\+\_\+t}} \\*Struct to represent step counter data from step counter reports }{\pageref{structbno08x__step__counter__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t}{BNO08x\+Private\+Types\+::bno08x\+\_\+sync\+\_\+ctx\+\_\+t}} \\*Holds context used to synchronize tasks and callback execution }{\pageref{struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{structbno08x__tap__detector__t}{bno08x\+\_\+tap\+\_\+detector\+\_\+t}} \\*Struct to represent tap detector data (flag meaning\+: 0 = no tap, 1 = positive tap on axis, -\/1 = negative tap on axis) }{\pageref{structbno08x__tap__detector__t}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_cb_generic}{BNO08x\+Cb\+Generic}} \\*Parent class to represent callback functions as generic type such that all flavors can be invoked by single type }{\pageref{class_b_n_o08x_cb_generic}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_cb_param_rpt_i_d}{BNO08x\+Cb\+Param\+Rpt\+ID}} \\*Class to hold callback functions which are passed report ID as input parameter }{\pageref{class_b_n_o08x_cb_param_rpt_i_d}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_cb_param_void}{BNO08x\+Cb\+Param\+Void}} }{\pageref{class_b_n_o08x_cb_param_void}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt}{BNO08x\+Rpt}} \\*Class to represent and manage reports returned from \doxylink{class_b_n_o08x}{BNO08x} }{\pageref{class_b_n_o08x_rpt}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_acceleration}{BNO08x\+Rpt\+Acceleration}} \\*Class to represent accelerometer reports. (See Ref. Manual 6.\+5.\+9) }{\pageref{class_b_n_o08x_rpt_acceleration}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_activity_classifier}{BNO08x\+Rpt\+Activity\+Classifier}} \\*Class to represent activity classifier reports. (See Ref. Manual 6.\+5.\+36) }{\pageref{class_b_n_o08x_rpt_activity_classifier}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_a_r_v_r_stabilized_game_r_v}{BNO08x\+Rpt\+ARVRStabilized\+Game\+RV}} \\*Class to represent ARVR stabilized rotation vector reports. (See Ref. Manual 6.\+5.\+43) }{\pageref{class_b_n_o08x_rpt_a_r_v_r_stabilized_game_r_v}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_a_r_v_r_stabilized_r_v}{BNO08x\+Rpt\+ARVRStabilized\+RV}} \\*Class to represent ARVR stabilized rotation vector reports. (See Ref. Manual 6.\+5.\+42) }{\pageref{class_b_n_o08x_rpt_a_r_v_r_stabilized_r_v}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_cal_gyro}{BNO08x\+Rpt\+Cal\+Gyro}} \\*Class to represent calibrated gyro reports. (See Ref. Manual 6.\+5.\+13) }{\pageref{class_b_n_o08x_rpt_cal_gyro}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_cal_magnetometer}{BNO08x\+Rpt\+Cal\+Magnetometer}} \\*Class to represent calibrated magnetometer reports. (See Ref. Manual 6.\+5.\+16) }{\pageref{class_b_n_o08x_rpt_cal_magnetometer}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_game_r_v}{BNO08x\+Rpt\+Game\+RV}} \\*Class to represent game rotation vector reports. (See Ref. Manual 6.\+5.\+19) }{\pageref{class_b_n_o08x_rpt_game_r_v}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_gravity}{BNO08x\+Rpt\+Gravity}} \\*Class to represent gravity reports. (See Ref. Manual 6.\+5.\+11) }{\pageref{class_b_n_o08x_rpt_gravity}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_i_gyro_r_v}{BNO08x\+Rpt\+IGyro\+RV}} \\*Class to represent integrated gyro rotation vector reports. (See Ref. Manual 6.\+5.\+44) }{\pageref{class_b_n_o08x_rpt_i_gyro_r_v}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_linear_acceleration}{BNO08x\+Rpt\+Linear\+Acceleration}} \\*Class to represent linear accelerometer reports. (See Ref. Manual 6.\+5.\+10) }{\pageref{class_b_n_o08x_rpt_linear_acceleration}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_raw_m_e_m_s_accelerometer}{BNO08x\+Rpt\+Raw\+MEMSAccelerometer}} \\*Class to represent raw accelerometer reports. (See Ref. Manual 6.\+5.\+8) }{\pageref{class_b_n_o08x_rpt_raw_m_e_m_s_accelerometer}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_raw_m_e_m_s_gyro}{BNO08x\+Rpt\+Raw\+MEMSGyro}} \\*Class to represent raw gyro reports. (See Ref. Manual 6.\+5.\+12) }{\pageref{class_b_n_o08x_rpt_raw_m_e_m_s_gyro}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_raw_m_e_m_s_magnetometer}{BNO08x\+Rpt\+Raw\+MEMSMagnetometer}} \\*Class to represent raw magnetometer reports. (See Ref. Manual 6.\+5.\+15) }{\pageref{class_b_n_o08x_rpt_raw_m_e_m_s_magnetometer}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_r_v}{BNO08x\+Rpt\+RV}} \\*Class to represent rotation vector reports. (See Ref. Manual 6.\+5.\+18) }{\pageref{class_b_n_o08x_rpt_r_v}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_r_v_generic}{BNO08x\+Rpt\+RVGeneric}} \\*Class to represent rotation vector reports }{\pageref{class_b_n_o08x_rpt_r_v_generic}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_r_v_geomag}{BNO08x\+Rpt\+RVGeomag}} \\*Class to represent geomagnetic rotation vector reports. (See Ref. Manual 6.\+5.\+20) }{\pageref{class_b_n_o08x_rpt_r_v_geomag}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_shake_detector}{BNO08x\+Rpt\+Shake\+Detector}} \\*Class to represent shake detector reports. (See Ref. Manual 6.\+5.\+32) }{\pageref{class_b_n_o08x_rpt_shake_detector}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_stability_classifier}{BNO08x\+Rpt\+Stability\+Classifier}} \\*Class to represent stability classifier reports. (See Ref. Manual 6.\+5.\+31) }{\pageref{class_b_n_o08x_rpt_stability_classifier}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_step_counter}{BNO08x\+Rpt\+Step\+Counter}} \\*Class to represent step counter reports. (See Ref. Manual 6.\+5.\+29) }{\pageref{class_b_n_o08x_rpt_step_counter}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_tap_detector}{BNO08x\+Rpt\+Tap\+Detector}} \\*Class to represent tap detector reports. (See Ref. Manual 6.\+5.\+27) }{\pageref{class_b_n_o08x_rpt_tap_detector}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_uncal_gyro}{BNO08x\+Rpt\+Uncal\+Gyro}} \\*Class to represent uncalibrated gyro reports. (See Ref. Manual 6.\+5.\+14) }{\pageref{class_b_n_o08x_rpt_uncal_gyro}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_rpt_uncal_magnetometer}{BNO08x\+Rpt\+Uncal\+Magnetometer}} \\*Class to represent uncalibrated magnetometer reports. (See Ref. Manual 6.\+5.\+17) }{\pageref{class_b_n_o08x_rpt_uncal_magnetometer}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_s_h2_h_a_l}{BNO08x\+SH2\+HAL}} \\*Fully static class containing callback implementations for sh2 HAL lib }{\pageref{class_b_n_o08x_s_h2_h_a_l}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_test_helper}{BNO08x\+Test\+Helper}} \\*\doxylink{class_b_n_o08x}{BNO08x} unit test helper class }{\pageref{class_b_n_o08x_test_helper}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_b_n_o08x_test_suite}{BNO08x\+Test\+Suite}} \\*\doxylink{class_b_n_o08x}{BNO08x} unit test launch point class }{\pageref{class_b_n_o08x_test_suite}}{}
\end{DoxyCompactList}