From 837d8718bf2c664656dfa69ff723369081e3c862 Mon Sep 17 00:00:00 2001
From: Jose Antonio Moral <joseantoniomoralparras@gmail.com>
Date: Mon, 14 Dec 2020 07:39:41 +0100
Subject: [PATCH] Add steps for estalishing a serial connection (#45)

---
 snap/snapcraft.yaml | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index f5fb9e7..377acfb 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -71,6 +71,35 @@ description: |
 
         $ snap set micro-ros-agent device="device path"
 
+  When using the snap with a serial device, some steps need to be taken
+  in order to establish a successful connection:
+
+  * Refresh your local installation of the snap `core` package:
+
+        $ sudo snap refresh core --edge
+
+  * Enable the hotplug feature and restart the `snapd` daemon:
+
+        $ sudo snap set core experimental.hotplug=true
+        $ sudo systemctl restart snapd
+
+  * After plugging the microcontroller to the serial port, execute
+    the `snap interface serial-port` command. You should see something
+    like this:
+
+          name:    serial-port
+          summary: allows accessing a specific serial port
+          plugs:
+            - micro-ros-agent
+          slots:
+          - snapd:cp2102cp2109uartbrid (allows accessing a specific serial port)
+
+  * Connect your snap image to the desired serial port (replace accordingly):
+
+        $ snap connect micro-ros-agent:serial-port snapd:cp2102cp2109uartbrid
+
+  After this, you can execute your snap as usual,
+  using `sudo micro-ros-agent serial -d <serial-dev>`.
 
 grade: stable
 confinement: strict