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.

Sign up for GitHub

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

Explicit is better than implicit #29

Merged
merged 8 commits into from
May 14, 2020
Merged

Explicit is better than implicit #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0ea5af7
explicit refactoring robot and documentation chg
sonelu May 13, 2020
a53f240
refactoring for bus, device, joint and robot
sonelu May 13, 2020
7fdae6d
flake8
sonelu May 13, 2020
d6468a6
added tests for check_not_empty
sonelu May 13, 2020
a80842a
small docstrings updates
sonelu May 14, 2020
4e1d030
refactoring for register and subclasses
sonelu May 14, 2020
67d45d9
flake8
sonelu May 14, 2020
1a7264c
additional tests and fixes
sonelu May 14, 2020
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
4 changes: 2 additions & 2 deletions docs/reference/base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ various structural elements of a robot.

BaseBus
FileBus
ShareableBus
ShareableFileBus
SharedBus
SharedFileBus

*Registers*

Expand Down
2 changes: 2 additions & 0 deletions docs/reference/base/roboglia.base.BaseDevice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ roboglia.base.BaseDevice
~BaseDevice.get_model_path
~BaseDevice.open
~BaseDevice.read_register
~BaseDevice.register_by_address
~BaseDevice.write_register


Expand Down Expand Up @@ -48,6 +49,7 @@ roboglia.base.BaseDevice
.. automethod:: get_model_path
.. automethod:: open
.. automethod:: read_register
.. automethod:: register_by_address
.. automethod:: write_register


2 changes: 2 additions & 0 deletions docs/reference/base/roboglia.base.BaseReadSync.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ roboglia.base.BaseReadSync

~BaseReadSync.__init__
~BaseReadSync.atomic
~BaseReadSync.get_register_range
~BaseReadSync.pause
~BaseReadSync.process_devices
~BaseReadSync.process_registers
Expand Down Expand Up @@ -56,6 +57,7 @@ roboglia.base.BaseReadSync

.. automethod:: __init__
.. automethod:: atomic
.. automethod:: get_register_range
.. automethod:: pause
.. automethod:: process_devices
.. automethod:: process_registers
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/base/roboglia.base.BaseRobot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ roboglia.base.BaseRobot
.. autosummary::

~BaseRobot.__init__
~BaseRobot.device_by_id
~BaseRobot.from_yaml
~BaseRobot.start
~BaseRobot.stop
Expand All @@ -29,6 +30,7 @@ roboglia.base.BaseRobot
~BaseRobot.devices
~BaseRobot.groups
~BaseRobot.joints
~BaseRobot.name
~BaseRobot.syncs


Expand All @@ -40,6 +42,7 @@ roboglia.base.BaseRobot


.. automethod:: __init__
.. automethod:: device_by_id
.. automethod:: from_yaml
.. automethod:: start
.. automethod:: stop
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/base/roboglia.base.BaseSync.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ roboglia.base.BaseSync

~BaseSync.__init__
~BaseSync.atomic
~BaseSync.get_register_range
~BaseSync.pause
~BaseSync.process_devices
~BaseSync.process_registers
Expand Down Expand Up @@ -56,6 +57,7 @@ roboglia.base.BaseSync

.. automethod:: __init__
.. automethod:: atomic
.. automethod:: get_register_range
.. automethod:: pause
.. automethod:: process_devices
.. automethod:: process_registers
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/base/roboglia.base.BaseWriteSync.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ roboglia.base.BaseWriteSync

~BaseWriteSync.__init__
~BaseWriteSync.atomic
~BaseWriteSync.get_register_range
~BaseWriteSync.pause
~BaseWriteSync.process_devices
~BaseWriteSync.process_registers
Expand Down Expand Up @@ -56,6 +57,7 @@ roboglia.base.BaseWriteSync

.. automethod:: __init__
.. automethod:: atomic
.. automethod:: get_register_range
.. automethod:: pause
.. automethod:: process_devices
.. automethod:: process_registers
Expand Down
49 changes: 49 additions & 0 deletions docs/reference/base/roboglia.base.SharedBus.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
roboglia.base.SharedBus
=======================

.. currentmodule:: roboglia.base

.. autoclass:: SharedBus




.. rubric:: Methods

.. autosummary::

~SharedBus.__init__
~SharedBus.can_use
~SharedBus.naked_read
~SharedBus.naked_write
~SharedBus.read
~SharedBus.stop_using
~SharedBus.write





.. rubric:: Attributes

.. autosummary::

~SharedBus.timeout






.. rubric:: Methods in detail


.. automethod:: __init__
.. automethod:: can_use
.. automethod:: naked_read
.. automethod:: naked_write
.. automethod:: read
.. automethod:: stop_using
.. automethod:: write


49 changes: 49 additions & 0 deletions docs/reference/base/roboglia.base.SharedFileBus.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
roboglia.base.SharedFileBus
===========================

.. currentmodule:: roboglia.base

.. autoclass:: SharedFileBus




.. rubric:: Methods

.. autosummary::

~SharedFileBus.__init__
~SharedFileBus.can_use
~SharedFileBus.naked_read
~SharedFileBus.naked_write
~SharedFileBus.read
~SharedFileBus.stop_using
~SharedFileBus.write





.. rubric:: Attributes

.. autosummary::

~SharedFileBus.timeout






.. rubric:: Methods in detail


.. automethod:: __init__
.. automethod:: can_use
.. automethod:: naked_read
.. automethod:: naked_write
.. automethod:: read
.. automethod:: stop_using
.. automethod:: write


