From f13814c721037161d5779e329446fc60ae626488 Mon Sep 17 00:00:00 2001 From: sonelu Date: Fri, 8 May 2020 23:18:44 +0100 Subject: [PATCH 1/2] verision changes --- .travis.yml | 4 ++-- roboglia/_version.py | 2 +- setup.py | 9 ++++++--- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/.travis.yml b/.travis.yml index b3c6023..1d31f76 100644 --- a/.travis.yml +++ b/.travis.yml @@ -55,8 +55,8 @@ jobs: - pip install twine - pip install --upgrade setuptools wheel script: - - python setup.py install - - python -m twine upload dist/*.egg -u "${PYPI_USERNAME}" -p "${PYPI_PASSWORD}" + - python setup.py sdist bdist_wheel + - python -m twine upload dist/ -u "${PYPI_USERNAME}" -p "${PYPI_PASSWORD}" script: - coverage run -m pytest -v tests.py diff --git a/roboglia/_version.py b/roboglia/_version.py index 9123cf0..9d1ffab 100755 --- a/roboglia/_version.py +++ b/roboglia/_version.py @@ -1 +1 @@ -__version__ = '0.0.8' +__version__ = '0.0.9' diff --git a/setup.py b/setup.py index 05e974a..99bc843 100755 --- a/setup.py +++ b/setup.py @@ -41,12 +41,11 @@ def version(): """ install_requires = ['pyyaml'] -dyn_pkg = 'dynamixel_sdk@git+https://github.com/ROBOTIS-GIT/DynamixelSDK.git#egg=dynamixel_sdk&subdirectory=python' extras = { "spi": ['spidev'], "i2c": ['smbus2'], - "dynamixel": [dyn_pkg], - "all": ['spidev','smbus2',dyn_pkg] + "dynamixel": ['dynamixel-sdk'], + "all": ['spidev','smbus2','dynamixel-sdk'] } if sys.version_info < (3, 0): @@ -70,7 +69,11 @@ def version(): author_email='alex.sonea@gmail.com', description='Robotics Framework unsing Dynamixel SDK, I2C, SPI', long_description=open('README.md', encoding='utf-8').read(), + long_description_content_type='text/markdown', url='https://github.com/sonelu/roboglia', + project_urls = { + 'Documentation': 'https://roboglia.readthedocs.io/en/latest/' + }, license='GNU GENERAL PUBLIC LICENSE Version 3', classifiers=[ "Programming Language :: Python :: 3", From f57e972003b7e78f8f3cd78844d30d26cffbc6ad Mon Sep 17 00:00:00 2001 From: sonelu Date: Fri, 8 May 2020 23:18:56 +0100 Subject: [PATCH 2/2] docs updates --- docs/reference/base.rst | 3 +- docs/reference/base/roboglia.base.BaseBus.rst | 4 +- .../base/roboglia.base.BaseDevice.rst | 1 + .../reference/base/roboglia.base.BaseLoop.rst | 2 + .../base/roboglia.base.BaseReadSync.rst | 2 + .../reference/base/roboglia.base.BaseSync.rst | 2 + .../base/roboglia.base.BaseWriteSync.rst | 2 + docs/reference/base/roboglia.base.FileBus.rst | 4 +- docs/reference/base/roboglia.base.Joint.rst | 1 + docs/reference/base/roboglia.base.JointPV.rst | 1 + .../reference/base/roboglia.base.JointPVL.rst | 1 + .../base/roboglia.base.ShareableBus.rst | 26 +++++++++++ .../base/roboglia.base.ShareableFileBus.rst | 40 ++++++++++++++++ docs/reference/dynamixel.rst | 4 ++ ...boglia.dynamixel.DynamixelBulkReadLoop.rst | 8 ++++ ...oglia.dynamixel.DynamixelBulkWriteLoop.rst | 8 ++++ .../roboglia.dynamixel.DynamixelBus.rst | 9 +++- .../roboglia.dynamixel.DynamixelDevice.rst | 1 + ...boglia.dynamixel.DynamixelSyncReadLoop.rst | 8 ++++ ...oglia.dynamixel.DynamixelSyncWriteLoop.rst | 8 ++++ ....dynamixel.DynamixelXLBaudRateRegister.rst | 32 +++++++++++++ .../roboglia.dynamixel.MockDynamixelBus.rst | 46 +++++++++++++++++++ ...boglia.dynamixel.ShareableDynamixelBus.rst | 46 +++++++++++++++++++ docs/reference/index.rst | 1 + docs/reference/move.rst | 16 +++++++ .../reference/move/roboglia.move.StepLoop.rst | 40 ++++++++++++++++ docs/requirements.txt | 2 +- 27 files changed, 313 insertions(+), 5 deletions(-) create mode 100644 docs/reference/base/roboglia.base.ShareableBus.rst create mode 100644 docs/reference/base/roboglia.base.ShareableFileBus.rst create mode 100644 docs/reference/dynamixel/roboglia.dynamixel.DynamixelXLBaudRateRegister.rst create mode 100644 docs/reference/dynamixel/roboglia.dynamixel.MockDynamixelBus.rst create mode 100644 docs/reference/dynamixel/roboglia.dynamixel.ShareableDynamixelBus.rst create mode 100644 docs/reference/move.rst create mode 100644 docs/reference/move/roboglia.move.StepLoop.rst diff --git a/docs/reference/base.rst b/docs/reference/base.rst index 1c403bc..3c4f8f9 100755 --- a/docs/reference/base.rst +++ b/docs/reference/base.rst @@ -22,6 +22,8 @@ The following classes from ``base`` module are provided for representing various BaseBus FileBus + ShareableBus + ShareableFileBus *Registers* @@ -50,7 +52,6 @@ The following classes from ``base`` module are provided for representing various BaseThread BaseLoop - StepLoop BaseSync BaseReadSync BaseWriteSync diff --git a/docs/reference/base/roboglia.base.BaseBus.rst b/docs/reference/base/roboglia.base.BaseBus.rst index aa5533c..1c9d8c4 100644 --- a/docs/reference/base/roboglia.base.BaseBus.rst +++ b/docs/reference/base/roboglia.base.BaseBus.rst @@ -27,8 +27,10 @@ roboglia.base.BaseBus .. autosummary:: - ~BaseBus.isOpen + ~BaseBus.auto_open + ~BaseBus.is_open ~BaseBus.name ~BaseBus.port + ~BaseBus.robot \ No newline at end of file diff --git a/docs/reference/base/roboglia.base.BaseDevice.rst b/docs/reference/base/roboglia.base.BaseDevice.rst index 2fdb2f7..09e74b0 100644 --- a/docs/reference/base/roboglia.base.BaseDevice.rst +++ b/docs/reference/base/roboglia.base.BaseDevice.rst @@ -29,6 +29,7 @@ roboglia.base.BaseDevice .. autosummary:: + ~BaseDevice.auto_open ~BaseDevice.bus ~BaseDevice.dev_id ~BaseDevice.name diff --git a/docs/reference/base/roboglia.base.BaseLoop.rst b/docs/reference/base/roboglia.base.BaseLoop.rst index 71e5cab..6066276 100644 --- a/docs/reference/base/roboglia.base.BaseLoop.rst +++ b/docs/reference/base/roboglia.base.BaseLoop.rst @@ -35,8 +35,10 @@ roboglia.base.BaseLoop ~BaseLoop.name ~BaseLoop.paused ~BaseLoop.period + ~BaseLoop.review ~BaseLoop.running ~BaseLoop.started ~BaseLoop.stopped + ~BaseLoop.warning \ No newline at end of file diff --git a/docs/reference/base/roboglia.base.BaseReadSync.rst b/docs/reference/base/roboglia.base.BaseReadSync.rst index 3da35c2..3ce4f71 100644 --- a/docs/reference/base/roboglia.base.BaseReadSync.rst +++ b/docs/reference/base/roboglia.base.BaseReadSync.rst @@ -41,8 +41,10 @@ roboglia.base.BaseReadSync ~BaseReadSync.paused ~BaseReadSync.period ~BaseReadSync.registers + ~BaseReadSync.review ~BaseReadSync.running ~BaseReadSync.started ~BaseReadSync.stopped + ~BaseReadSync.warning \ No newline at end of file diff --git a/docs/reference/base/roboglia.base.BaseSync.rst b/docs/reference/base/roboglia.base.BaseSync.rst index 5f61a79..993c460 100644 --- a/docs/reference/base/roboglia.base.BaseSync.rst +++ b/docs/reference/base/roboglia.base.BaseSync.rst @@ -41,8 +41,10 @@ roboglia.base.BaseSync ~BaseSync.paused ~BaseSync.period ~BaseSync.registers + ~BaseSync.review ~BaseSync.running ~BaseSync.started ~BaseSync.stopped + ~BaseSync.warning \ No newline at end of file diff --git a/docs/reference/base/roboglia.base.BaseWriteSync.rst b/docs/reference/base/roboglia.base.BaseWriteSync.rst index 7446e01..1d40353 100644 --- a/docs/reference/base/roboglia.base.BaseWriteSync.rst +++ b/docs/reference/base/roboglia.base.BaseWriteSync.rst @@ -41,8 +41,10 @@ roboglia.base.BaseWriteSync ~BaseWriteSync.paused ~BaseWriteSync.period ~BaseWriteSync.registers + ~BaseWriteSync.review ~BaseWriteSync.running ~BaseWriteSync.started ~BaseWriteSync.stopped + ~BaseWriteSync.warning \ No newline at end of file diff --git a/docs/reference/base/roboglia.base.FileBus.rst b/docs/reference/base/roboglia.base.FileBus.rst index a4eb7d9..de7d519 100644 --- a/docs/reference/base/roboglia.base.FileBus.rst +++ b/docs/reference/base/roboglia.base.FileBus.rst @@ -27,8 +27,10 @@ roboglia.base.FileBus .. autosummary:: - ~FileBus.isOpen + ~FileBus.auto_open + ~FileBus.is_open ~FileBus.name ~FileBus.port + ~FileBus.robot \ No newline at end of file diff --git a/docs/reference/base/roboglia.base.Joint.rst b/docs/reference/base/roboglia.base.Joint.rst index 50ecb5a..b27135a 100644 --- a/docs/reference/base/roboglia.base.Joint.rst +++ b/docs/reference/base/roboglia.base.Joint.rst @@ -25,6 +25,7 @@ roboglia.base.Joint ~Joint.activate_register ~Joint.active + ~Joint.auto_activate ~Joint.desired_position ~Joint.device ~Joint.inverse diff --git a/docs/reference/base/roboglia.base.JointPV.rst b/docs/reference/base/roboglia.base.JointPV.rst index 6f5ddb3..e1bb6fd 100644 --- a/docs/reference/base/roboglia.base.JointPV.rst +++ b/docs/reference/base/roboglia.base.JointPV.rst @@ -25,6 +25,7 @@ roboglia.base.JointPV ~JointPV.activate_register ~JointPV.active + ~JointPV.auto_activate ~JointPV.desired_position ~JointPV.desired_velocity ~JointPV.device diff --git a/docs/reference/base/roboglia.base.JointPVL.rst b/docs/reference/base/roboglia.base.JointPVL.rst index 6cf5f27..71aa990 100644 --- a/docs/reference/base/roboglia.base.JointPVL.rst +++ b/docs/reference/base/roboglia.base.JointPVL.rst @@ -25,6 +25,7 @@ roboglia.base.JointPVL ~JointPVL.activate_register ~JointPVL.active + ~JointPVL.auto_activate ~JointPVL.desired_load ~JointPVL.desired_position ~JointPVL.desired_velocity diff --git a/docs/reference/base/roboglia.base.ShareableBus.rst b/docs/reference/base/roboglia.base.ShareableBus.rst new file mode 100644 index 0000000..ca2d35f --- /dev/null +++ b/docs/reference/base/roboglia.base.ShareableBus.rst @@ -0,0 +1,26 @@ +roboglia.base.ShareableBus +========================== + +.. currentmodule:: roboglia.base + +.. autoclass:: ShareableBus + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~ShareableBus.__init__ + ~ShareableBus.can_use + ~ShareableBus.naked_read + ~ShareableBus.naked_write + ~ShareableBus.stop_using + + + + + + \ No newline at end of file diff --git a/docs/reference/base/roboglia.base.ShareableFileBus.rst b/docs/reference/base/roboglia.base.ShareableFileBus.rst new file mode 100644 index 0000000..f43758d --- /dev/null +++ b/docs/reference/base/roboglia.base.ShareableFileBus.rst @@ -0,0 +1,40 @@ +roboglia.base.ShareableFileBus +============================== + +.. currentmodule:: roboglia.base + +.. autoclass:: ShareableFileBus + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~ShareableFileBus.__init__ + ~ShareableFileBus.can_use + ~ShareableFileBus.close + ~ShareableFileBus.naked_read + ~ShareableFileBus.naked_write + ~ShareableFileBus.open + ~ShareableFileBus.read + ~ShareableFileBus.stop_using + ~ShareableFileBus.write + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~ShareableFileBus.auto_open + ~ShareableFileBus.is_open + ~ShareableFileBus.name + ~ShareableFileBus.port + ~ShareableFileBus.robot + + \ No newline at end of file diff --git a/docs/reference/dynamixel.rst b/docs/reference/dynamixel.rst index c09a47f..97bf45c 100755 --- a/docs/reference/dynamixel.rst +++ b/docs/reference/dynamixel.rst @@ -14,6 +14,9 @@ devices. :toctree: dynamixel DynamixelBus + ShareableDynamixelBus + MockPacketHandler + MockDynamixelBus *Devices* @@ -31,6 +34,7 @@ devices. DynamixelAXBaudRateRegister DynamixelAXComplianceSlopeRegister + DynamixelXLBaudRateRegister *Syncs* diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBulkReadLoop.rst b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBulkReadLoop.rst index 1a4498b..d723851 100644 --- a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBulkReadLoop.rst +++ b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBulkReadLoop.rst @@ -16,6 +16,8 @@ roboglia.dynamixel.DynamixelBulkReadLoop ~DynamixelBulkReadLoop.__init__ ~DynamixelBulkReadLoop.atomic ~DynamixelBulkReadLoop.pause + ~DynamixelBulkReadLoop.process_devices + ~DynamixelBulkReadLoop.process_registers ~DynamixelBulkReadLoop.resume ~DynamixelBulkReadLoop.run ~DynamixelBulkReadLoop.setup @@ -31,12 +33,18 @@ roboglia.dynamixel.DynamixelBulkReadLoop .. autosummary:: + ~DynamixelBulkReadLoop.auto_start + ~DynamixelBulkReadLoop.bus + ~DynamixelBulkReadLoop.devices ~DynamixelBulkReadLoop.frequency ~DynamixelBulkReadLoop.name ~DynamixelBulkReadLoop.paused ~DynamixelBulkReadLoop.period + ~DynamixelBulkReadLoop.registers + ~DynamixelBulkReadLoop.review ~DynamixelBulkReadLoop.running ~DynamixelBulkReadLoop.started ~DynamixelBulkReadLoop.stopped + ~DynamixelBulkReadLoop.warning \ No newline at end of file diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBulkWriteLoop.rst b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBulkWriteLoop.rst index b63ff51..b5acd31 100644 --- a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBulkWriteLoop.rst +++ b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBulkWriteLoop.rst @@ -16,6 +16,8 @@ roboglia.dynamixel.DynamixelBulkWriteLoop ~DynamixelBulkWriteLoop.__init__ ~DynamixelBulkWriteLoop.atomic ~DynamixelBulkWriteLoop.pause + ~DynamixelBulkWriteLoop.process_devices + ~DynamixelBulkWriteLoop.process_registers ~DynamixelBulkWriteLoop.resume ~DynamixelBulkWriteLoop.run ~DynamixelBulkWriteLoop.setup @@ -31,12 +33,18 @@ roboglia.dynamixel.DynamixelBulkWriteLoop .. autosummary:: + ~DynamixelBulkWriteLoop.auto_start + ~DynamixelBulkWriteLoop.bus + ~DynamixelBulkWriteLoop.devices ~DynamixelBulkWriteLoop.frequency ~DynamixelBulkWriteLoop.name ~DynamixelBulkWriteLoop.paused ~DynamixelBulkWriteLoop.period + ~DynamixelBulkWriteLoop.registers + ~DynamixelBulkWriteLoop.review ~DynamixelBulkWriteLoop.running ~DynamixelBulkWriteLoop.started ~DynamixelBulkWriteLoop.stopped + ~DynamixelBulkWriteLoop.warning \ No newline at end of file diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBus.rst b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBus.rst index 27e78ea..41e4db2 100644 --- a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBus.rst +++ b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelBus.rst @@ -15,10 +15,10 @@ roboglia.dynamixel.DynamixelBus ~DynamixelBus.__init__ ~DynamixelBus.close - ~DynamixelBus.isOpen ~DynamixelBus.open ~DynamixelBus.ping ~DynamixelBus.read + ~DynamixelBus.scan ~DynamixelBus.write @@ -29,7 +29,14 @@ roboglia.dynamixel.DynamixelBus .. autosummary:: + ~DynamixelBus.auto_open + ~DynamixelBus.baudrate + ~DynamixelBus.is_open ~DynamixelBus.name + ~DynamixelBus.packet_handler ~DynamixelBus.port + ~DynamixelBus.port_handler + ~DynamixelBus.protocol + ~DynamixelBus.robot \ No newline at end of file diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelDevice.rst b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelDevice.rst index 563c8c4..6479849 100644 --- a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelDevice.rst +++ b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelDevice.rst @@ -29,6 +29,7 @@ roboglia.dynamixel.DynamixelDevice .. autosummary:: + ~DynamixelDevice.auto_open ~DynamixelDevice.bus ~DynamixelDevice.dev_id ~DynamixelDevice.name diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelSyncReadLoop.rst b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelSyncReadLoop.rst index 53ad708..7e0aa6d 100644 --- a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelSyncReadLoop.rst +++ b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelSyncReadLoop.rst @@ -33,12 +33,20 @@ roboglia.dynamixel.DynamixelSyncReadLoop .. autosummary:: + ~DynamixelSyncReadLoop.all_length + ~DynamixelSyncReadLoop.auto_start + ~DynamixelSyncReadLoop.bus + ~DynamixelSyncReadLoop.devices ~DynamixelSyncReadLoop.frequency ~DynamixelSyncReadLoop.name ~DynamixelSyncReadLoop.paused ~DynamixelSyncReadLoop.period + ~DynamixelSyncReadLoop.registers + ~DynamixelSyncReadLoop.review ~DynamixelSyncReadLoop.running + ~DynamixelSyncReadLoop.start_address ~DynamixelSyncReadLoop.started ~DynamixelSyncReadLoop.stopped + ~DynamixelSyncReadLoop.warning \ No newline at end of file diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelSyncWriteLoop.rst b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelSyncWriteLoop.rst index 575ba1f..1d85202 100644 --- a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelSyncWriteLoop.rst +++ b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelSyncWriteLoop.rst @@ -33,12 +33,20 @@ roboglia.dynamixel.DynamixelSyncWriteLoop .. autosummary:: + ~DynamixelSyncWriteLoop.all_length + ~DynamixelSyncWriteLoop.auto_start + ~DynamixelSyncWriteLoop.bus + ~DynamixelSyncWriteLoop.devices ~DynamixelSyncWriteLoop.frequency ~DynamixelSyncWriteLoop.name ~DynamixelSyncWriteLoop.paused ~DynamixelSyncWriteLoop.period + ~DynamixelSyncWriteLoop.registers + ~DynamixelSyncWriteLoop.review ~DynamixelSyncWriteLoop.running + ~DynamixelSyncWriteLoop.start_address ~DynamixelSyncWriteLoop.started ~DynamixelSyncWriteLoop.stopped + ~DynamixelSyncWriteLoop.warning \ No newline at end of file diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelXLBaudRateRegister.rst b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelXLBaudRateRegister.rst new file mode 100644 index 0000000..d5fd344 --- /dev/null +++ b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelXLBaudRateRegister.rst @@ -0,0 +1,32 @@ +roboglia.dynamixel.DynamixelXLBaudRateRegister +============================================== + +.. currentmodule:: roboglia.dynamixel + +.. autoclass:: DynamixelXLBaudRateRegister + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~DynamixelXLBaudRateRegister.__init__ + ~DynamixelXLBaudRateRegister.read + ~DynamixelXLBaudRateRegister.value_to_external + ~DynamixelXLBaudRateRegister.value_to_internal + ~DynamixelXLBaudRateRegister.write + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~DynamixelXLBaudRateRegister.value + + \ No newline at end of file diff --git a/docs/reference/dynamixel/roboglia.dynamixel.MockDynamixelBus.rst b/docs/reference/dynamixel/roboglia.dynamixel.MockDynamixelBus.rst new file mode 100644 index 0000000..012aedb --- /dev/null +++ b/docs/reference/dynamixel/roboglia.dynamixel.MockDynamixelBus.rst @@ -0,0 +1,46 @@ +roboglia.dynamixel.MockDynamixelBus +=================================== + +.. currentmodule:: roboglia.dynamixel + +.. autoclass:: MockDynamixelBus + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~MockDynamixelBus.__init__ + ~MockDynamixelBus.can_use + ~MockDynamixelBus.close + ~MockDynamixelBus.naked_read + ~MockDynamixelBus.naked_write + ~MockDynamixelBus.open + ~MockDynamixelBus.ping + ~MockDynamixelBus.read + ~MockDynamixelBus.scan + ~MockDynamixelBus.stop_using + ~MockDynamixelBus.write + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~MockDynamixelBus.auto_open + ~MockDynamixelBus.baudrate + ~MockDynamixelBus.is_open + ~MockDynamixelBus.name + ~MockDynamixelBus.packet_handler + ~MockDynamixelBus.port + ~MockDynamixelBus.port_handler + ~MockDynamixelBus.protocol + ~MockDynamixelBus.robot + + \ No newline at end of file diff --git a/docs/reference/dynamixel/roboglia.dynamixel.ShareableDynamixelBus.rst b/docs/reference/dynamixel/roboglia.dynamixel.ShareableDynamixelBus.rst new file mode 100644 index 0000000..4fdf019 --- /dev/null +++ b/docs/reference/dynamixel/roboglia.dynamixel.ShareableDynamixelBus.rst @@ -0,0 +1,46 @@ +roboglia.dynamixel.ShareableDynamixelBus +======================================== + +.. currentmodule:: roboglia.dynamixel + +.. autoclass:: ShareableDynamixelBus + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~ShareableDynamixelBus.__init__ + ~ShareableDynamixelBus.can_use + ~ShareableDynamixelBus.close + ~ShareableDynamixelBus.naked_read + ~ShareableDynamixelBus.naked_write + ~ShareableDynamixelBus.open + ~ShareableDynamixelBus.ping + ~ShareableDynamixelBus.read + ~ShareableDynamixelBus.scan + ~ShareableDynamixelBus.stop_using + ~ShareableDynamixelBus.write + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~ShareableDynamixelBus.auto_open + ~ShareableDynamixelBus.baudrate + ~ShareableDynamixelBus.is_open + ~ShareableDynamixelBus.name + ~ShareableDynamixelBus.packet_handler + ~ShareableDynamixelBus.port + ~ShareableDynamixelBus.port_handler + ~ShareableDynamixelBus.protocol + ~ShareableDynamixelBus.robot + + \ No newline at end of file diff --git a/docs/reference/index.rst b/docs/reference/index.rst index d754645..a5e39d5 100755 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -6,4 +6,5 @@ API Reference base dynamixel + move utils diff --git a/docs/reference/move.rst b/docs/reference/move.rst new file mode 100644 index 0000000..96005f8 --- /dev/null +++ b/docs/reference/move.rst @@ -0,0 +1,16 @@ +=============== +``move`` Module +=============== + +.. automodule:: roboglia.move + +This module contains classes that are concerned with higher level movements +allowing to store and execute predetermined routine movements. + +*Loops* + +.. autosummary:: + :nosignatures: + :toctree: move + + StepLoop diff --git a/docs/reference/move/roboglia.move.StepLoop.rst b/docs/reference/move/roboglia.move.StepLoop.rst new file mode 100644 index 0000000..e295ddd --- /dev/null +++ b/docs/reference/move/roboglia.move.StepLoop.rst @@ -0,0 +1,40 @@ +roboglia.move.StepLoop +====================== + +.. currentmodule:: roboglia.move + +.. autoclass:: StepLoop + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~StepLoop.__init__ + ~StepLoop.atomic + ~StepLoop.pause + ~StepLoop.resume + ~StepLoop.run + ~StepLoop.setup + ~StepLoop.start + ~StepLoop.stop + ~StepLoop.teardown + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~StepLoop.name + ~StepLoop.paused + ~StepLoop.running + ~StepLoop.started + ~StepLoop.stopped + + \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index be03966..6e2012f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ smbus2 spidev -git+https://github.com/ROBOTIS-GIT/DynamixelSDK.git#egg=dynamixel_sdk&subdirectory=python \ No newline at end of file +dynamixel-sdk