descriptions

This commit is contained in:
2025-07-01 01:43:21 -04:00
parent da9fa483ab
commit 112a099638
8 changed files with 226 additions and 192 deletions

View File

@@ -7,10 +7,18 @@ The BitByteRider RC car is powered by ESP32-C3 Breadboard & Power adapter develo
Reserver Pins & GPIOs Reserver Pins & GPIOs
--------------------- ---------------------
The table below summarizes GPIOs and pins reserved for operations purposes. The following table summarizes GPIOs and pins reserved for operations purposes.
The GPIO numbers correspond to those on the ESP32-C3 WROOM microcontroller. The Pin number corresponds to the pin on the Breadboard and Power adapter development board.
x- and y- axis
~~~~~~~~~~~~~~
GPIO number corresponds to that on the ESP32-C3 WROOM microcontroller. The Pin number corresponds to the pin on the Breadboard and Power adapter development board.
The GPIO0 and GPIO1 assigned to measuring the voltage of x- and y- axis of the Joystick. Lastly, there is a group of GPIO pairs responsible for PWM for DC motors. The GPIO0 and GPIO1 assigned to measuring the voltage of x- and y- axis of the Joystick. Lastly, there is a group of GPIO pairs responsible for PWM for DC motors.
Direction and speed
~~~~~~~~~~~~~~~~~~~
The two DC motors on the left side are wired to the same PWM channel, as well as the two DC motors on the right side. Consequently, only four PWM channels are required for controlling the direction of the RC car. The two DC motors on the left side are wired to the same PWM channel, as well as the two DC motors on the right side. Consequently, only four PWM channels are required for controlling the direction of the RC car.
A pair of PWM channels are required for defining rotation speed and direction of the DC motors on each side. A pair of PWM channels are required for defining rotation speed and direction of the DC motors on each side.
In particular, GPIO6 and GPIO5 provide PWM to the left- and right- side DC motors to rotate in a clockwise direction. In particular, GPIO6 and GPIO5 provide PWM to the left- and right- side DC motors to rotate in a clockwise direction.

View File

@@ -38,10 +38,15 @@
<p>The BitByteRider RC car is powered by ESP32-C3 Breadboard &amp; Power adapter developmemt board.</p> <p>The BitByteRider RC car is powered by ESP32-C3 Breadboard &amp; Power adapter developmemt board.</p>
<section id="reserver-pins-gpios"> <section id="reserver-pins-gpios">
<h2>Reserver Pins &amp; GPIOs<a class="headerlink" href="#reserver-pins-gpios" title="Link to this heading"></a></h2> <h2>Reserver Pins &amp; GPIOs<a class="headerlink" href="#reserver-pins-gpios" title="Link to this heading"></a></h2>
<p>The table below summarizes GPIOs and pins reserved for operations purposes.</p> <p>The following table summarizes GPIOs and pins reserved for operations purposes.</p>
<p>GPIO number corresponds to that on the ESP32-C3 WROOM microcontroller. The Pin number corresponds to the pin on the Breadboard and Power adapter development board. <p>The GPIO numbers correspond to those on the ESP32-C3 WROOM microcontroller. The Pin number corresponds to the pin on the Breadboard and Power adapter development board.</p>
The GPIO0 and GPIO1 assigned to measuring the voltage of x- and y- axis of the Joystick. Lastly, there is a group of GPIO pairs responsible for PWM for DC motors. <section id="x-and-y-axis">
The two DC motors on the left side are wired to the same PWM channel, as well as the two DC motors on the right side. Consequently, only four PWM channels are required for controlling the direction of the RC car. <h3>x- and y- axis<a class="headerlink" href="#x-and-y-axis" title="Link to this heading"></a></h3>
<p>The GPIO0 and GPIO1 assigned to measuring the voltage of x- and y- axis of the Joystick. Lastly, there is a group of GPIO pairs responsible for PWM for DC motors.</p>
</section>
<section id="direction-and-speed">
<h3>Direction and speed<a class="headerlink" href="#direction-and-speed" title="Link to this heading"></a></h3>
<p>The two DC motors on the left side are wired to the same PWM channel, as well as the two DC motors on the right side. Consequently, only four PWM channels are required for controlling the direction of the RC car.
A pair of PWM channels are required for defining rotation speed and direction of the DC motors on each side. A pair of PWM channels are required for defining rotation speed and direction of the DC motors on each side.
In particular, GPIO6 and GPIO5 provide PWM to the left- and right- side DC motors to rotate in a clockwise direction. In particular, GPIO6 and GPIO5 provide PWM to the left- and right- side DC motors to rotate in a clockwise direction.
Similarly, GPIO4 and GPIO7 provide PWM to the left- and right- side DC motors to rotate in a counter-clockwise direction. Similarly, GPIO4 and GPIO7 provide PWM to the left- and right- side DC motors to rotate in a counter-clockwise direction.
@@ -93,6 +98,7 @@ Changing PWM on each channel determines the speed and direction of the RC car.</
</tbody> </tbody>
</table> </table>
</section> </section>
</section>
<section id="schematic"> <section id="schematic">
<h2>Schematic<a class="headerlink" href="#schematic" title="Link to this heading"></a></h2> <h2>Schematic<a class="headerlink" href="#schematic" title="Link to this heading"></a></h2>
<img alt="_images/ESP-IDF_Robot_schematic.png" src="_images/ESP-IDF_Robot_schematic.png" /> <img alt="_images/ESP-IDF_Robot_schematic.png" src="_images/ESP-IDF_Robot_schematic.png" />

