esp32_BNO08x/documentation/html/class_b_n_o08x_aea8e2c6dd7a...

102 lines
18 KiB
Plaintext

<map id="BNO08x::initialize" name="BNO08x::initialize">
<area shape="rect" id="Node000001" title="Initializes BNO08x sensor." alt="" coords="5,321,131,348"/>
<area shape="rect" id="Node000002" href="$class_b_n_o08x.html#a96d47dd0f9aedfbe3f731f8ae76b2e85" title="Requests product ID, prints the returned info over serial, and returns the reason for the most resent..." alt="" coords="179,151,357,177"/>
<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="74,320,113,259,142,224,177,193,196,181,199,186,180,197,146,227,117,262,79,322"/>
<area shape="rect" id="Node000007" href="$class_b_n_o08x.html#a28cd1c0b3477571d87133234e6358503" title="Hard resets BNO08x sensor." alt="" coords="198,207,338,233"/>
<area shape="poly" id="edge6_Node000001_Node000007" title=" " alt="" coords="84,319,125,286,177,252,210,237,212,242,180,257,128,291,87,323"/>
<area shape="rect" id="Node000009" href="$class_b_n_o08x.html#a589eb9780f5bf613bbd447ef5b9ade3d" title="Initializes required esp&#45;idf SPI data structures with values from user passed bno08x_config_t struct." alt="" coords="184,267,352,293"/>
<area shape="poly" id="edge8_Node000001_Node000009" title=" " alt="" coords="119,318,201,295,202,301,120,323"/>
<area shape="rect" id="Node000011" href="$class_b_n_o08x.html#ae0dab25557befcf62bf384fdc241ef10" title="Initializes required gpio." alt="" coords="205,321,331,348"/>
<area shape="poly" id="edge10_Node000001_Node000011" title=" " alt="" coords="131,332,189,332,189,337,131,337"/>
<area shape="rect" id="Node000014" href="$class_b_n_o08x.html#aa27026da2c52b4aca49b78863f10ec61" title="Initializes host interrupt ISR." alt="" coords="196,372,340,399"/>
<area shape="poly" id="edge13_Node000001_Node000014" title=" " alt="" coords="124,346,198,365,197,370,123,351"/>
<area shape="rect" id="Node000016" href="$class_b_n_o08x.html#a58f43c8bb1e7fe8560ce442d46240e81" title="Initializes SPI." alt="" coords="208,423,328,449"/>
<area shape="poly" id="edge15_Node000001_Node000016" title=" " alt="" coords="87,346,128,377,180,408,195,415,193,420,177,413,125,382,84,351"/>
<area shape="rect" id="Node000017" href="$class_b_n_o08x.html#a06f99a6b2182b49a0e61e2107f2be6be" title="Launches spi_task and data_proc_task on constructor call." alt="" coords="190,481,346,508"/>
<area shape="poly" id="edge16_Node000001_Node000017" title=" " alt="" coords="80,347,119,401,148,432,180,459,205,473,202,477,177,464,144,436,115,404,76,350"/>
<area shape="rect" id="Node000003" href="$class_b_n_o08x.html#ab5f200069a2f8cb74cb79c6f162da5a1" title="Queues a packet containing the request product ID command." alt="" coords="421,36,584,79"/>
<area shape="poly" id="edge2_Node000002_Node000003" title=" " alt="" coords="291,148,342,119,404,88,418,82,420,87,406,93,344,124,293,152"/>
<area shape="rect" id="Node000005" href="$class_b_n_o08x.html#a4f12de628073f44b2a3fab2688cf1caf" title="Waits for a valid or invalid packet to be received or host_int_timeout_ms to elapse." alt="" coords="425,103,579,129"/>
<area shape="poly" id="edge4_Node000002_Node000005" title=" " alt="" coords="336,148,418,130,419,136,337,153"/>
<area shape="rect" id="Node000006" href="$class_b_n_o08x.html#a7cdeb849e728487de961cdfd4030c773" title="Waits for a queued packet to be sent or host_int_timeout_ms to elapse." alt="" coords="415,153,590,180"/>
<area shape="poly" id="edge5_Node000002_Node000006" title=" " alt="" coords="357,162,399,163,399,168,357,168"/>
<area shape="rect" id="Node000004" href="$class_b_n_o08x.html#a62c570ba96512f4d0d10b2594048de1f" title="Queues an SHTP packet to be sent via SPI." alt="" coords="651,44,811,71"/>
<area shape="poly" id="edge3_Node000003_Node000004" title=" " alt="" coords="584,55,636,55,636,60,584,60"/>
<area shape="rect" id="Node000008" href="$class_b_n_o08x.html#a2897a178bf2c53cd99df0d4570edf72e" title="Waits for data to be received over SPI, or host_int_timeout_ms to elapse." alt="" coords="415,204,590,231"/>
<area shape="poly" id="edge7_Node000007_Node000008" title=" " alt="" coords="338,217,399,216,399,221,338,222"/>
<area shape="rect" id="Node000010" href="$class_b_n_o08x.html#a453ec8a70646651d4e5b10bf0b2e4d61" title="Resets all data returned by public getter APIs to initial values of 0 and low accuracy." alt="" coords="423,255,582,297"/>
<area shape="poly" id="edge9_Node000009_Node000010" title=" " alt="" coords="352,276,407,275,407,280,352,281"/>
<area shape="rect" id="Node000012" href="$class_b_n_o08x.html#a8f34d5475474f00ae6a92f73c1fe14e4" title="Initializes required gpio inputs." alt="" coords="418,321,586,348"/>
<area shape="poly" id="edge11_Node000011_Node000012" title=" " alt="" coords="331,332,402,332,402,337,331,337"/>
<area shape="rect" id="Node000013" href="$class_b_n_o08x.html#ad0b9e8f8d051798bb1da9b19598dbd64" title="Initializes required gpio outputs." alt="" coords="414,372,590,399"/>
<area shape="poly" id="edge12_Node000011_Node000013" title=" " alt="" coords="332,346,423,366,422,371,331,351"/>
<area shape="rect" id="Node000015" href="$class_b_n_o08x.html#a804b95c58c30d36933fd251626b85bf7" title="HINT interrupt service routine, handles falling edge of BNO08x HINT pin." alt="" coords="428,423,576,449"/>
<area shape="poly" id="edge14_Node000014_Node000015" title=" " alt="" coords="334,397,423,416,422,421,333,402"/>
<area shape="rect" id="Node000018" href="$class_b_n_o08x.html#a0ae135d7bf7a5f047a1d1aa5cc07e520" title="Static function used to launch data processing task." alt="" coords="419,473,586,516"/>
<area shape="poly" id="edge17_Node000017_Node000018" title=" " alt="" coords="346,492,403,492,403,497,346,497"/>
<area shape="rect" id="Node000045" href="$class_b_n_o08x.html#a0ce6d9db873555f1ebe7e095251eab74" title="Static function used to launch spi task." alt="" coords="405,563,599,589"/>
<area shape="poly" id="edge44_Node000017_Node000045" title=" " alt="" coords="310,506,448,555,446,560,308,511"/>
<area shape="rect" id="Node000019" href="$class_b_n_o08x.html#ab4373e9b87837ea9fcbc0b536338c7b8" title="Task responsible parsing packets. Executed when SPI task sends a packet to be parsed,..." alt="" coords="647,471,815,497"/>
<area shape="poly" id="edge18_Node000018_Node000019" title=" " alt="" coords="586,488,632,486,632,491,587,493"/>
<area shape="rect" id="Node000020" href="$class_b_n_o08x.html#a1c47d27917ae3b2876efa121b803f924" title="Parses a packet received from bno08x, updating any data according to received reports." alt="" coords="867,408,1023,435"/>
<area shape="poly" id="edge19_Node000019_Node000020" title=" " alt="" coords="778,468,881,437,883,442,780,473"/>
<area shape="rect" id="Node000044" href="$class_b_n_o08x.html#a05e4cd5861b55fc0182d7dd13bb85e49" title="Prints the passed SHTP packet to serial console with ESP_LOG statement." alt="" coords="870,471,1020,497"/>
<area shape="poly" id="edge43_Node000019_Node000044" title=" " alt="" coords="815,481,855,481,855,487,815,487"/>
<area shape="rect" id="Node000021" href="$class_b_n_o08x.html#a4f66045a0528a0c17c52421ea51612e7" title="Parses received command report sent by BNO08x (See Ref. Manual 6.3.9)" alt="" coords="1088,192,1262,235"/>
<area shape="poly" id="edge20_Node000020_Node000021" title=" " alt="" coords="950,407,967,374,994,330,1030,284,1073,245,1080,240,1083,245,1077,249,1034,288,999,333,972,377,955,409"/>
<area shape="rect" id="Node000022" href="$class_b_n_o08x.html#a206c0e3ddc3b745b56914976d6e69981" title="Parses get feature request report received from BNO08x." alt="" coords="1097,259,1253,301"/>
<area shape="poly" id="edge21_Node000020_Node000022" title=" " alt="" coords="957,406,1006,360,1038,334,1074,311,1084,306,1086,310,1076,316,1042,338,1009,364,961,409"/>
<area shape="rect" id="Node000023" href="$class_b_n_o08x.html#a51b360d795563b55559f11efb40be36a" title="Sends packet to be parsed to meta data function call (FRS_read_data()) through queue." alt="" coords="1093,325,1256,368"/>
<area shape="poly" id="edge22_Node000020_Node000023" title=" " alt="" coords="988,405,1092,371,1093,376,989,410"/>
<area shape="rect" id="Node000024" href="$class_b_n_o08x.html#a7be6047fef851a064c7cbc9eba092f6d" title="Parses received gyro integrated rotation vector report sent by BNO08x." alt="" coords="1104,392,1246,451"/>
<area shape="poly" id="edge23_Node000020_Node000024" title=" " alt="" coords="1023,419,1088,419,1088,424,1023,424"/>
<area shape="rect" id="Node000026" href="$class_b_n_o08x.html#a8d9db3e1b6208c2661e1c543deefa53d" title="Parses received input report sent by BNO08x." alt="" coords="1102,475,1247,517"/>
<area shape="poly" id="edge25_Node000020_Node000026" title=" " alt="" coords="989,433,1093,467,1092,472,988,438"/>
<area shape="rect" id="Node000043" href="$class_b_n_o08x.html#a29cfd7fc2816483ebebe9d55b677a036" title="Parses product id report and prints device info." alt="" coords="1095,541,1255,584"/>
<area shape="poly" id="edge42_Node000020_Node000043" title=" " alt="" coords="989,433,1029,457,1045,475,1053,493,1061,511,1077,527,1083,532,1080,536,1073,531,1057,514,1048,496,1040,478,1025,461,986,438"/>
<area shape="rect" id="Node000025" href="$class_b_n_o08x.html#ab02386f13caa446bab5921c1a71f92ab" title="Updates integrated gyro rotation vector data from SHTP channel 5 (CHANNEL_GYRO) special report data." alt="" coords="1351,5,1532,48"/>
<area shape="poly" id="edge24_Node000024_Node000025" title=" " alt="" coords="1245,400,1260,391,1272,378,1286,358,1295,337,1303,297,1301,258,1293,218,1286,179,1284,139,1294,99,1305,79,1320,58,1335,45,1339,49,1324,62,1309,82,1299,101,1290,140,1291,178,1298,217,1306,257,1308,297,1300,339,1291,360,1276,382,1263,395,1248,405"/>
<area shape="rect" id="Node000027" href="$class_b_n_o08x.html#a002aa97c9af8f6df2d0c83034e4f7b55" title="Parses data from received input report." alt="" coords="1369,72,1514,115"/>
<area shape="poly" id="edge26_Node000026_Node000027" title=" " alt="" coords="1246,480,1261,472,1272,461,1287,440,1297,419,1306,377,1303,336,1295,294,1286,253,1284,211,1293,168,1304,146,1320,125,1335,112,1353,103,1355,107,1338,116,1324,128,1309,149,1298,170,1289,211,1292,252,1300,293,1308,335,1311,377,1303,420,1292,442,1276,464,1264,476,1249,485"/>
<area shape="rect" id="Node000028" href="$class_b_n_o08x.html#afe588fbd0055193d3bc08984d7732354" title="Updates accelerometer data from parsed input report." alt="" coords="1322,139,1561,165"/>
<area shape="poly" id="edge27_Node000026_Node000028" title=" " alt="" coords="1246,480,1272,461,1294,425,1302,390,1300,354,1294,319,1287,283,1286,247,1296,211,1320,176,1323,173,1327,177,1324,179,1301,213,1292,248,1293,282,1299,318,1305,354,1307,390,1299,427,1276,464,1249,484"/>
<area shape="rect" id="Node000029" href="$class_b_n_o08x.html#a962b695ef4733d558c6f9684da0931ab" title="Updates linear gyro data from parsed input report." alt="" coords="1351,189,1532,232"/>
<area shape="poly" id="edge28_Node000026_Node000029" title=" " alt="" coords="1246,479,1272,461,1290,434,1298,407,1298,380,1295,353,1292,326,1293,298,1301,270,1320,242,1336,229,1340,233,1324,246,1306,272,1298,299,1297,325,1300,352,1303,380,1303,408,1295,436,1276,465,1250,484"/>
<area shape="rect" id="Node000030" href="$class_b_n_o08x.html#af971d82426740e62c1f05adcd2c9ce7c" title="Updates command data from parsed input report." alt="" coords="1335,256,1548,283"/>
<area shape="poly" id="edge29_Node000026_Node000030" title=" " alt="" coords="1246,479,1272,461,1287,440,1294,420,1294,377,1296,335,1304,313,1320,293,1324,289,1328,293,1324,297,1309,316,1301,336,1300,378,1299,421,1292,443,1276,465,1249,483"/>
<area shape="rect" id="Node000031" href="$class_b_n_o08x.html#ad7de3999d4df19038e27c01f9b02010e" title="Updates gravity data from parsed input report." alt="" coords="1345,307,1538,333"/>
<area shape="poly" id="edge30_Node000026_Node000031" title=" " alt="" coords="1246,478,1273,461,1284,447,1291,432,1295,403,1300,373,1307,358,1321,343,1330,337,1333,341,1324,347,1312,361,1305,374,1300,404,1296,434,1289,449,1276,465,1249,482"/>
<area shape="rect" id="Node000032" href="$class_b_n_o08x.html#a7416d844f6188c8d16f181d6d4431708" title="Updates linear accelerometer data from parsed input report." alt="" coords="1370,357,1513,400"/>
<area shape="poly" id="edge31_Node000026_Node000032" title=" " alt="" coords="1247,474,1273,460,1287,448,1296,436,1305,423,1321,410,1354,394,1356,399,1324,414,1309,426,1300,439,1291,452,1276,465,1249,479"/>
<area shape="rect" id="Node000033" href="$class_b_n_o08x.html#a3abf4a199bc7a03ac7447c2781673d88" title="Updates magnetic field data from parsed input report." alt="" coords="1349,424,1534,451"/>
<area shape="poly" id="edge32_Node000026_Node000033" title=" " alt="" coords="1247,477,1322,460,1359,452,1361,457,1323,465,1248,482"/>
<area shape="rect" id="Node000034" href="$class_b_n_o08x.html#a04489cf9a125495c7cf07c6ba5e9f6c0" title="Updates activity classifier data from parsed input report." alt="" coords="1355,475,1528,517"/>
<area shape="poly" id="edge33_Node000026_Node000034" title=" " alt="" coords="1248,493,1339,493,1339,499,1248,499"/>
<area shape="rect" id="Node000035" href="$class_b_n_o08x.html#a83fed63c67957ec4338afd43087d6e22" title="Updates raw accelerometer data from parsed input report." alt="" coords="1369,541,1514,584"/>
<area shape="poly" id="edge34_Node000026_Node000035" title=" " alt="" coords="1248,512,1355,538,1354,544,1247,517"/>
<area shape="rect" id="Node000036" href="$class_b_n_o08x.html#ad0f0fec4e53029b4ba907414a36ac5ea" title="Updates raw gyro data from parsed input report." alt="" coords="1369,608,1514,651"/>
<area shape="poly" id="edge35_Node000026_Node000036" title=" " alt="" coords="1249,512,1276,527,1292,544,1301,562,1309,578,1324,594,1356,610,1353,615,1321,598,1304,581,1296,564,1288,547,1273,531,1247,517"/>
<area shape="rect" id="Node000037" href="$class_b_n_o08x.html#a6ddc9600c53a4248d1affcab36f6f245" title="Updates raw magnetic field data from parsed input report." alt="" coords="1369,675,1514,717"/>
<area shape="poly" id="edge36_Node000026_Node000037" title=" " alt="" coords="1249,509,1276,527,1290,545,1297,562,1301,596,1304,629,1311,645,1324,661,1356,680,1354,685,1321,665,1307,648,1299,631,1295,597,1292,563,1285,547,1273,531,1246,514"/>
<area shape="rect" id="Node000038" href="$class_b_n_o08x.html#aa309152750686fbf8ebf7d6de1f1254b" title="Updates roation vector data from parsed input report." alt="" coords="1358,741,1525,784"/>
<area shape="poly" id="edge37_Node000026_Node000038" title=" " alt="" coords="1249,508,1276,527,1294,553,1302,579,1303,605,1300,630,1298,655,1299,679,1307,703,1324,727,1345,743,1342,747,1320,731,1302,706,1294,680,1293,655,1295,630,1297,605,1296,580,1289,556,1272,531,1246,513"/>
<area shape="rect" id="Node000039" href="$class_b_n_o08x.html#a358316b883928c50dd381f024e6b0645" title="Updates stability classifier data from parsed input report." alt="" coords="1357,808,1526,851"/>
<area shape="poly" id="edge38_Node000026_Node000039" title=" " alt="" coords="1249,508,1276,528,1298,562,1306,597,1305,631,1300,664,1295,697,1294,729,1303,762,1324,794,1344,810,1341,814,1320,798,1298,764,1289,730,1290,696,1295,663,1300,630,1301,597,1293,564,1272,531,1246,512"/>
<area shape="rect" id="Node000040" href="$class_b_n_o08x.html#aa390bf840246e3233e07f6a424efcb6f" title="Updates step counter data from parsed input report." alt="" coords="1367,875,1516,917"/>
<area shape="poly" id="edge39_Node000026_Node000040" title=" " alt="" coords="1249,507,1264,516,1276,528,1292,549,1302,571,1311,614,1308,656,1300,697,1292,738,1289,779,1298,820,1309,840,1324,861,1338,873,1354,881,1351,886,1335,877,1320,864,1304,843,1293,822,1284,779,1286,738,1295,696,1303,655,1306,614,1297,573,1287,552,1272,531,1260,520,1246,512"/>
<area shape="rect" id="Node000041" href="$class_b_n_o08x.html#ac75b7fb1a1b407d0888ea07d708831b1" title="Updates tap detector data from parsed input report." alt="" coords="1370,941,1513,984"/>
<area shape="poly" id="edge40_Node000026_Node000041" title=" " alt="" coords="1249,507,1264,516,1276,528,1295,554,1307,580,1313,606,1316,631,1311,682,1300,731,1288,780,1284,829,1287,853,1294,878,1306,903,1324,928,1339,941,1357,950,1355,955,1336,945,1320,931,1302,905,1289,880,1282,854,1279,829,1283,779,1294,730,1306,681,1310,631,1308,607,1302,582,1290,557,1272,531,1261,520,1246,512"/>
<area shape="rect" id="Node000042" href="$class_b_n_o08x.html#a8de12c9c47549502147bd85dbb7e364e" title="Updates uncalibrated gyro data from parsed input report." alt="" coords="1344,1008,1539,1051"/>
<area shape="poly" id="edge41_Node000026_Node000042" title=" " alt="" coords="1249,507,1264,516,1276,528,1297,558,1311,589,1318,619,1320,649,1314,707,1299,765,1285,822,1279,879,1282,907,1290,936,1303,965,1324,994,1333,1003,1329,1007,1320,998,1299,968,1285,938,1277,908,1274,879,1280,821,1294,763,1309,706,1315,649,1313,620,1306,591,1292,561,1272,531,1261,520,1246,512"/>
<area shape="rect" id="Node000046" href="$class_b_n_o08x.html#a2ecd4ed60f82730ae230c61687ec92bf" title="Task responsible for SPI transactions. Executed when HINT in is asserted by BNO08x." alt="" coords="667,608,795,635"/>
<area shape="poly" id="edge45_Node000045_Node000046" title=" " alt="" coords="574,587,653,603,651,608,573,593"/>
<area shape="rect" id="Node000047" href="$class_b_n_o08x.html#a8d9f28d8857279a3c4b1f62f6dabb638" title="Receives a SHTP packet via SPI and sends it to data_proc_task()" alt="" coords="863,608,1027,635"/>
<area shape="poly" id="edge46_Node000046_Node000047" title=" " alt="" coords="795,619,847,619,847,624,795,624"/>
<area shape="rect" id="Node000050" href="$class_b_n_o08x.html#a2c359a44a2c8e83ecb258a340e2d0e1a" title="Sends a queued SHTP packet via SPI." alt="" coords="869,659,1021,685"/>
<area shape="poly" id="edge49_Node000046_Node000050" title=" " alt="" coords="791,633,871,652,870,657,790,638"/>
<area shape="rect" id="Node000048" href="$class_b_n_o08x.html#a9ee7e73f695af8965a9ede50136d5a8c" title="Receives a SHTP packet body via SPI." alt="" coords="1075,608,1274,635"/>
<area shape="poly" id="edge47_Node000047_Node000048" title=" " alt="" coords="1028,619,1059,619,1059,624,1028,624"/>
<area shape="rect" id="Node000049" href="$class_b_n_o08x.html#acb246769719351e02bf2aff06d039475" title="Receives a SHTP packet header via SPI." alt="" coords="1093,659,1257,701"/>
<area shape="poly" id="edge48_Node000047_Node000049" title=" " alt="" coords="1001,633,1078,653,1077,658,999,638"/>
</map>