esp32

content/posts/esp32-bootmode-selection.md

@@ -0,0 +1,61 @@
+---
+title: ESP32 Automatic Bootmode Selection
+date: 2022-09-16
+categories: ['Software']
+tags: ['software', 'microcontroller', 'esp32']
+figref: True
+mathjax: True
+---
+
+Most ESP32 boards you can buy have a small circuit between the USB-Serial converter and the ESP32 itself to facilitate the procedure of writing new programs to the microcontroller. The general concept is that the ESP32 gets reset as soon as a serial connection will be created and the bootmode-selection pin gets pulled low to select the download-bootmode.
+
+The reset circuit in {{< figref circuit >}} looks quite simple, doesn't it? In fact, getting it working gave me some headaches. In the end probably because I was sloppy with the wires and it had nothing to do with the overall procedure at all. Whatsoever, it made me investigate the procedure of auto-resetting and auto-bootmode-selection in detail.
+
+{{< centerfigure id="circuit" src="/images/esp32-bootmode-circuit.png" width="50%" caption="The often used reset circuit to boot into the bootloader. This makes writing the a program to the flash memory possible without manual interaction." >}}
+
+Actually, {{< figref circuit >}} shows only one half of the reset and bootmode-selection circuitry. But we stick with the first half for now. It might be useful to extend the picture a bit though. Let's imagine we have a USB-Serial-Converter to connect our computer to the ESP32. The converter will have Tx and Rx pins of course but it also has a (amongst others) a {{< overlinecode RTS >}} and a {{< overlinecode DTR >}} pin. Originally these were used for flow control with for example modems. `RTS` means Request to Send. This way the computer tells the modem it would like to send data. The modem would signal its readiness to receive data with the Clear to Send (`CTS`) signal. `DTR` stand for Data Terminal Ready. The purpose of this line is to signal the modem readyness of our computer.
+
+Since we do not communicate with a modem, we do not care much about the original meaning of these signals. We just use the inverted `DTR` and `RTS` outputs of the USB-Serial-Converter to control the states of the `ENABLE` (sometimes also called {{< overlinecode RESET >}}) and the `GPIO0` pins. The following table displays the output states `EN` and `GPIO0` dependent on the inputs {{< overlinecode DTR >}} and {{< overlinecode RTS >}}. The parentheses indicate weak levels. The circuit in {{< figref circuit >}} is only able to pull the outputs low actively. Due to the fact, that the outputs are pulled high by internal or external pull-up resistors, we get defined output states. The x for `GPIO0` indicates that we do not care about its state while the `EN` pin is pulled low. Therefore the ESP32 is in reset state and the GPIO0 does not matter at all. But for the curious ones: it will be probably low during reset as we will see in a moment.
+{{< table >}}
+| State | !DTR | !RTS | EN | GPIO0 |
+| ---- | ---- | ---- | ----- | ---- |
+| 11 | 1 | 1 | (1) | (1) |
+| 10 | 1 | 0 | 0 | x |
+| 01 | 0 | 1 | (1) | 0 |
+| 00 | 0 | 0 | (1) | (1) |
+{{< /table >}}
+
+So far so bad. Have you spotted the problem? Remember what we want to achieve? Reset the ESP32 and reboot in the download mode to write our program to the flash. This has to be done by following this sequence:
+- Pull `EN` low
+- Pull `GPIO0` low while releasing `EN`
+
+And since **of course** we **do** read the f... manual, we know that `GPIO0` needs to be pulled down from at least the moment `EN` reaches `$ V_{IL\_\overline{RST}} = 0.6\,\text{V}$` for at least `$1\,\text{ms}$`. So a problem occures when we transition from state `10` to state `01`. Imagine we could switch {{< overlinecode RTS >}} and {{< overlinecode DTR >}} in no time. In this hypothetical case everything would be fine. The same moment the `EN` line goes high and enables the chip, the `GPIO0` line goes low and select the download boot mode. But in reality sometimes things are bad and in this case *bad* means, {{< overlinecode RTS >}} and {{< overlinecode DTR >}} will change their levels sequentially. It does not matter in which order we switch these lines. The transition order would bei `10 -> 11 -> 01` or `10 -> 00 -> 01` and state `00` and `11` both produce the same output, where the ESP32 is enabled but `GPIO0` is not pulled down to select the download boot mode.
+
+Fortunately, the solution to this problem is quite simple. We place a capacitor between `EN` and `GND` in parallel to the pullup resistor. This RC-Circuit slows down the rise of the `EN` voltage level `$V_{EN}$` as follows `\[V_{EN}(t) = V_{\textrm{CC}}\left(1-e^{-\frac{t}{RC}}\right)\]` where `$V_{CC}$` is the supply voltage, `$R$` the resistance of the pull-up resistor and `$C$` the capacitance of the afore mentioned capacitor.
+
+The procedure has been recorded with an oscilloscpe and is depicted in {{< figref plot >}}. As soon as the `esptool` script aquires the serial port, `RTS` and `DTR` are set to `true` which means {{< overlinecode RTS >}} and {{< overlinecode DTR >}} are `false` or low obviously. This point in time is marked as `$t_{\textrm{0}}$`. 
+
+{{< plotly id="plot" src="esp32-bootmode-selection" caption="This is some caption" >}}
+
+To reset the ESP32 the script executes the following code at `$t_{\textrm{1}}$`:
+
+~~~ python
+self._setDTR(False)  # IO0=HIGH
+self._setRTS(True)  # EN=LOW, chip in reset
+time.sleep(0.1)
+~~~
+The chip is held in reset state for `$100\,\textrm{ms}$`. Then the `esptool` toogles `DTR` and `RTS` sequentially at `$t_{\textrm{2}}$`
+
+~~~ python
+self._setDTR(True)  # IO0=LOW
+self._setRTS(False)  # EN=HIGH, chip out of reset
+time.sleep(delay) # delay=0.05
+~~~
+
+We can see, that the level of `EN` rises slowly with a very soft edge. This give the `esptool` enough time to make sure `GPIO0` is pulled down before the ESP32 starts to boot. Without the RC-Circuit `EN` would have a very steep edge at `$t_{\textrm{2}}$` and we would see a short high pulse in the `GPIO0` level in the upper plot in {{< figref plot >}}. This pulse would lead to the ESP32 selecting the normal and not the donwload bootmode.
+
+At `$t_{\textrm{3}}$` `DTR` gets released as well, which means we finally end up with both {{< overlinecode RTS >}} and {{< overlinecode DTR >}} beeing high and both controlled transistors are in high impedance mode.
+
+~~~ python
+self._setDTR(False)  # IO0=HIGH, done
+~~~

