Merge pull request #17 from sonelu/CI-changes

Move to version 0.0.9, updates to docs
sonelu · May 8, 2020 · fab80f5 · fab80f5
2 parents 2ef5c42 + f57e972
commit fab80f5
Show file tree

Hide file tree

Showing 30 changed files with 322 additions and 11 deletions.
diff --git 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/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
@@ -27,8 +27,10 @@ roboglia.base.BaseBus
 
    .. autosummary::
 
-      ~BaseBus.isOpen
+      ~BaseBus.auto_open
+      ~BaseBus.is_open
       ~BaseBus.name
       ~BaseBus.port
+      ~BaseBus.robot
 
 
diff --git 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
@@ -35,8 +35,10 @@ roboglia.base.BaseLoop
       ~BaseLoop.name
       ~BaseLoop.paused
       ~BaseLoop.period
+      ~BaseLoop.review
       ~BaseLoop.running
       ~BaseLoop.started
       ~BaseLoop.stopped
+      ~BaseLoop.warning
 
 
diff --git 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
 
 
diff --git 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
 
 
diff --git 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
 
 
diff --git 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
 
 
diff --git 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
@@ -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
@@ -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
@@ -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
+
+
+
+
+
+
diff --git a/docs/reference/base/roboglia.base.ShareableFileBus.rst 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
+
+
diff --git 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
@@ -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
 
 
diff --git 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
 
 
diff --git 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
 
 
diff --git 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
@@ -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
 
 
diff --git 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
 
 
diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelXLBaudRateRegister.rst 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
+
+