2 changes: 2 additions & 0 deletions docs/reference/dynamixel/roboglia.dynamixel.DynamixelBulkReadLoop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ roboglia.dynamixel.DynamixelBulkReadLoop

~DynamixelBulkReadLoop.__init__
~DynamixelBulkReadLoop.atomic
~DynamixelBulkReadLoop.get_register_range
~DynamixelBulkReadLoop.pause
~DynamixelBulkReadLoop.process_devices
~DynamixelBulkReadLoop.process_registers
Expand Down Expand Up @@ -56,6 +57,7 @@ roboglia.dynamixel.DynamixelBulkReadLoop

.. automethod:: __init__
.. automethod:: atomic
.. automethod:: get_register_range
.. automethod:: pause
.. automethod:: process_devices
.. automethod:: process_registers
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/dynamixel/roboglia.dynamixel.DynamixelBulkWriteLoop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ roboglia.dynamixel.DynamixelBulkWriteLoop

~DynamixelBulkWriteLoop.__init__
~DynamixelBulkWriteLoop.atomic
~DynamixelBulkWriteLoop.get_register_range
~DynamixelBulkWriteLoop.pause
~DynamixelBulkWriteLoop.process_devices
~DynamixelBulkWriteLoop.process_registers
Expand Down Expand Up @@ -56,6 +57,7 @@ roboglia.dynamixel.DynamixelBulkWriteLoop

.. automethod:: __init__
.. automethod:: atomic
.. automethod:: get_register_range
.. automethod:: pause
.. automethod:: process_devices
.. automethod:: process_registers
Expand Down
1 change: 1 addition & 0 deletions docs/reference/dynamixel/roboglia.dynamixel.DynamixelBus.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ roboglia.dynamixel.DynamixelBus
~DynamixelBus.port_handler
~DynamixelBus.protocol
~DynamixelBus.robot
~DynamixelBus.rs485



Expand Down
4 changes: 4 additions & 0 deletions docs/reference/dynamixel/roboglia.dynamixel.DynamixelDevice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ roboglia.dynamixel.DynamixelDevice
~DynamixelDevice.get_model_path
~DynamixelDevice.open
~DynamixelDevice.read_register
~DynamixelDevice.register_by_address
~DynamixelDevice.register_low_endian
~DynamixelDevice.write_register


Expand Down Expand Up @@ -48,6 +50,8 @@ roboglia.dynamixel.DynamixelDevice
.. automethod:: get_model_path
.. automethod:: open
.. automethod:: read_register
.. automethod:: register_by_address
.. automethod:: register_low_endian
.. automethod:: write_register


4 changes: 2 additions & 2 deletions docs/reference/dynamixel/roboglia.dynamixel.DynamixelSyncReadLoop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ roboglia.dynamixel.DynamixelSyncReadLoop

~DynamixelSyncReadLoop.__init__
~DynamixelSyncReadLoop.atomic
~DynamixelSyncReadLoop.get_register_range
~DynamixelSyncReadLoop.pause
~DynamixelSyncReadLoop.process_devices
~DynamixelSyncReadLoop.process_registers
Expand All @@ -32,7 +33,6 @@ roboglia.dynamixel.DynamixelSyncReadLoop

.. autosummary::

~DynamixelSyncReadLoop.all_length
~DynamixelSyncReadLoop.auto_start
~DynamixelSyncReadLoop.bus
~DynamixelSyncReadLoop.devices
Expand All @@ -43,7 +43,6 @@ roboglia.dynamixel.DynamixelSyncReadLoop
~DynamixelSyncReadLoop.registers
~DynamixelSyncReadLoop.review
~DynamixelSyncReadLoop.running
~DynamixelSyncReadLoop.start_address
~DynamixelSyncReadLoop.started
~DynamixelSyncReadLoop.stopped
~DynamixelSyncReadLoop.warning
Expand All @@ -58,6 +57,7 @@ roboglia.dynamixel.DynamixelSyncReadLoop

.. automethod:: __init__
.. automethod:: atomic
.. automethod:: get_register_range
.. automethod:: pause
.. automethod:: process_devices
.. automethod:: process_registers
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/dynamixel/roboglia.dynamixel.DynamixelSyncWriteLoop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ roboglia.dynamixel.DynamixelSyncWriteLoop

~DynamixelSyncWriteLoop.__init__
~DynamixelSyncWriteLoop.atomic
~DynamixelSyncWriteLoop.get_register_range
~DynamixelSyncWriteLoop.pause
~DynamixelSyncWriteLoop.process_devices
~DynamixelSyncWriteLoop.process_registers
Expand All @@ -32,7 +33,6 @@ roboglia.dynamixel.DynamixelSyncWriteLoop

.. autosummary::

~DynamixelSyncWriteLoop.all_length
~DynamixelSyncWriteLoop.auto_start
~DynamixelSyncWriteLoop.bus
~DynamixelSyncWriteLoop.devices
Expand All @@ -43,7 +43,6 @@ roboglia.dynamixel.DynamixelSyncWriteLoop
~DynamixelSyncWriteLoop.registers
~DynamixelSyncWriteLoop.review
~DynamixelSyncWriteLoop.running
~DynamixelSyncWriteLoop.start_address
~DynamixelSyncWriteLoop.started
~DynamixelSyncWriteLoop.stopped
~DynamixelSyncWriteLoop.warning
Expand All @@ -58,6 +57,7 @@ roboglia.dynamixel.DynamixelSyncWriteLoop

.. automethod:: __init__
.. automethod:: atomic
.. automethod:: get_register_range
.. automethod:: pause
.. automethod:: process_devices
.. automethod:: process_registers
Expand Down
Loading