Fixes bug on serial_message_container

Enhances documentation
pybpod · Jan 19, 2017 · a494147 · a494147
1 parent 5488016
commit a494147
Show file tree

Hide file tree

Showing 10 changed files with 65 additions and 28 deletions.
diff --git a/docs/source/api_reference/com/index.rst b/docs/source/api_reference/com/index.rst
@@ -1,6 +1,6 @@
-**********************
-Communication Protocol
-**********************
+*************
+Communication
+*************
 
 Contents:
 
@@ -10,4 +10,5 @@ Contents:
    protocol
    message_headers
    arcom
-   hw_info_container
+   hw_info_container
+   serial_message_container
diff --git a/docs/source/api_reference/com/protocol.rst b/docs/source/api_reference/com/protocol.rst
@@ -1,6 +1,6 @@
-=================
-Protocol Commands
-=================
+===========================
+Requesting Commands to Bpod
+===========================
 
 .. contents:: Contents
     :local:

diff --git a/docs/source/api_reference/com/serial_message_container.rst b/docs/source/api_reference/com/serial_message_container.rst
@@ -0,0 +1,24 @@
+========================
+Serial Message Container
+========================
+
+.. contents:: Contents
+    :local:
+
+--------
+Overview
+--------
+
+This container is used to store serial message information.
+
+.. seealso::
+    :meth:`pybpodapi.com.protocol.Protocol.load_serial_message`
+
+--------------
+Implementation
+--------------
+
+
+.. autoclass:: pybpodapi.com.serial_message_container.SerialMessageContainer
+    :members:
+    :private-members:
diff --git a/docs/source/api_reference/hardware/index.rst b/docs/source/api_reference/hardware/index.rst
@@ -1,5 +1,6 @@
-Hardware description
-====================
+********
+Hardware
+********
 
 Contents:
 

diff --git a/docs/source/api_reference/model/bpod.rst b/docs/source/api_reference/model/bpod.rst
@@ -1,21 +1,21 @@
 .. _bpod-class-label:
 
-****
+====
 Bpod
-****
+====
 
 .. contents:: Contents
     :local:
 
 Overview
-========
+--------
 
 TODO
 
 Implementation
-==============
+--------------
 
 
-.. automodule:: pybpodapi.model.bpod
+.. autoclass:: pybpodapi.model.bpod.Bpod
     :members:
     :private-members:
diff --git a/docs/source/api_reference/model/index.rst b/docs/source/api_reference/model/index.rst
@@ -1,10 +1,11 @@
-Entities Model
-==============
+********
+Entities
+********
 
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 4
 
    bpod
    state_machine

diff --git a/docs/source/api_reference/model/session.rst b/docs/source/api_reference/model/session.rst
@@ -1,19 +1,18 @@
-*******
+=======
 Session
-*******
+=======
 
 .. contents:: Contents
     :local:
 
 Overview
-========
+--------
 
 TODO
 
 Implementation
-==============
+--------------
 
-
-.. automodule:: pybpodapi.model.session
+.. autoclass:: pybpodapi.model.session.Session
     :members:
     :private-members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -48,9 +48,12 @@
     'sphinx.ext.todo',
     'sphinx.ext.viewcode']
 
-# Do not sort autodoc alphabetically, use source code appearance order
+# Do not sort autodoc alphabetically, use source code appearance order.
 autodoc_member_order= 'bysource'
 
+# Both the class’ and the __init__ method’s docstring are concatenated and inserted.
+autoclass_content = 'both'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,7 +13,7 @@ Welcome to pybpod-api's documentation!
    All examples and Bpod's state machine and communication logic were based on the original version made available by `Josh Sanders (Sanworks) <https://github.com/sanworks>`_.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 4
 
    getting_started
    writing_protocols

diff --git a/pybpodapi/com/serial_message_container.py b/pybpodapi/com/serial_message_container.py
@@ -12,15 +12,22 @@ class SerialMessageContainer(object):
 	"""
 
 	def __init__(self, serial_channel, message_ID, serial_message, n_messages=1):
+		"""
+
+		:param int serial_channel: UART port to trigger
+		:param int message_ID: byte parameter that triggers UART port
+		:param list(int) serial_message: 3-byte message to send to UART port
+		:param n_messages: TODO
+		"""
 
 		if len(serial_message) > 3:
 			raise SerialMessageContainerError('Error: Serial messages cannot be more than 3 bytes in length.')
 
 		if message_ID > 255 or message_ID < 1:
 			raise SerialMessageContainerError('Error: Bpod can only store 255 serial messages (indexed 1-255).')
 
-		self.serial_channel = serial_channel - 1 # type: int
-		self.message_ID = message_ID # type: int
+		self.serial_channel = serial_channel - 1  # type: int
+		self.message_ID = message_ID  # type: int
 		self.serial_message = serial_message
 		self.n_messages = n_messages
 
@@ -30,7 +37,8 @@ def format_for_sending(self):
 
 		:rtype: list(int)
 		"""
-		return [self.serial_message - 1, self.n_messages, self.message_ID, len(self.serial_message)] + self.serial_message
+		return [self.serial_channel, self.n_messages, self.message_ID, len(self.serial_message)] + self.serial_message
+
 
 class SerialMessageContainerError(Exception):
 	pass