Merge pull request #121 from martinohanlon/dev

v1.3.1
martinohanlon · Jan 1, 2019 · a90a3c8 · a90a3c8
2 parents fe8b255 + 9e1711b
commit a90a3c8
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 17 deletions.
diff --git a/bluedot/mock.py b/bluedot/mock.py
@@ -157,14 +157,24 @@ def __init__(self,
             auto_connect)
 
     def connect(self):
+        """
+        Connect to a Bluetooth server.
+        """
         self._server.mock_client_connected(self)
         self._connected = True
 
     def disconnect(self):
+        """
+        Disconnect from a Bluetooth server.
+        """
         self._server.mock_client_disconnected()
         self._connected = False
 
     def mock_server_sending_data(self, data):
+        """
+        Simulates a server sending data to the
+        :class:`~.btcomm.BluetoothClient`.
+        """
         if self._connected:
             self._data_received_callback(data)
 
@@ -259,7 +269,7 @@ def launch_mock_app(self):
 
         The mock app uses pygame which will need to be installed.
         """
-        self._mock_app_thread = WrapThread(target=self._launch_mock_app2)
+        self._mock_app_thread = WrapThread(target=self._launch_mock_app)
         self._mock_app_thread.start()
 
     def _launch_mock_app(self):

diff --git a/docs/btcommapi.rst b/docs/btcommapi.rst
@@ -25,9 +25,3 @@ BluetoothAdapter
 
 .. autoclass:: BluetoothAdapter
 
-MockBluetoothServer
--------------------
-
-.. module:: bluedot.mock
-
-.. autoclass:: MockBluetoothServer
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -6,6 +6,11 @@ Change log
 Bluedot Python library
 ----------------------
 
+1.3.1 - 2019-01-01
+~~~~~~~~~~~~~~~~~~
+
+ * minor bug fix to launch_mock_app
+
 1.3.0 - 2018-12-30
 ~~~~~~~~~~~~~~~~~~
 

diff --git a/docs/dotapi.rst b/docs/dotapi.rst
@@ -27,8 +27,3 @@ BlueDotRotation
 ---------------
 
 .. autoclass:: BlueDotRotation
-
-MockBlueDot
------------
-
-.. autoclass:: MockBlueDot
diff --git a/docs/images/mockbluedot.png b/docs/images/mockbluedot.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ Table of Contents
    bluedotpythonapp
    dotapi
    btcommapi
+   mockapi
    protocol
    build
    changelog
diff --git a/docs/mockapi.rst b/docs/mockapi.rst
@@ -0,0 +1,22 @@
+Mock API
+========
+Blue Dot also contains a useful :mod:`mock` API for simulating Blue Dot and
+bluetooth comms. This is useful for testing and allows for prototyping
+without having to use a Blue Dot client.
+
+.. module:: bluedot.mock
+
+MockBlueDot
+-----------
+
+.. autoclass:: MockBlueDot
+
+MockBluetoothServer
+-------------------
+
+.. autoclass:: MockBluetoothServer
+
+MockBluetoothClient
+-------------------
+
+.. autoclass:: MockBluetoothClient
diff --git a/examples/mock_app_debug.py b/examples/mock_app_debug.py
@@ -19,7 +19,7 @@ def moved(pos):
 mbd.start()
 
 #launch a mock app
-mbd.launch_mock_app2()
+mbd.launch_mock_app()
 
 try:
     while True:

diff --git a/setup.py b/setup.py
@@ -12,7 +12,7 @@
 
 __project__ = 'bluedot'
 __desc__ = 'A zero boiler plate bluetooth remote'
-__version__ = '1.3.0'
+__version__ = '1.3.1'
 __author__ = "Martin O'Hanlon"
 __author_email__ = 'martin@ohanlonweb.com'
 __license__ = 'MIT'
@@ -49,15 +49,15 @@
 
 1. Install
 
-```bash
+```
 sudo pip3 install bluedot
 ```
 
 2. Get the [Android Blue Dot app](http://play.google.com/store/apps/details?id=com.stuffaboutcode.bluedot) or use the [Python Blue Dot app](http://bluedot.readthedocs.io/en/latest/bluedotpythonapp.html)
 
 3. Pair your Raspberry Pi
 
-4. Write some code:
+4. Write some code
 
 ```python
 from bluedot import BlueDot
@@ -82,7 +82,7 @@
 
 ## Even more
 
-The [online documentation](http://bluedot.readthedocs.io/en/latest/) describes how to use Blue Dot and the Python library including Recipes and ideas.
+The [online documentation](http://bluedot.readthedocs.io/en/latest/) describes how to use Blue Dot and the Python library including recipes and ideas.
 
 """
 
@@ -97,6 +97,7 @@
           author_email = __author_email__,
           license= __license__,
           keywords=__keywords__,
+          classifiers=__classifiers__,
           packages = [__project__],
           #install_requires = __requires__,
           entry_points={