merge sucks example

Pipfile

@@ -23,6 +23,7 @@ autoflake = "*"
 pytest-env = "*"
 pytest = "==5.0.1"
 pytest-asyncio = "*"
+mkdocs = "*"
 
 [pipenv]
 allow_prereleases = true

docs/Use_With_Sucks.md

@@ -10,4 +10,37 @@ At this time you'll need to use the bmartin5692 fork of sucks.  Especially if yo
 
 OR
 
-- You can use Sucks as a library from your own script, see the [example script](../examples/sucks.py)
+- You can use Sucks as a library from your own script, for details see the [sucks project](https://github.com/wpietri/sucks)
+
+```python
+#!/usr/bin/env python3
+
+from sucks import *
+
+
+class BumperVacBot(VacBot):
+    def __init__(self, server_address):
+        self.server_address = server_address
+        vacuum = {"did": "none", "class": "none"}
+        super().__init__("sucks", "ecouser.net", "", "", vacuum, "")
+
+    def connect_and_wait_until_ready(self):
+        logging.info("connecting")
+        self.xmpp.connect(self.server_address)
+        self.xmpp.process()
+        self.xmpp.wait_until_ready()
+
+
+logging.basicConfig(level=logging.DEBUG, format="%(levelname)-8s %(message)s")
+server_address = ("xxx.xxx.xxx.xxx", 5223)
+
+# Initialize
+vacbot = BumperVacBot(server_address)
+
+# Connect
+vacbot.connect_and_wait_until_ready()
+
+# Send a command
+vacbot.run(Clean())
+
+```

docs/index.md

@@ -39,3 +39,9 @@ For more information on generating certificates manually, see the [Creating Cert
 	- **Note:** Some models may require removing and re-inserting the battery pack.
 	- This doesn't seem to be required for models that don't have easily accessible batteries such as the 900/901.
 - If your configuration is correct, the robot will connect to Bumper within about 30 seconds. Bumper will output information about the connection status. 
+
+# Troubleshooting
+
+Logs are output in the /logs directory.
+
+If there is an issue, enable debug logging with the `--debug` switch for additional detail.

examples/sucks.py

@@ -1,29 +0,0 @@
-#!/usr/bin/env python3
-
-from sucks import *
-
-
-class BumperVacBot(VacBot):
-    def __init__(self, server_address):
-        self.server_address = server_address
-        vacuum = {"did": "none", "class": "none"}
-        super().__init__("sucks", "ecouser.net", "", "", vacuum, "")
-
-    def connect_and_wait_until_ready(self):
-        logging.info("connecting")
-        self.xmpp.connect(self.server_address)
-        self.xmpp.process()
-        self.xmpp.wait_until_ready()
-
-
-logging.basicConfig(level=logging.DEBUG, format="%(levelname)-8s %(message)s")
-server_address = ("xxx.xxx.xxx.xxx", 5223)
-
-# Initialize
-vacbot = BumperVacBot(server_address)
-
-# Connect
-vacbot.connect_and_wait_until_ready()
-
-# Send a command
-vacbot.run(Clean())