Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manager and Move doc updates #49

Merged
merged 2 commits into from
May 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 4 additions & 10 deletions docs/reference/base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,12 @@ various structural elements of a robot.
:toctree: base

BaseRobot
JointManager

**Upstream**

The following classes from ``base`` module are provided for helping with
the syncronisation of devices' values task.
the synchronization of devices' values task.

*Joints*

Expand All @@ -83,18 +84,11 @@ the syncronisation of devices' values task.
JointPV
JointPVL

*Sonsors*
*Sensors*

.. autosummary::
:nosignatures:
:toctree: base

Sensor

*Controller*

.. autosummary::
:nosignatures:
:toctree: base

Controller
SensorXYZ
1 change: 1 addition & 0 deletions docs/reference/base/roboglia.base.BaseRobot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ roboglia.base.BaseRobot
~BaseRobot.groups
~BaseRobot.inits
~BaseRobot.joints
~BaseRobot.manager
~BaseRobot.name
~BaseRobot.sensors
~BaseRobot.syncs
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/base/roboglia.base.Joint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ roboglia.base.Joint
.. autosummary::

~Joint.__init__
~Joint.desired



Expand All @@ -34,6 +35,7 @@ roboglia.base.Joint
~Joint.position_read_register
~Joint.position_write_register
~Joint.range
~Joint.value



Expand All @@ -44,5 +46,6 @@ roboglia.base.Joint


.. automethod:: __init__
.. automethod:: desired


66 changes: 66 additions & 0 deletions docs/reference/base/roboglia.base.JointManager.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
roboglia.base.JointManager
==========================

.. currentmodule:: roboglia.base

.. autoclass:: JointManager




.. rubric:: Methods

.. autosummary::

~JointManager.__init__
~JointManager.atomic
~JointManager.pause
~JointManager.resume
~JointManager.run
~JointManager.setup
~JointManager.start
~JointManager.stop
~JointManager.stop_submit
~JointManager.submit
~JointManager.teardown





.. rubric:: Attributes

.. autosummary::

~JointManager.frequency
~JointManager.joints
~JointManager.name
~JointManager.paused
~JointManager.period
~JointManager.review
~JointManager.running
~JointManager.started
~JointManager.stopped
~JointManager.warning






.. rubric:: Methods in detail


.. automethod:: __init__
.. automethod:: atomic
.. automethod:: pause
.. automethod:: resume
.. automethod:: run
.. automethod:: setup
.. automethod:: start
.. automethod:: stop
.. automethod:: stop_submit
.. automethod:: submit
.. automethod:: teardown


3 changes: 3 additions & 0 deletions docs/reference/base/roboglia.base.JointPV.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ roboglia.base.JointPV
.. autosummary::

~JointPV.__init__
~JointPV.desired



Expand All @@ -35,6 +36,7 @@ roboglia.base.JointPV
~JointPV.position_read_register
~JointPV.position_write_register
~JointPV.range
~JointPV.value
~JointPV.velocity
~JointPV.velocity_read_register
~JointPV.velocity_write_register
Expand All @@ -48,5 +50,6 @@ roboglia.base.JointPV


.. automethod:: __init__
.. automethod:: desired


3 changes: 3 additions & 0 deletions docs/reference/base/roboglia.base.JointPVL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ roboglia.base.JointPVL
.. autosummary::

~JointPVL.__init__
~JointPVL.desired



Expand All @@ -39,6 +40,7 @@ roboglia.base.JointPVL
~JointPVL.position_read_register
~JointPVL.position_write_register
~JointPVL.range
~JointPVL.value
~JointPVL.velocity
~JointPVL.velocity_read_register
~JointPVL.velocity_write_register
Expand All @@ -52,5 +54,6 @@ roboglia.base.JointPVL


.. automethod:: __init__
.. automethod:: desired


54 changes: 54 additions & 0 deletions docs/reference/base/roboglia.base.SensorXYZ.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
roboglia.base.SensorXYZ
=======================

.. currentmodule:: roboglia.base

.. autoclass:: SensorXYZ




.. rubric:: Methods

.. autosummary::

~SensorXYZ.__init__





.. rubric:: Attributes

.. autosummary::

~SensorXYZ.activate_register
~SensorXYZ.active
~SensorXYZ.auto_activate
~SensorXYZ.device
~SensorXYZ.name
~SensorXYZ.value
~SensorXYZ.x
~SensorXYZ.x_inverse
~SensorXYZ.x_offset
~SensorXYZ.x_register
~SensorXYZ.y
~SensorXYZ.y_inverse
~SensorXYZ.y_offset
~SensorXYZ.y_register
~SensorXYZ.z
~SensorXYZ.z_inverse
~SensorXYZ.z_offset
~SensorXYZ.z_register






.. rubric:: Methods in detail


.. automethod:: __init__


11 changes: 11 additions & 0 deletions docs/reference/move.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ allowing to store and execute predetermined routine movements.
:toctree: move

StepLoop

*Scrips*

.. autosummary::
:nosignatures:
:toctree: move

Script
Scene
Sequence
Frame
41 changes: 41 additions & 0 deletions docs/reference/move/roboglia.move.Frame.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
roboglia.move.Frame
===================

.. currentmodule:: roboglia.move

.. autoclass:: Frame




.. rubric:: Methods

.. autosummary::

~Frame.__init__





.. rubric:: Attributes

.. autosummary::

~Frame.commands
~Frame.loads
~Frame.name
~Frame.positions
~Frame.velocities






.. rubric:: Methods in detail


.. automethod:: __init__


41 changes: 41 additions & 0 deletions docs/reference/move/roboglia.move.Scene.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
roboglia.move.Scene
===================

.. currentmodule:: roboglia.move

.. autoclass:: Scene




.. rubric:: Methods

.. autosummary::

~Scene.__init__
~Scene.play





.. rubric:: Attributes

.. autosummary::

~Scene.name
~Scene.sequences
~Scene.times






.. rubric:: Methods in detail


.. automethod:: __init__
.. automethod:: play


Loading