View File

@@ -1 +1 @@
Search.setIndex({"alltitles":{"ByteRider documentation":[[0,null]],"Chassis":[[3,"chassis"]],"Finished Work":[[3,"finished-work"]],"HOW DOES IT WORK?":[[2,null]],"INTRODUCTION":[[1,null]],"Motor Wires Harness":[[3,"motor-wires-harness"]],"Reserver Pins & GPIOs":[[2,"reserver-pins-gpios"]],"Schematic":[[2,"schematic"]],"WORK-IN-PROGRESS WALK THROUGH":[[3,null]],"Wiring":[[3,"wiring"]]},"docnames":["index","intro","overview","progress"],"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":["index.rst","intro.rst","overview.rst","progress.rst"],"indexentries":{},"objects":{},"objnames":{},"objtypes":{},"terms":{"0":2,"1":2,"15":2,"16":2,"2":2,"3":2,"4":2,"5":2,"6":2,"7":2,"8":2,"A":2,"IN":0,"IT":0,"In":2,"The":2,"_static":[],"adapt":2,"adc1_ch0":2,"adc1_ch1":2,"add":0,"ar":2,"assign":2,"axi":2,"below":2,"bitbyterid":2,"board":2,"breadboard":2,"button":2,"c3":2,"car":2,"chang":2,"channel":2,"chassi":0,"clockwis":2,"code":[],"column":[],"complet":3,"consequ":2,"content":0,"control":[2,3],"correspond":2,"counter":2,"data":[],"dc":[2,3],"defin":2,"detail":0,"determin":2,"develop":2,"developmemt":2,"direct":2,"doe":0,"each":2,"esp":[],"esp32":2,"exist":[],"finish":0,"four":2,"function":2,"gpio":0,"gpio0":2,"gpio1":2,"gpio4":2,"gpio5":2,"gpio6":2,"gpio7":2,"group":2,"har":0,"harn":3,"how":0,"i":2,"idf_robot_schemat":[],"imag":[],"insid":3,"instal":3,"introduct":0,"joystick":2,"lastli":2,"ledc_channel_0":2,"ledc_channel_1":2,"ledc_channel_2":2,"ledc_channel_3":2,"left":2,"measur":2,"microcontrol":2,"motor":[0,2],"note":2,"number":2,"onli":[2,3],"oper":2,"pair":2,"particular":2,"pin":0,"png":[],"power":2,"progress":0,"provid":2,"purpos":2,"push":2,"pwm":2,"rc":2,"requir":2,"reserv":0,"respons":2,"restructuredtext":0,"right":2,"rotat":2,"row":[],"same":2,"schemat":0,"secur":3,"see":0,"side":2,"similarli":2,"speed":2,"summar":2,"syntax":0,"tabl":2,"through":0,"two":2,"us":0,"voltag":2,"walk":0,"well":2,"wire":[0,2],"work":0,"wroom":2,"x":2,"y":2,"your":0},"titles":["ByteRider documentation","INTRODUCTION","HOW DOES IT WORK?","WORK-IN-PROGRESS WALK THROUGH"],"titleterms":{"IN":3,"IT":2,"byterid":0,"chassi":3,"document":0,"doe":2,"finish":3,"gpio":2,"har":3,"how":2,"introduct":1,"motor":3,"pin":2,"progress":3,"reserv":2,"schemat":2,"through":3,"walk":3,"wire":3,"work":[2,3]}}) Search.setIndex({"alltitles":{"ByteRider documentation":[[0,null]],"Chassis":[[3,"chassis"]],"Direction and speed":[[2,"direction-and-speed"]],"Finished Work":[[3,"finished-work"]],"HOW DOES IT WORK?":[[2,null]],"INTRODUCTION":[[1,null]],"Motor Wires Harness":[[3,"motor-wires-harness"]],"Reserver Pins & GPIOs":[[2,"reserver-pins-gpios"]],"Schematic":[[2,"schematic"]],"WORK-IN-PROGRESS WALK THROUGH":[[3,null]],"Wiring":[[3,"wiring"]],"x- and y- axis":[[2,"x-and-y-axis"]]},"docnames":["index","intro","overview","progress"],"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":["index.rst","intro.rst","overview.rst","progress.rst"],"indexentries":{},"objects":{},"objnames":{},"objtypes":{},"terms":{"0":2,"1":2,"15":2,"16":2,"2":2,"3":2,"4":2,"5":2,"6":2,"7":2,"8":2,"A":2,"IN":0,"IT":0,"In":2,"The":2,"_static":[],"adapt":2,"adc1_ch0":2,"adc1_ch1":2,"add":0,"ar":2,"assign":2,"axi":[],"below":[],"bitbyterid":2,"board":2,"breadboard":2,"button":2,"c3":2,"car":2,"chang":2,"channel":2,"chassi":0,"clockwis":2,"code":[],"column":[],"complet":3,"consequ":2,"content":0,"control":[2,3],"correspond":2,"counter":2,"data":[],"dc":[2,3],"defin":2,"detail":0,"determin":2,"develop":2,"developmemt":2,"direct":[],"doe":0,"each":2,"esp":[],"esp32":2,"exist":[],"finish":0,"follow":2,"four":2,"function":2,"gpio":0,"gpio0":2,"gpio1":2,"gpio4":2,"gpio5":2,"gpio6":2,"gpio7":2,"group":2,"har":0,"harn":3,"how":0,"i":2,"idf_robot_schemat":[],"imag":[],"insid":3,"instal":3,"introduct":0,"joystick":2,"lastli":2,"ledc_channel_0":2,"ledc_channel_1":2,"ledc_channel_2":2,"ledc_channel_3":2,"left":2,"measur":2,"microcontrol":2,"motor":[0,2],"note":2,"number":2,"onli":[2,3],"oper":2,"pair":2,"particular":2,"pin":0,"png":[],"power":2,"progress":0,"provid":2,"purpos":2,"push":2,"pwm":2,"rc":2,"requir":2,"reserv":0,"respons":2,"restructuredtext":0,"right":2,"rotat":2,"row":[],"same":2,"schemat":0,"secur":3,"see":0,"side":2,"similarli":2,"speed":[],"summar":2,"syntax":0,"tabl":2,"those":2,"through":0,"two":2,"us":0,"voltag":2,"walk":0,"well":2,"wire":[0,2],"work":0,"wroom":2,"x":[],"y":[],"your":0},"titles":["ByteRider documentation","INTRODUCTION","HOW DOES IT WORK?","WORK-IN-PROGRESS WALK THROUGH"],"titleterms":{"IN":3,"IT":2,"axi":2,"byterid":0,"chassi":3,"direct":2,"document":0,"doe":2,"finish":3,"gpio":2,"har":3,"how":2,"introduct":1,"motor":3,"pin":2,"progress":3,"reserv":2,"schemat":2,"speed":2,"through":3,"walk":3,"wire":3,"work":[2,3],"x":2,"y":2}})

