docs(troubleshoot-guide): Add section on troubleshooting serial data …

…transmission permission issues for Linux users. (espressif#56) Co-authored-by: Rushikesh Patange <rushikesh.patange@espressif.com>
RushikeshPatange · Dec 7, 2023 · 9973590 · 9973590
1 parent 0e6ec9a
commit 9973590
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/minimal-launchpad/index.html b/minimal-launchpad/index.html
@@ -63,6 +63,19 @@ <h4 class="topic mb-2" style="font-size: 14px;"><b>Device Connection
                                                         disconnect it and try again.
                                                     </p>
                                                 </div>
+                                                <div class="col-xs-12 mt-2">
+                                                    <h4 class="topic mb-2" style="font-size: 14px;">
+                                                        <b>Serial Data Transmission Permission Issue</b>
+                                                    </h4>
+                                                    <div class="mb-3">
+                                                        For linux users, the currently logged in user should have read and write access the serial port over USB. On most Linux
+                                                        distributions, this is done by adding the user to dialout group with the following command:
+                                                        <div class="command-snippet"> usermod -a -G dialout $USER </div>
+                                                        on Arch Linux this is done by adding the user to uucp group with the following command:
+                                                        <div class="command-snippet"> sudo usermod -a -G uucp $USER </div>
+                                                        Make sure you re-login to enable read and write permissions for the serial port.
+                                                    </div>
+                                                </div>
                                                 <div class="col-xs-12 mt-2">
                                                     <h4 class="topic mb-2" style="font-size: 14px;"><b>Browser Compatability
                                                             Issue</b></h4>

diff --git a/minimal-launchpad/minimal_ui_styles.css b/minimal-launchpad/minimal_ui_styles.css
@@ -86,6 +86,13 @@
   color: #a35c5c;
   padding: 5px;
 }
+
+.command-snippet {
+  padding: 10px;
+  background-color: #eee;
+  margin: 5px 5px 5px 0;
+}
+
 @keyframes bounce {
 
   0%,