.

pybpod · Dec 29, 2017 · 759dd34 · 759dd34
1 parent fe80f20
commit 759dd34
Show file tree

Hide file tree

Showing 8 changed files with 93 additions and 13 deletions.
diff --git a/docs/source/api_reference/pybpodapi/bpod/index.rst b/docs/source/api_reference/pybpodapi/bpod/index.rst
@@ -41,11 +41,3 @@ Hardware module
 |
 |
 
-Communication module
----------------------
-
-.. toctree::
-   :titlesonly:
-
-   com/index
-
diff --git a/...pi_reference/pybpodapi/bpod/com/arcom.rst → ...rce/api_reference/pybpodapi/com/arcom.rst b/...pi_reference/pybpodapi/bpod/com/arcom.rst → ...rce/api_reference/pybpodapi/com/arcom.rst
@@ -18,6 +18,6 @@ Implementation
 --------------
 
 
-.. automodule:: pybpodapi.bpod.com.arcom
+.. automodule:: pybpodapi.com.arcom
     :members:
     :private-members:
diff --git a/...pi_reference/pybpodapi/bpod/com/index.rst → ...rce/api_reference/pybpodapi/com/index.rst b/...pi_reference/pybpodapi/bpod/com/index.rst → ...rce/api_reference/pybpodapi/com/index.rst
@@ -2,12 +2,13 @@
 :mod:`com`--- Communication
 ***************************
 
-.. module:: pybpodapi.bpod.com
+.. module:: pybpodapi.com
    :synopsis: communication with Bpod device
 
 .. toctree::
    :titlesonly:
 
+   messaging/index
    arcom
    protocol/send_msg_headers
    protocol/recv_msg_headers

diff --git a/docs/source/api_reference/pybpodapi/com/messaging/index.rst b/docs/source/api_reference/pybpodapi/com/messaging/index.rst
@@ -0,0 +1,79 @@
+.. _messaging-class-label:
+
+*********************************************************************
+:mod:`messaging`--- Types of messages
+*********************************************************************
+
+
+BaseMessage
+__________________________________
+
+
+.. autoclass:: pybpodapi.com.messaging.base_message.BaseMessage
+    :members:
+    :undoc-members:
+
+EndTrial
+__________________________________
+
+
+.. autoclass:: pybpodapi.com.messaging.end_trial.EndTrial
+    :members:
+    :undoc-members:
+
+EventOccurrence
+__________________________________
+
+
+.. autoclass:: pybpodapi.com.messaging.event_occurrence.EventOccurrence
+    :members:
+    :undoc-members:
+
+EventResume
+__________________________________
+
+
+.. autoclass:: pybpodapi.com.messaging.event_resume.EventResume
+    :members:
+    :undoc-members:
+
+SessionInfo
+__________________________________
+
+
+.. autoclass:: pybpodapi.com.messaging.session_info.SessionInfo
+    :members:
+    :undoc-members:
+
+SoftcodeOccurrence
+__________________________________
+
+
+.. autoclass:: pybpodapi.com.messaging.softcode_occurrence.SoftcodeOccurrence
+    :members:
+    :undoc-members:
+
+StateOccurrence
+__________________________________
+
+
+.. autoclass:: pybpodapi.com.messaging.state_occurrence.StateOccurrence
+    :members:
+    :undoc-members:
+
+Trial
+__________________________________
+
+
+.. autoclass:: pybpodapi.com.messaging.trial.Trial
+    :members:
+    :undoc-members:
+
+UntaggedMessage
+__________________________________
+
+
+.. autoclass:: pybpodapi.com.messaging.untagged_message.UntaggedMessage
+    :members:
+    :undoc-members:
+
diff --git a/...pi/bpod/com/protocol/recv_msg_headers.rst → ...bpodapi/com/protocol/recv_msg_headers.rst b/...pi/bpod/com/protocol/recv_msg_headers.rst → ...bpodapi/com/protocol/recv_msg_headers.rst
@@ -18,6 +18,6 @@ Implementation
 --------------
 
 
-.. automodule:: pybpodapi.bpod.com.protocol.recv_msg_headers
+.. automodule:: pybpodapi.com.protocol.recv_msg_headers
     :members:
     :private-members:
diff --git a/...pi/bpod/com/protocol/send_msg_headers.rst → ...bpodapi/com/protocol/send_msg_headers.rst b/...pi/bpod/com/protocol/send_msg_headers.rst → ...bpodapi/com/protocol/send_msg_headers.rst
@@ -18,6 +18,6 @@ Implementation
 --------------
 
 
-.. automodule:: pybpodapi.bpod.com.protocol.send_msg_headers
+.. automodule:: pybpodapi.com.protocol.send_msg_headers
     :members:
     :private-members:
diff --git a/docs/source/api_reference/pybpodapi/index.rst b/docs/source/api_reference/pybpodapi/index.rst
@@ -10,7 +10,15 @@
 
    bpod/index
    bpod_modules/index
+   com/index
    exceptions/index
    state_machine/index
    session
 
+Communication module
+---------------------
+
+.. toctree::
+   :titlesonly:
+
+   com/index
diff --git a/pybpodapi/com/messaging/trial.py b/pybpodapi/com/messaging/trial.py
@@ -17,7 +17,7 @@ class Trial(BaseMessage):
 	"""
 	:ivar float bpod_start_timestamp: None
 	:ivar StateMachine sma: sma
-	:ivar list(StateOccurrences) state_occurrences: list of state occurrences
+	:ivar list(StateOccurrences) states_occurrences: list of state occurrences
 	:ivar list(EventOccurrence) events_occurrences: list of event occurrences 
 	"""
 	MESSAGE_TYPE_ALIAS = 'TRIAL'