This commit is contained in:
gab-k committed 2025-04-14 16:22:21 +00:00
1 parent e0a06c5c06
commit 4f4967aa3f
5 files changed
+3 -3

No files matched your search

Binary file not shown.
Binary file not shown.
@@ -4,7 +4,7 @@ Getting started
1. Where to get the board?
----------------------------------
You can choose any PCB manufacturer. The PCB will be designed to fit the capabilities and constraints of JLCPCB.com.
You can choose any PCB manufacturer. The PCB is designed to fit within the capabilities and constraints of JLCPCB.com.
You have 3 options for board assembly from the most difficult to the easiest:
1. You can assemble the board yourself, but it's best not to do so if you're not familiar with soldering small components. You order the board with the necessary parts and solder the parts. The parts are available at LCSC.com, they supply parts to JLCPCB.com.
+1 -1
View File
@@ -90,7 +90,7 @@
<h1>Getting started<a class="headerlink" href="#getting-started" title="Link to this heading"></a></h1>
<section id="where-to-get-the-board">
<h2>1. Where to get the board?<a class="headerlink" href="#where-to-get-the-board" title="Link to this heading"></a></h2>
<p>You can choose any PCB manufacturer. The PCB will be designed to fit the capabilities and constraints of JLCPCB.com.
<p>You can choose any PCB manufacturer. The PCB is designed to fit within the capabilities and constraints of JLCPCB.com.
You have 3 options for board assembly from the most difficult to the easiest:</p>
<ol class="arabic simple">
<li><p>You can assemble the board yourself, but it’s best not to do so if you’re not familiar with soldering small components. You order the board with the necessary parts and solder the parts. The parts are available at LCSC.com, they supply parts to JLCPCB.com.</p></li>
+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":[[2,"auxiliary-outputs"],[3,"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":[[2,"complete-schematic"],[3,"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":[[2,"electrical-characteristics"],[3,"electrical-characteristics"]],"Electrical Characteristics & Absolute Maximum Ratings":[[2,"id2"],[3,"id2"]],"Enable logging and or debug via SWD":[[8,"enable-logging-and-or-debug-via-swd"]],"Feed-forward":[[11,"id2"]],"GPIO":[[2,"gpio"],[3,"gpio"]],"Gain Scheduling":[[11,"gain-scheduling"]],"Getting started":[[0,null]],"Hardware":[[1,null]],"Input Stage":[[2,"input-stage"],[3,"input-stage"]],"Logging":[[6,"logging"]],"Microcontroller":[[2,"microcontroller"],[3,"microcontroller"]],"Motor Driver":[[2,"motor-driver"],[3,"motor-driver"]],"Other":[[7,null]],"Overview":[[2,null],[3,null],[11,"overview"]],"PID Controller":[[11,"pid-controller"]],"RP2040-Decoder Documentation":[[4,null]],"Reset all CVs":[[5,"reset-all-cvs"]],"Revision 0.3":[[1,"revision-0-3"]],"Revision 1.0":[[1,"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":[[2,"wiring-the-decoder"],[3,"wiring-the-decoder"]],"core0.h":[[9,null]],"core1.h":[[9,"core1-h"]],"shared.h":[[9,"shared-h"]]},"docnames":["gs/getting_started","hardware/index","hardware/rev_0_3/hw_description","hardware/rev_1_0/hw_description","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/index.rst","hardware/rev_0_3/hw_description.rst","hardware/rev_1_0/hw_description.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,"_CPPv41Line 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":[[2,"auxiliary-outputs"],[3,"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":[[2,"complete-schematic"],[3,"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":[[2,"electrical-characteristics"],[3,"electrical-characteristics"]],"Electrical Characteristics & Absolute Maximum Ratings":[[2,"id2"],[3,"id2"]],"Enable logging and or debug via SWD":[[8,"enable-logging-and-or-debug-via-swd"]],"Feed-forward":[[11,"id2"]],"GPIO":[[2,"gpio"],[3,"gpio"]],"Gain Scheduling":[[11,"gain-scheduling"]],"Getting started":[[0,null]],"Hardware":[[1,null]],"Input Stage":[[2,"input-stage"],[3,"input-stage"]],"Logging":[[6,"logging"]],"Microcontroller":[[2,"microcontroller"],[3,"microcontroller"]],"Motor Driver":[[2,"motor-driver"],[3,"motor-driver"]],"Other":[[7,null]],"Overview":[[2,null],[3,null],[11,"overview"]],"PID Controller":[[11,"pid-controller"]],"RP2040-Decoder Documentation":[[4,null]],"Reset all CVs":[[5,"reset-all-cvs"]],"Revision 0.3":[[1,"revision-0-3"]],"Revision 1.0":[[1,"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":[[2,"wiring-the-decoder"],[3,"wiring-the-decoder"]],"core0.h":[[9,null]],"core1.h":[[9,"core1-h"]],"shared.h":[[9,"shared-h"]]},"docnames":["gs/getting_started","hardware/index","hardware/rev_0_3/hw_description","hardware/rev_1_0/hw_description","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/index.rst","hardware/rev_0_3/hw_description.rst","hardware/rev_1_0/hw_description.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,"_CPPv41Line truncated