layouts/partials/foot_custom.html

@@ -0,0 +1,42 @@
+{{ if .Params.mathjax }}
+
+<script>
+    MathJax = {
+        tex: {
+            inlineMath: [['$', '$'], ['\\(', '\\)']],
+            displayMath: [['$$', '$$'], ['\\[', '\\]']],
+            processEscapes: true,
+            processEnvironments: true
+        },
+        options: {
+            skipHtmlTags: ['script', 'noscript', 'style', 'textarea', 'pre']
+        }
+    };
+
+    window.addEventListener('load', (event) => {
+        document.querySelectorAll("mjx-container").forEach(function (x) {
+            x.parentElement.classList += 'has-jax'
+        })
+    });
+
+</script>
+
+<script type="text/x-mathjax-config">
+        MathJax.Hub.Queue(function() {
+            // Fix <code> tags after MathJax finishes running. This is a
+            // hack to overcome a shortcoming of Markdown. Discussion at
+            // https://github.com/mojombo/jekyll/issues/199
+            var all = MathJax.Hub.getAllJax(), i;
+            for(i = 0; i < all.length; i += 1) {
+                all[i].SourceElement().parentNode.className += ' has-jax';
+            }
+        });
+    </script>
+<script type="text/javascript" id="MathJax-script" async
+    src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
+{{ end }}
+
+{{ if .Params.figref }}
+<script src="https://code.jquery.com/jquery-3.5.0.js"></script>
+<script src="/js/figref.js"></script>
+{{ end }}

layouts/shortcodes/centerfigure.html

@@ -0,0 +1,10 @@
+<figure id='{{ .Get "id" }}'>
+    <div style="display: flex;justify-content: center">
+        <img src='{{ .Get "src" }}'
+            {{- with .Get "width" }} width="{{ . }}" {{end}}
+            {{- with .Get "height" }} height="{{ . }}" {{end}} />
+    </div>
+    {{ with (.Get "caption") -}}
+        <figcaption>{{ . }}</figcaption>
+    {{- end }}
+</figure>

layouts/shortcodes/figref.html

@@ -0,0 +1 @@
+<a class="figref" href="#{{ .Get 0 }}"></a>

layouts/shortcodes/overline.html

@@ -0,0 +1 @@
+<span style="text-decoration:overline">{{ .Get 0 }}</span>

layouts/shortcodes/overlinecode.html

@@ -0,0 +1 @@
+<code><span style="text-decoration:overline">{{ .Get 0 }}</span></code>

