Files
RP2040-Decoder/sphinx/html/other/debug_logging.html
T
2025-04-14 16:03:32 +00:00

138 lines
6.5 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Debugging and Logging &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=6bd3bce2"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Configuration Variables (CV)" href="CV_list.html" />
<link rel="prev" title="Troubleshooting" href="troubleshooting.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
RP2040-Decoder
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../gs/getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../hardware/index.html">Hardware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../software/index.html">Software</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Other</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Debugging and Logging</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#debugging-via-swd">Debugging via SWD</a></li>
<li class="toctree-l3"><a class="reference internal" href="#logging">Logging</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="CV_list.html">Configuration Variables (CV)</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">RP2040-Decoder</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">Other</a></li>
<li class="breadcrumb-item active">Debugging and Logging</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/other/debug_logging.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="debugging-and-logging">
<h1>Debugging and Logging<a class="headerlink" href="#debugging-and-logging" title="Link to this heading"></a></h1>
<p>For logging and debugging you have to build the software yourself. This is explained here: <a class="reference internal" href="../gs/getting_started.html#building-the-software"><span class="std std-ref">3. Building the software</span></a></p>
<section id="debugging-via-swd">
<span id="id1"></span><h2>Debugging via SWD<a class="headerlink" href="#debugging-via-swd" title="Link to this heading"></a></h2>
<p>Please refer to <a class="reference internal" href="../gs/getting_started.html#flashing-the-software-swd"><span class="std std-ref">4.2. Flashing the software via SWD</span></a>.</p>
</section>
<section id="logging">
<span id="id2"></span><h2>Logging<a class="headerlink" href="#logging" title="Link to this heading"></a></h2>
<p>Logging can be enabled in <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code>, and is available with two interfaces:</p>
<blockquote>
<div><ul class="simple">
<li><p>Logging via UART RX/TX pins (GPIO0/GPIO1 by default)</p></li>
<li><p>Logging via USB CDC/ACM</p></li>
</ul>
</div></blockquote>
<p>Additionally you can make the decoder wait for input via serial port by setting LOG_WAIT to 1. For more details please see comments inside <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code>.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="troubleshooting.html" class="btn btn-neutral float-left" title="Troubleshooting" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="CV_list.html" class="btn btn-neutral float-right" title="Configuration Variables (CV)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Gabriel Koppenstein.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>