View File

@@ -1,4 +1,4 @@
# Sphinx build info version 1 # Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a64ae2ddbe1a660300529ff4ea994509 config: 5458a27274c33d5af44795e94e6d9fcd
tags: 62a1e7829a13fc7881b6498c52484ec0 tags: 62a1e7829a13fc7881b6498c52484ec0

View File

@@ -168,196 +168,216 @@
</a> </a>
</h3> </h3>
<p> <p>
The table below summarizes GPIOs and pins reserved for operations purposes. The following table summarizes GPIOs and pins reserved for operations purposes.
</p> </p>
<p> <p>
GPIO number corresponds to that on the ESP32-C3 WROOM microcontroller. The Pin number corresponds to the pin on the Breadboard and Power adapter development board. The GPIO numbers correspond to those on the ESP32-C3 WROOM microcontroller. The Pin number corresponds to the pin on the Breadboard and Power adapter development board.
The GPIO0 and GPIO1 assigned to measuring the voltage of x- and y- axis of the Joystick. Lastly, there is a group of GPIO pairs responsible for PWM for DC motors. </p>
The two DC motors on the left side are wired to the same PWM channel, as well as the two DC motors on the right side. Consequently, only four PWM channels are required for controlling the direction of the RC car. <section id="x-and-y-axis">
<h4>
x- and y- axis
<a class="headerlink" href="#x-and-y-axis" title="Link to this heading">
&para;
</a>
</h4>
<p>
The GPIO0 and GPIO1 assigned to measuring the voltage of x- and y- axis of the Joystick. Lastly, there is a group of GPIO pairs responsible for PWM for DC motors.
</p>
</section>
<section id="direction-and-speed">
<h4>
Direction and speed
<a class="headerlink" href="#direction-and-speed" title="Link to this heading">
&para;
</a>
</h4>
<p>
The two DC motors on the left side are wired to the same PWM channel, as well as the two DC motors on the right side. Consequently, only four PWM channels are required for controlling the direction of the RC car.
A pair of PWM channels are required for defining rotation speed and direction of the DC motors on each side. A pair of PWM channels are required for defining rotation speed and direction of the DC motors on each side.
In particular, GPIO6 and GPIO5 provide PWM to the left- and right- side DC motors to rotate in a clockwise direction. In particular, GPIO6 and GPIO5 provide PWM to the left- and right- side DC motors to rotate in a clockwise direction.
Similarly, GPIO4 and GPIO7 provide PWM to the left- and right- side DC motors to rotate in a counter-clockwise direction. Similarly, GPIO4 and GPIO7 provide PWM to the left- and right- side DC motors to rotate in a counter-clockwise direction.
Changing PWM on each channel determines the speed and direction of the RC car. Changing PWM on each channel determines the speed and direction of the RC car.
</p> </p>
<table class="docutils align-default"> <table class="docutils align-default">
<thead> <thead>
<tr class="row-odd"> <tr class="row-odd">
<th class="head"> <th class="head">
<p> <p>
GPIO GPIO
</p> </p>
</th> </th>
<th class="head"> <th class="head">
<p> <p>
Pin Pin
</p> </p>
</th> </th>
<th class="head"> <th class="head">
<p> <p>
Function Function
</p> </p>
</th> </th>
<th class="head"> <th class="head">
<p> <p>
Notes Notes
</p> </p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr class="row-even"> <tr class="row-even">
<td> <td>
<p> <p>
0 0
</p> </p>
</td> </td>
<td> <td>
<p> <p>
16 16
</p> </p>
</td> </td>
<td> <td>
<p> <p>
Joystick x-axis Joystick x-axis
</p> </p>
</td> </td>
<td> <td>
<p> <p>
ADC1_CH0 ADC1_CH0
</p> </p>
</td> </td>
</tr> </tr>
<tr class="row-odd"> <tr class="row-odd">
<td> <td>
<p> <p>
1 1
</p> </p>
</td> </td>
<td> <td>
<p> <p>
15 15
</p> </p>
</td> </td>
<td> <td>
<p> <p>
Joystick y-axis Joystick y-axis
</p> </p>
</td> </td>
<td> <td>
<p> <p>
ADC1_CH1 ADC1_CH1
</p> </p>
</td> </td>
</tr> </tr>
<tr class="row-even"> <tr class="row-even">
<td> <td>
<p> <p>
8 8
</p> </p>
</td> </td>
<td> <td>
<p> <p>
5 5
</p> </p>
</td> </td>
<td> <td>
<p> <p>
Joystick push button Joystick push button
</p> </p>
</td> </td>
<td> <td>
</td> </td>
</tr> </tr>
<tr class="row-odd"> <tr class="row-odd">
<td> <td>
<p> <p>
6 6
</p> </p>
</td> </td>
<td> <td>
<p> <p>
4 4
</p> </p>
</td> </td>
<td> <td>
<p> <p>
PWM for clockwise rotation of left-side motors PWM for clockwise rotation of left-side motors
</p> </p>
</td> </td>
<td> <td>
<p> <p>
LEDC_CHANNEL_1 LEDC_CHANNEL_1
</p> </p>
</td> </td>
</tr> </tr>
<tr class="row-even"> <tr class="row-even">
<td> <td>
<p> <p>
5 5
</p> </p>
</td> </td>
<td> <td>
<p> <p>
3 3
</p> </p>
</td> </td>
<td> <td>
<p> <p>
PWM for clockwise rotation of right-side motors PWM for clockwise rotation of right-side motors
</p> </p>
</td> </td>
<td> <td>
<p> <p>
LEDC_CHANNEL_0 LEDC_CHANNEL_0
</p> </p>
</td> </td>
</tr> </tr>
<tr class="row-odd"> <tr class="row-odd">
<td> <td>
<p> <p>
4 4
</p> </p>
</td> </td>
<td> <td>
<p> <p>
2 2
</p> </p>
</td> </td>
<td> <td>
<p> <p>
PWM for counter-clockwise rotation of right-side motors PWM for counter-clockwise rotation of right-side motors
</p> </p>
</td> </td>
<td> <td>
<p> <p>
LEDC_CHANNEL_2 LEDC_CHANNEL_2
</p> </p>
</td> </td>
</tr> </tr>
<tr class="row-even"> <tr class="row-even">
<td> <td>
<p> <p>
7 7
</p> </p>
</td> </td>
<td> <td>
<p> <p>
6 6
</p> </p>
</td> </td>
<td> <td>
<p> <p>
PWM for counter-clockwise rotation of left-side motors PWM for counter-clockwise rotation of left-side motors
</p> </p>
</td> </td>
<td> <td>
<p> <p>
LEDC_CHANNEL_3 LEDC_CHANNEL_3
</p> </p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</section>
</section> </section>
<section id="schematic"> <section id="schematic">
<h3> <h3>