layouts/shortcodes/plotly.html

@@ -0,0 +1,7 @@
+{{ $r := resources.Get (printf "plotly/%s.html" ($.Get "src")) }}
+<figure id='{{.Get "id" }}'>
+{{ $r.Content | safeHTML }}
+    {{- with (.Get "caption") -}}
+        <figcaption>{{ . }}</figcaption>
+    {{- end }}
+</figure>

layouts/shortcodes/table.html

@@ -1,6 +1,6 @@
 {{ $htmlTable := .Inner | markdownify }}
 {{ $class := .Get 0 }}
 {{ $old := "<table>" }}
-{{ $new := printf "<table class=\"%s\">" $class }}
+{{ $new := printf "<table cellspacing='0' class=\"%s\">" $class }}
 {{ $htmlTable := replace $htmlTable $old $new }}
 {{ $htmlTable | safeHTML }}

static/css/fonts.css

@@ -3,5 +3,5 @@ body {
 }
 code {
   font-family: "DejaVu Sans Mono", monospace;
-  /* font-size: 85%; */
+  font-size: 85%;
 }

static/css/style.css

@@ -6,17 +6,33 @@ body {
 }
 
 /* header and footer areas */
-.menu { padding: 0; }
+.menu {
-.menu li { display: inline-block; }
+  padding: 0;
+}
+
+.menu li {
+  display: inline-block;
+}
+
 .article-meta, .menu a {
   text-decoration: none;
   background: #eee;
   padding: 5px;
   border-radius: 5px;
 }
-.menu, .article-meta, footer { text-align: center; }
+
-.title { font-size: 1.1em; }
+.menu, .article-meta, footer {
-footer a { text-decoration: none; }
+  text-align: center;
+}
+
+.title {
+  font-size: 1.1em;
+}
+
+footer a {
+  text-decoration: none;
+}
+
 hr {
   border-style: dashed;
   color: #ddd;
@@ -29,6 +45,7 @@ pre {
   padding: 1em;
   overflow-x: auto;
 }
+
 code {
   background: #afb8c133;
   padding-left: 5px;
@@ -37,11 +54,20 @@ code {
   padding-bottom: 3px;
   border-radius: 6px
 }
-pre code { background: none; }
+
+pre code {
+  background: none;
+}
 
 /* misc elements */
-img, iframe, video { max-width: 100%; }
+img, iframe, video {
-main { hyphens: auto; }
+  max-width: 100%;
+}
+
+main {
+  hyphens: auto;
+}
+
 blockquote {
   background: #f9f9f9;
   border-left: 5px solid #ccc;
@@ -50,9 +76,43 @@ blockquote {
 
 table {
   margin: auto;
-  border-top: 1px solid #666;
+}
+
+table thead th {
   border-bottom: 1px solid #666;
 }
-table thead th { border-bottom: 1px solid #ddd; }
+
-th, td { padding: 5px; }
+th, td {
-thead, tfoot, tr:nth-child(even) { background: #eee; }
+  padding: 5px;
+  text-align: center;
+}
+
+/* tr:nth-child(even) {
+  background: #f0f0f0;
+} */
+
+figcaption {
+  font: italic smaller sans-serif;
+  padding: 3px;
+  text-align: center;
+}
+
+figure {
+  /* border: #666 solid; */
+  display: flex;
+  flex-flow: column;
+  padding: 5px;
+  margin: auto;
+  text-align: center;
+}
+
+html, body {
+  scroll-padding-top: 100px;
+}
+
+code.has-jax {
+  font: inherit;
+  font-size: 100%;
+  background: inherit;
+  border: inherit;
+}

static/js/figref.js

@@ -0,0 +1,30 @@
+$(function() {
+    var figure = 0;
+    $(this).find("figure").each(function() {
+        figure++;
+        var s = "Fig. " + figure;
+        $(this).attr('figure_number', figure);
+        $(this).find('figcaption').each(function() {
+            var text = s + ' ' + $(this).text();
+            $(this).text(text);
+        })
+    });
+});
+
+$(function() {
+    $("a.figref").each(function() {
+        var attribute_name = 'figure_number';
+        var selector = $(this).attr('href');
+        var $figure = $(selector);
+        var s = $figure.attr('figure_number');
+        if (typeof s == 'undefined' || s == false) {
+            var id = $(this).attr('id')
+            console.log(`Could not get attribute [${attribute_name}] for element with id [${id}]`)
+            s = 'Fig. ?'
+        } else {
+            s = `Fig. ${s}`
+        }
+        $(this).text(s);
+        $(this).css('font-weight', 'bold');
+    });
+});