Add troubleshooting docs

TrossenRobotics · May 22, 2024 · 3f9ecb1 · 3f9ecb1
1 parent ed3fbd4
commit 3f9ecb1
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,6 +11,7 @@ What's Here
 
 * :doc:`specifications` - Specifications for the SLATE mobile base.
 * :doc:`getting_started` - Guides to walk you through the process of setting up your SLATE mobile base.
+* :doc:`troubleshooting` - Small guides to walk users through possible issues that may occur when using the SLATE mobile base.
 
 Table of Contents
 =================
@@ -20,3 +21,4 @@ Table of Contents
 
   specifications.rst
   getting_started.rst
+  troubleshooting.rst
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
@@ -0,0 +1,14 @@
+===============
+Troubleshooting
+===============
+
+SLATE driver can't connect to base
+==================================
+
+The USB-Serial converter device shares the same vendor and product ID with a brail readers.
+Because of this, the ``brltty`` program will claim the device, preventing its use by other drivers.
+Solving this issue is as simple as removing the package using apt.
+
+.. code-block:: bash
+
+  $ sudo apt-get remove brltty