This commit is contained in:
gab-k committed 2025-04-27 08:21:48 +00:00
1 parent 920be74a58
commit 947d212be5
19 files changed
+44 -44

No files matched your search

+2 -2
View File
@@ -1,7 +1,7 @@
Hardware
======================
Revision 1.0
USB
------------
.. toctree::
@@ -9,7 +9,7 @@ Revision 1.0
USB/hw_description
Revision 0.3
Legacy
------------
.. toctree::
+1 -1
View File
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.3, 1.0',
VERSION: 'unknown',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
+2 -2
View File
@@ -5,14 +5,14 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Index &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
+2 -2
View File
@@ -6,14 +6,14 @@
<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>Getting started &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Getting started &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
@@ -6,14 +6,14 @@
<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>Overview &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Overview &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
@@ -46,8 +46,8 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../gs/getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Hardware</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html#revision-1-0">Revision 1.0</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../index.html#revision-0-3">Revision 0.3</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../index.html#usb">USB</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../index.html#legacy">Legacy</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="#input-stage">Input Stage</a></li>
+4 -4
View File
@@ -6,14 +6,14 @@
<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>Overview &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Overview &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
@@ -46,7 +46,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../gs/getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Hardware</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../index.html#revision-1-0">Revision 1.0</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../index.html#usb">USB</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="#input-stage">Input Stage</a></li>
@@ -58,7 +58,7 @@
<li class="toctree-l3"><a class="reference internal" href="#wiring-the-decoder">Wiring the Decoder</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#revision-0-3">Revision 0.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="../index.html#legacy">Legacy</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../software/index.html">Software</a></li>
+8 -8
View File
@@ -6,14 +6,14 @@
<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>Hardware &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Hardware &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
@@ -46,7 +46,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../gs/getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Hardware</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#revision-1-0">Revision 1.0</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#usb">USB</a><ul>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#input-stage">Input Stage</a></li>
@@ -58,7 +58,7 @@
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#revision-0-3">Revision 0.3</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#legacy">Legacy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html#input-stage">Input Stage</a></li>
@@ -102,8 +102,8 @@
<section id="hardware">
<h1>Hardware<a class="headerlink" href="#hardware" title="Link to this heading"></a></h1>
<section id="revision-1-0">
<h2>Revision 1.0<a class="headerlink" href="#revision-1-0" title="Link to this heading"></a></h2>
<section id="usb">
<h2>USB<a class="headerlink" href="#usb" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="USB/hw_description.html">Overview</a></li>
@@ -118,8 +118,8 @@
</ul>
</div>
</section>
<section id="revision-0-3">
<h2>Revision 0.3<a class="headerlink" href="#revision-0-3" title="Link to this heading"></a></h2>
<section id="legacy">
<h2>Legacy<a class="headerlink" href="#legacy" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Legacy/hw_description.html">Overview</a></li>
+4 -4
View File
@@ -6,14 +6,14 @@
<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>RP2040-Decoder Documentation &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>RP2040-Decoder Documentation &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
@@ -92,7 +92,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hardware/index.html#revision-1-0">Revision 1.0</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hardware/index.html#usb">USB</a><ul>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#input-stage">Input Stage</a></li>
@@ -104,7 +104,7 @@
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="hardware/index.html#revision-0-3">Revision 0.3</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hardware/index.html#legacy">Legacy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html#input-stage">Input Stage</a></li>
+2 -2
View File
@@ -6,14 +6,14 @@
<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>Configuration Variables (CV) &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Configuration Variables (CV) &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
+2 -2
View File
@@ -6,14 +6,14 @@
<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>
<title>Debugging and Logging &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
+2 -2
View File
@@ -6,14 +6,14 @@
<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>Other &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Other &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
+2 -2
View File
@@ -6,14 +6,14 @@
<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>Troubleshooting &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Troubleshooting &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
+2 -2
View File
@@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Search &mdash; RP2040-Decoder unknown 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" />
@@ -13,7 +13,7 @@
<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/documentation_options.js?v=3f1b9271"></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>
+1 -1
View File
@@ -1 +1 @@
Search.setIndex({"alltitles":{"1. Where to get the board?":[[0,"where-to-get-the-board"]],"2. Production files?":[[0,"production-files"]],"3. Building the software":[[0,"building-the-software"]],"4. Flashing the software":[[0,"flashing-the-software"]],"4.1. Flashing the software via .uf2 file":[[0,"flashing-the-software-via-uf2-file"]],"4.2. Flashing the software via SWD":[[0,"flashing-the-software-via-swd"]],"5. Wiring":[[0,"wiring"]],"6. Resolving issues":[[0,"resolving-issues"]],"Auxiliary Outputs":[[1,"auxiliary-outputs"],[2,"auxiliary-outputs"]],"Back-EMF voltage measurement":[[11,"back-emf-voltage-measurement"]],"CV List":[[5,"cv-list"]],"CV Reset:":[[8,"cv-reset"]],"CV.h":[[9,"cv-h"]],"CV_{116} to CV_{171} - PWM Slice configuration":[[5,"cv-116-to-cv-171-pwm-slice-configuration"]],"CV_{11} - Packet timeout":[[5,"cv-11-packet-timeout"]],"CV_{12} - Permitted operating modes":[[5,"cv-12-permitted-operating-modes"]],"CV_{17} & CV_{18} - 14-Bit extended/long address":[[5,"cv-17-cv-18-14-bit-extended-long-address"]],"CV_{1} - Basic address":[[5,"cv-1-basic-address"]],"CV_{29} - Decoder Configuration":[[5,"cv-29-decoder-configuration"]],"CV_{2} - v_{min}":[[5,"cv-2-v-min"]],"CV_{31} & CV_{32} - Extended CV pointer (Read-Only)":[[5,"cv-31-cv-32-extended-cv-pointer-read-only"]],"CV_{3} - Acceleration rate":[[5,"cv-3-acceleration-rate"]],"CV_{4} - Deceleration rate":[[5,"cv-4-deceleration-rate"]],"CV_{5} - v_{max}":[[5,"cv-5-v-max"]],"CV_{6} - v_{mid}":[[5,"cv-6-v-mid"]],"CV_{7} - Version No. (Read-Only)":[[5,"cv-7-version-no-read-only"]],"CV_{8} - Manufacturer (Read-Only)":[[5,"cv-8-manufacturer-read-only"]],"CV_{9} - Motor PWM Frequency":[[5,"cv-9-motor-pwm-frequency"]],"Check your motor:":[[8,"check-your-motor"]],"Checking the power supply:":[[8,"checking-the-power-supply"]],"Complete Schematic":[[1,"complete-schematic"],[2,"complete-schematic"]],"Configuration Variables (CV)":[[5,null]],"Contents:":[[4,null],[7,null],[10,null]],"Control Loop & Digital Controller":[[11,"control-loop-digital-controller"]],"DCC signal decoding":[[11,"dcc-signal-decoding"]],"Debugging and Logging":[[6,null]],"Debugging via SWD":[[6,"debugging-via-swd"]],"Electrical Characteristics":[[1,"electrical-characteristics"],[2,"electrical-characteristics"]],"Electrical Characteristics & Absolute Maximum Ratings":[[1,"id2"],[2,"id2"]],"Enable logging and or debug via SWD":[[8,"enable-logging-and-or-debug-via-swd"]],"Feed-forward":[[11,"id2"]],"GPIO":[[1,"gpio"],[2,"gpio"]],"Gain Scheduling":[[11,"gain-scheduling"]],"Getting started":[[0,null]],"Hardware":[[3,null]],"Input Stage":[[1,"input-stage"],[2,"input-stage"]],"Logging":[[6,"logging"]],"Microcontroller":[[1,"microcontroller"],[2,"microcontroller"]],"Motor Driver":[[1,"motor-driver"],[2,"motor-driver"]],"Other":[[7,null]],"Overview":[[1,null],[2,null],[11,"overview"]],"PID Controller":[[11,"pid-controller"]],"RP2040-Decoder Documentation":[[4,null]],"Reset all CVs":[[5,"reset-all-cvs"]],"Revision 0.3":[[3,"revision-0-3"]],"Revision 1.0":[[3,"revision-1-0"]],"Software":[[10,null]],"Software Description":[[11,null]],"Speed step configuration":[[5,"speed-step-configuration"]],"Startup Controller":[[11,"startup-controller"]],"Troubleshooting":[[8,null]],"Wiring the Decoder":[[1,"wiring-the-decoder"],[2,"wiring-the-decoder"]],"core0.h":[[9,null]],"core1.h":[[9,"core1-h"]],"shared.h":[[9,"shared-h"]]},"docnames":["gs/getting_started","hardware/Legacy/hw_description","hardware/USB/hw_description","hardware/index","index","other/CV_list","other/debug_logging","other/index","other/troubleshooting","software/header_files","software/index","software/sw_description"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["gs/getting_started.rst","hardware/Legacy/hw_description.rst","hardware/USB/hw_description.rst","hardware/index.rst","index.rst","other/CV_list.rst","other/debug_logging.rst","other/index.rst","other/troubleshooting.rst","software/header_files.rst","software/index.rst","software/sw_description.rst"],"indexentries":{"_125m (c macro)":[[9,"c._125M",false]],"absolute_val (c++ function)":[[9,"_CPPv412absolute_vali",false]],"acknowledge (c++ function)":[[9,"_CPPv411acknowledgev",false]],"adc_calibration_iterations (c macro)":[[9,"c.ADC_CALIBRATION_ITERATIONS",false]],"adc_offset_adjustment (c++ function)":[[9,"_CPPv421adc_offset_adjustment8uint32_t",false]],"address_evaluation (c++ function)":[[9,"_CPPv418address_evaluation6size_tA_K7uint8_t",false]],"adjust_pwm_level (c++ function)":[[9,"_CPPv416adjust_pwm_level8uint16_t",false]],"base_pwm_arr_len (c macro)":[[9,"c.BASE_PWM_ARR_LEN",false]],"bits_to_dcc_packet_data (c++ function)":[[9,"_CPPv423bits_to_dcc_packet_dataP12dcc_packet_t",false]],"call_flash_do_cmd (c++ function)":[[9,"_CPPv417call_flasLine truncated
Search.setIndex({"alltitles":{"1. Where to get the board?":[[0,"where-to-get-the-board"]],"2. Production files?":[[0,"production-files"]],"3. Building the software":[[0,"building-the-software"]],"4. Flashing the software":[[0,"flashing-the-software"]],"4.1. Flashing the software via .uf2 file":[[0,"flashing-the-software-via-uf2-file"]],"4.2. Flashing the software via SWD":[[0,"flashing-the-software-via-swd"]],"5. Wiring":[[0,"wiring"]],"6. Resolving issues":[[0,"resolving-issues"]],"Auxiliary Outputs":[[1,"auxiliary-outputs"],[2,"auxiliary-outputs"]],"Back-EMF voltage measurement":[[11,"back-emf-voltage-measurement"]],"CV List":[[5,"cv-list"]],"CV Reset:":[[8,"cv-reset"]],"CV.h":[[9,"cv-h"]],"CV_{116} to CV_{171} - PWM Slice configuration":[[5,"cv-116-to-cv-171-pwm-slice-configuration"]],"CV_{11} - Packet timeout":[[5,"cv-11-packet-timeout"]],"CV_{12} - Permitted operating modes":[[5,"cv-12-permitted-operating-modes"]],"CV_{17} & CV_{18} - 14-Bit extended/long address":[[5,"cv-17-cv-18-14-bit-extended-long-address"]],"CV_{1} - Basic address":[[5,"cv-1-basic-address"]],"CV_{29} - Decoder Configuration":[[5,"cv-29-decoder-configuration"]],"CV_{2} - v_{min}":[[5,"cv-2-v-min"]],"CV_{31} & CV_{32} - Extended CV pointer (Read-Only)":[[5,"cv-31-cv-32-extended-cv-pointer-read-only"]],"CV_{3} - Acceleration rate":[[5,"cv-3-acceleration-rate"]],"CV_{4} - Deceleration rate":[[5,"cv-4-deceleration-rate"]],"CV_{5} - v_{max}":[[5,"cv-5-v-max"]],"CV_{6} - v_{mid}":[[5,"cv-6-v-mid"]],"CV_{7} - Version No. (Read-Only)":[[5,"cv-7-version-no-read-only"]],"CV_{8} - Manufacturer (Read-Only)":[[5,"cv-8-manufacturer-read-only"]],"CV_{9} - Motor PWM Frequency":[[5,"cv-9-motor-pwm-frequency"]],"Check your motor:":[[8,"check-your-motor"]],"Checking the power supply:":[[8,"checking-the-power-supply"]],"Complete Schematic":[[1,"complete-schematic"],[2,"complete-schematic"]],"Configuration Variables (CV)":[[5,null]],"Contents:":[[4,null],[7,null],[10,null]],"Control Loop & Digital Controller":[[11,"control-loop-digital-controller"]],"DCC signal decoding":[[11,"dcc-signal-decoding"]],"Debugging and Logging":[[6,null]],"Debugging via SWD":[[6,"debugging-via-swd"]],"Electrical Characteristics":[[1,"electrical-characteristics"],[2,"electrical-characteristics"]],"Electrical Characteristics & Absolute Maximum Ratings":[[1,"id2"],[2,"id2"]],"Enable logging and or debug via SWD":[[8,"enable-logging-and-or-debug-via-swd"]],"Feed-forward":[[11,"id2"]],"GPIO":[[1,"gpio"],[2,"gpio"]],"Gain Scheduling":[[11,"gain-scheduling"]],"Getting started":[[0,null]],"Hardware":[[3,null]],"Input Stage":[[1,"input-stage"],[2,"input-stage"]],"Legacy":[[3,"legacy"]],"Logging":[[6,"logging"]],"Microcontroller":[[1,"microcontroller"],[2,"microcontroller"]],"Motor Driver":[[1,"motor-driver"],[2,"motor-driver"]],"Other":[[7,null]],"Overview":[[1,null],[2,null],[11,"overview"]],"PID Controller":[[11,"pid-controller"]],"RP2040-Decoder Documentation":[[4,null]],"Reset all CVs":[[5,"reset-all-cvs"]],"Software":[[10,null]],"Software Description":[[11,null]],"Speed step configuration":[[5,"speed-step-configuration"]],"Startup Controller":[[11,"startup-controller"]],"Troubleshooting":[[8,null]],"USB":[[3,"usb"]],"Wiring the Decoder":[[1,"wiring-the-decoder"],[2,"wiring-the-decoder"]],"core0.h":[[9,null]],"core1.h":[[9,"core1-h"]],"shared.h":[[9,"shared-h"]]},"docnames":["gs/getting_started","hardware/Legacy/hw_description","hardware/USB/hw_description","hardware/index","index","other/CV_list","other/debug_logging","other/index","other/troubleshooting","software/header_files","software/index","software/sw_description"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["gs/getting_started.rst","hardware/Legacy/hw_description.rst","hardware/USB/hw_description.rst","hardware/index.rst","index.rst","other/CV_list.rst","other/debug_logging.rst","other/index.rst","other/troubleshooting.rst","software/header_files.rst","software/index.rst","software/sw_description.rst"],"indexentries":{"_125m (c macro)":[[9,"c._125M",false]],"absolute_val (c++ function)":[[9,"_CPPv412absolute_vali",false]],"acknowledge (c++ function)":[[9,"_CPPv411acknowledgev",false]],"adc_calibration_iterations (c macro)":[[9,"c.ADC_CALIBRATION_ITERATIONS",false]],"adc_offset_adjustment (c++ function)":[[9,"_CPPv421adc_offset_adjustment8uint32_t",false]],"address_evaluation (c++ function)":[[9,"_CPPv418address_evaluation6size_tA_K7uint8_t",false]],"adjust_pwm_level (c++ function)":[[9,"_CPPv416adjust_pwm_level8uint16_t",false]],"base_pwm_arr_len (c macro)":[[9,"c.BASE_PWM_ARR_LEN",false]],"bits_to_dcc_packet_data (c++ function)":[[9,"_CPPv423bits_to_dcc_packet_dataP12dcc_packet_t",false]],"call_flash_do_cmd (c++ function)":[[9,"_CPPv417call_flash_do_cmdPv",false]],"call_flasLine truncated
+2 -2
View File
@@ -6,14 +6,14 @@
<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>core0.h &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>core0.h &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
+2 -2
View File
@@ -6,14 +6,14 @@
<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>Software &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Software &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></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>
+2 -2
View File
@@ -6,14 +6,14 @@
<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>Software Description &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<title>Software Description &mdash; RP2040-Decoder unknown 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/documentation_options.js?v=3f1b9271"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>