{"id":7125,"date":"2021-01-07T16:49:42","date_gmt":"2021-01-07T16:49:42","guid":{"rendered":"https:\/\/www.fambach.net\/?p=7125"},"modified":"2021-01-07T17:06:47","modified_gmt":"2021-01-07T17:06:47","slug":"espressif-idf-fehlerbehandlung","status":"publish","type":"post","link":"https:\/\/www.fambach.net\/en\/espressif-idf-fehlerbehandlung\/","title":{"rendered":"Espressif IDF \u2013 Error Handling"},"content":{"rendered":"<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_85 ez-toc-wrap-left counter-hierarchy ez-toc-counter ez-toc-grey ez-toc-container-direction\">\n<div class=\"ez-toc-title-container\">\n<span class=\"ez-toc-title-toggle\"><a href=\"#\" class=\"ez-toc-pull-right ez-toc-btn ez-toc-btn-xs ez-toc-btn-default ez-toc-toggle\" aria-label=\"Toggle Table of Contents\"><span class=\"ez-toc-js-icon-con\"><span class=\"\"><span class=\"eztoc-hide\" style=\"display:none;\">Toggle<\/span><span class=\"ez-toc-icon-toggle-span\"><svg style=\"fill: #999;color:#999\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewbox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #999;color:#999\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewbox=\"0 0 24 24\" version=\"1.2\" baseprofile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/span><\/span><\/a><\/span><\/div>\n<nav><ul class='ez-toc-list ez-toc-list-level-1' ><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-tasks-2\/#Grundsatzliches\" >Grunds&auml;tzliches<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-tasks-2\/#Ausgang\" >Ausgang<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-tasks-2\/#Eingang\" >Eingang<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-4\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-tasks-2\/#Fazit\" >Conclusion<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-5\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-tasks-2\/#Verwandte_Beitrage\" >Verwandte Beitr&auml;ge<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-6\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-tasks-2\/#Quellen\" >Sources<\/a><\/li><\/ul><\/nav><\/div>\n\n<p class=\"wp-block-paragraph\">Die Fehlerbehandlung in der IDF eine der Kernfunktionalit&auml;ten. Auf sie st&ouml;sst man praktisch in jedem Beipiel-Programm. Deshalb m&ouml;chte ich an dieser Stelle n&auml;her auf sie eingehen. <\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Alle wichtigen Funktion der IDF geben Fehlercodes zur&uuml;ck. Hierauf kann zum einen manuell reagiert werden (if Bedingung + Eigenes Handling) oder sie k&ouml;nnen an eine spezielles Macro (Funktion) zur Ausgabe und behandlung weiter geleitet werden<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>ESP_ERROR_CHECK( int Fehler );\nESP_ERROR_CHECK( funktionDieInstZur&uuml;ckGibt( ParamDerFunktion ) );<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">In der Praxis sieht das dann meist so aus:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>ESP_ERROR_CHECK(gpio_config(&amp;config));\nESP_ERROR_CHECK(esp_timer_create(&amp;periodic_timer_args, &amp;periodic_timer));\nESP_ERROR_CHECK(esp_timer_start_periodic(periodic_timer, 500000));\nESP_ERROR_CHECK(esp_sleep_enable_timer_wakeup(500000));<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Dieses Verfahren macht den Code zum einen sicherer, da Fehler nicht unterschlagen werden und &#8222;ausf&uuml;hrliche&#8220; Fehlermeldung erstellt werden. Zum anderen sorgt sie aber auch daf&uuml;r, dass der Code schlechter lesbar ist. Sicherlich besser lesbar w&auml;re das folgende Vorgehen:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/\/ Ersatz f&uuml;r ESP_ERROR_CHECK(gpio_config(&amp;config));\nint error = gpio_config(&amp;config);\nESP_ERROR_CHECK(error);\n\n\/\/ Ersatz f&uuml;r ESP_ERROR_CHECK(\n\/\/ esp_timer_start_periodic(periodic_timer, 500000));\nerror = esp_sleep_enable_timer_wakeup(500000);\nif(error != ESP_OK){\n  ESP_ERROR_CHECK(error);\n} else {\n\/\/ mache was anderes\n}<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Aber keine Angst vor der kurzen Schreibweise, man gew&ouml;hnt sich schnell daran. Hier noch die Links zu m&ouml;glichen Fehlercodes und die ensprechende Doku der IDF<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/docs.espressif.com\/projects\/esp-idf\/en\/latest\/esp32\/api-reference\/error-codes.html\" target=\"_blank\" rel=\"noreferrer noopener\">IDF-Fehlercodes<\/a><\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/docs.espressif.com\/projects\/esp-idf\/en\/latest\/esp32\/api-guides\/error-handling.html\" target=\"_blank\" rel=\"noreferrer noopener\">IDF- Fehlerbehandlung<\/a><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Das Verhalten bei Fehler kann &uuml;ber die Konfiguration beinflusst werden. Normal ist &#8222;Print register and reboot&#8220; eingestellt, das nervt aber eher als es hilf. Deswegen haben ich es bei mir auf &#8222;Print registers and halt&#8220; eingestellt, dann wird nach dem Fehler angehalten und es ist leichter die Ausgabe zu inspezieren. <\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"596\" height=\"108\" src=\"https:\/\/www.fambach.net\/wp-content\/uploads\/2021-01-02-21_57_20.jpg\" alt=\"\" class=\"wp-image-7026\"><figcaption>idf.py menuconfig<\/figcaption><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\" id=\"block-f8bd469f-d583-4ef9-926e-28681dd31815\">Kleiner Tip im IDF Monitor werden die Codezeilen der Fehler angezeigt.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1371\" height=\"427\" src=\"https:\/\/www.fambach.net\/wp-content\/uploads\/2021-01-02-22_03_31.jpg\" alt=\"\" class=\"wp-image-7027\"><figcaption>Angabe der fehlerhaften Datei und Zeile<\/figcaption><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\">So sieht der Testcode aus:<\/p>\n\n\n\n<script>\nvar project = \"sfambach\/espressif-idf\/tree\/master\/L2_Error_Handling\";\nvar file = \"\/main\/main.c\";\nvar test = project + file;\nvar startAt = 16;\nvar endAt = 0;\n\n\ndocument.write('<a href=\"https:\/\/github.com\/'+project+'\" target=\"_blank\">Link zu Git');\ndocument.write('<a href=\"https:\/\/downgit.github.io\/#\/home?url=https:\/\/github.com\/'+project+'\" target=\"_blank\">Download des Projektes mit DownGit<\/script><p>&#8218;);\n\ndocument.write(&#8218;<\/p><div style=\"font-size:1vw\">&#8218;);\ndocument.write(&#8218;<script src=\"https:\\\/\\\/gist-it.appspot.com\\\/github.com\\\/'+test+'\\?slice='+startAt+':'+endAt+'\"><\\\/script>');\ndocument.write('<\/script><p>&#8218;);\n\n\n\n\n\n<\/p><p class=\"wp-block-paragraph\"><sub>Eigenen Fehler k&ouml;nnen <\/sub><\/p><p class=\"wp-block-paragraph\">Wenn eigenen Funktionen auf Fehler laufen k&ouml;nnen, sollte hier ebenfall eine Fehlermeldung zur&uuml;ck gebene werden. Im besten Fall gibt man eine schon existierende Fehlermeldung zur&uuml;ck. (<a rel=\"noreferrer noopener\" href=\"https:\/\/docs.espressif.com\/projects\/esp-idf\/en\/latest\/esp32\/api-guides\/error-handling.html#error-handling-patterns\" target=\"_blank\">Beipiel aus der IDF Doku<\/a>)<\/p><pre class=\"wp-block-code\"><code>sdmmc_card_t* card = calloc(1, sizeof(sdmmc_card_t));\nif (card == NULL) {\n    return ESP_ERR_NO_MEM;\n}\nesp_err_t err = sdmmc_card_init(host, &amp;card);\nif (err != ESP_OK) {\n    \/\/ Clean up\n    free(card);\n    \/\/ Propagate the error to the upper layer\n    \/\/ (e.g. to notify the user).\n    \/\/ Alternatively, application can define and\n    \/\/ return custom error code.\n    return err;\n}<\/code><\/pre><h2 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Fazit\"><\/span>Conclusion<span class=\"ez-toc-section-end\"><\/span><\/h2><p class=\"wp-block-paragraph\">Die Fehlerbehandlung der IDF findet breite Anwendung. Der Code wird hierdurch nicht unbeding &uuml;bersichtlicher bleibt aber sch&ouml;n kurz.<\/p><h2 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Verwandte_Beitrage\"><\/span>Verwandte Beitr&auml;ge<span class=\"ez-toc-section-end\"><\/span><\/h2><p class=\"wp-block-paragraph\"><a href=\"https:\/\/www.fambach.net\/en\/?p=6943\">Main contribution<\/a><\/p><div class=\"display-posts-listing\">\n<div class=\"listing-item\"><a class=\"title\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-projekt-erstellen\/\">Espressif IDF \u2013 Create Project<\/a><\/div>\n<div class=\"listing-item\"><a class=\"title\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-konsolenausgabe\/\">Espressif IDF \u2013 Console Output<\/a><\/div>\n<div class=\"listing-item\"><a class=\"title\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-fehlerbehandlung\/\">Espressif IDF \u2013 Error Handling<\/a><\/div>\n<div class=\"listing-item\"><a class=\"title\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-log-nachrichten\/\">Espressif IDF \u2013 Log Messages<\/a><\/div>\n<div class=\"listing-item\"><a class=\"title\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-timer\/\">Espressif IDF \u2013 Timer<\/a><\/div>\n<div class=\"listing-item\"><a class=\"title\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-menuconfig\/\">Espressif IDF \u2013 Menuconfig<\/a><\/div>\n<div class=\"listing-item\"><a class=\"title\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-tasks\/\">Espressif IDF \u2013 Tasks<\/a><\/div>\n<div class=\"listing-item\"><a class=\"title\" href=\"https:\/\/www.fambach.net\/en\/espressif-idf-tasks-2\/\">Espressif IDF \u2013 GPIOs<\/a><\/div>\n<\/div>\n\n\n\n<\/p><h2 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Quellen\"><\/span>Sources<span class=\"ez-toc-section-end\"><\/span><\/h2><p class=\"wp-block-paragraph\"><a href=\"https:\/\/docs.espressif.com\/projects\/esp-idf\/en\/latest\/esp32\/api-reference\/error-codes.html\" target=\"_blank\" rel=\"noreferrer noopener\">IDF-Fehlercodes<\/a><\/p><p class=\"wp-block-paragraph\"><a href=\"https:\/\/docs.espressif.com\/projects\/esp-idf\/en\/latest\/esp32\/api-guides\/error-handling.html\" target=\"_blank\" rel=\"noreferrer noopener\">IDF- Fehlerbehandlung<\/a><\/p>","protected":false},"excerpt":{"rendered":"<p>Die Fehlerbehandlung in der IDF eine der Kernfunktionalit&auml;ten. Auf sie st&ouml;sst man praktisch in jedem Beipiel-Programm. Deshalb m&ouml;chte ich an dieser Stelle n&auml;her auf sie eingehen. Alle wichtigen Funktion der IDF geben Fehlercodes zur&uuml;ck. Hierauf kann zum einen manuell reagiert werden (if Bedingung + Eigenes Handling) oder sie k&ouml;nnen an eine spezielles Macro (Funktion) zur &#8230;<\/p>\n<a href=\"https:\/\/www.fambach.net\/en\/espressif-idf-tasks-2\/\" class=\"read-more-link\">Carry on reading <span class=\"screen-reader-text\">\"Espressif IDF &#8211; GPIOs\"<\/span> <span class=\"meta-nav\">\u2192<\/span><\/a>","protected":false},"author":1,"featured_media":7027,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_lmt_disableupdate":"no","_lmt_disable":"no","footnotes":""},"categories":[184,188,472,473,496,255],"tags":[497,148,499,465,474,492,476,500,491],"class_list":["post-7125","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-c-c","category-esp-32","category-esp32-s2","category-espressif-idf","category-how-to","category-windows","tag-c-2","tag-esp32","tag-esp32s2","tag-espressif","tag-espressif-idf","tag-howto","tag-idf","tag-shulung","tag-tutorial","penguin-post","penguin-post-not-sticky"],"modified_by":"sfambach","_links":{"self":[{"href":"https:\/\/www.fambach.net\/en\/wp-json\/wp\/v2\/posts\/7125","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.fambach.net\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.fambach.net\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.fambach.net\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.fambach.net\/en\/wp-json\/wp\/v2\/comments?post=7125"}],"version-history":[{"count":3,"href":"https:\/\/www.fambach.net\/en\/wp-json\/wp\/v2\/posts\/7125\/revisions"}],"predecessor-version":[{"id":7132,"href":"https:\/\/www.fambach.net\/en\/wp-json\/wp\/v2\/posts\/7125\/revisions\/7132"}],"wp:attachment":[{"href":"https:\/\/www.fambach.net\/en\/wp-json\/wp\/v2\/media?parent=7125"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.fambach.net\/en\/wp-json\/wp\/v2\/categories?post=7125"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.fambach.net\/en\/wp-json\/wp\/v2\/tags?post=7125"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}