Merge pull request #43 from sonelu/documentation

updated documentation with new classes
sonelu · May 17, 2020 · acb86b9 · acb86b9
2 parents 172f480 + 6b7e5fc
commit acb86b9
Show file tree

Hide file tree

Showing 28 changed files with 624 additions and 276 deletions.
diff --git a/docs/reference/base/roboglia.base.BaseDevice.rst b/docs/reference/base/roboglia.base.BaseDevice.rst
@@ -29,8 +29,8 @@ roboglia.base.BaseDevice
 
    .. autosummary::
 
-      ~BaseDevice.auto_open
       ~BaseDevice.bus
+      ~BaseDevice.cache
       ~BaseDevice.dev_id
       ~BaseDevice.name
       ~BaseDevice.registers

diff --git a/docs/reference/base/roboglia.base.BaseRegister.rst b/docs/reference/base/roboglia.base.BaseRegister.rst
@@ -26,7 +26,23 @@ roboglia.base.BaseRegister
 
    .. autosummary::
 
+      ~BaseRegister.access
+      ~BaseRegister.address
+      ~BaseRegister.default
+      ~BaseRegister.device
+      ~BaseRegister.int_value
+      ~BaseRegister.max_ext
+      ~BaseRegister.maxim
+      ~BaseRegister.min_ext
+      ~BaseRegister.minim
+      ~BaseRegister.name
+      ~BaseRegister.order
+      ~BaseRegister.range
+      ~BaseRegister.range_ext
+      ~BaseRegister.size
+      ~BaseRegister.sync
       ~BaseRegister.value
+      ~BaseRegister.word
 
 
 

diff --git a/docs/reference/base/roboglia.base.BaseRobot.rst b/docs/reference/base/roboglia.base.BaseRobot.rst
@@ -29,8 +29,10 @@ roboglia.base.BaseRobot
       ~BaseRobot.buses
       ~BaseRobot.devices
       ~BaseRobot.groups
+      ~BaseRobot.inits
       ~BaseRobot.joints
       ~BaseRobot.name
+      ~BaseRobot.sensors
       ~BaseRobot.syncs
 
 

diff --git a/docs/reference/base/roboglia.base.BoolRegister.rst b/docs/reference/base/roboglia.base.BoolRegister.rst
@@ -26,7 +26,23 @@ roboglia.base.BoolRegister
 
    .. autosummary::
 
+      ~BoolRegister.access
+      ~BoolRegister.address
+      ~BoolRegister.default
+      ~BoolRegister.device
+      ~BoolRegister.int_value
+      ~BoolRegister.max_ext
+      ~BoolRegister.maxim
+      ~BoolRegister.min_ext
+      ~BoolRegister.minim
+      ~BoolRegister.name
+      ~BoolRegister.order
+      ~BoolRegister.range
+      ~BoolRegister.range_ext
+      ~BoolRegister.size
+      ~BoolRegister.sync
       ~BoolRegister.value
+      ~BoolRegister.word
 
 
 

diff --git a/docs/reference/base/roboglia.base.RegisterWithConversion.rst b/docs/reference/base/roboglia.base.RegisterWithConversion.rst
@@ -26,7 +26,25 @@ roboglia.base.RegisterWithConversion
 
    .. autosummary::
 
+      ~RegisterWithConversion.access
+      ~RegisterWithConversion.address
+      ~RegisterWithConversion.default
+      ~RegisterWithConversion.device
+      ~RegisterWithConversion.factor
+      ~RegisterWithConversion.int_value
+      ~RegisterWithConversion.max_ext
+      ~RegisterWithConversion.maxim
+      ~RegisterWithConversion.min_ext
+      ~RegisterWithConversion.minim
+      ~RegisterWithConversion.name
+      ~RegisterWithConversion.offset
+      ~RegisterWithConversion.order
+      ~RegisterWithConversion.range
+      ~RegisterWithConversion.range_ext
+      ~RegisterWithConversion.size
+      ~RegisterWithConversion.sync
       ~RegisterWithConversion.value
+      ~RegisterWithConversion.word
 
 
 

diff --git a/docs/reference/base/roboglia.base.RegisterWithThreshold.rst b/docs/reference/base/roboglia.base.RegisterWithThreshold.rst
@@ -26,7 +26,25 @@ roboglia.base.RegisterWithThreshold
 
    .. autosummary::
 
+      ~RegisterWithThreshold.access
+      ~RegisterWithThreshold.address
+      ~RegisterWithThreshold.default
+      ~RegisterWithThreshold.device
+      ~RegisterWithThreshold.factor
+      ~RegisterWithThreshold.int_value
+      ~RegisterWithThreshold.max_ext
+      ~RegisterWithThreshold.maxim
+      ~RegisterWithThreshold.min_ext
+      ~RegisterWithThreshold.minim
+      ~RegisterWithThreshold.name
+      ~RegisterWithThreshold.order
+      ~RegisterWithThreshold.range
+      ~RegisterWithThreshold.range_ext
+      ~RegisterWithThreshold.size
+      ~RegisterWithThreshold.sync
+      ~RegisterWithThreshold.threshold
       ~RegisterWithThreshold.value
+      ~RegisterWithThreshold.word
 
 
 

diff --git a/docs/reference/base/roboglia.base.Sensor.rst b/docs/reference/base/roboglia.base.Sensor.rst
@@ -0,0 +1,46 @@
+roboglia.base.Sensor
+====================
+
+.. currentmodule:: roboglia.base
+
+.. autoclass:: Sensor
+
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Sensor.__init__
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Sensor.activate_register
+      ~Sensor.active
+      ~Sensor.auto_activate
+      ~Sensor.device
+      ~Sensor.inverse
+      ~Sensor.mask
+      ~Sensor.name
+      ~Sensor.offset
+      ~Sensor.read_register
+      ~Sensor.value
+
+
+
+
+
+
+   .. rubric:: Methods in detail
+
+
+   .. automethod:: __init__
+
+
diff --git a/docs/reference/base/roboglia.base.ShareableBus.rst b/docs/reference/base/roboglia.base.ShareableBus.rst
diff --git a/docs/reference/base/roboglia.base.ShareableFileBus.rst b/docs/reference/base/roboglia.base.ShareableFileBus.rst
diff --git a/docs/reference/base/roboglia.base.StepLoop.rst b/docs/reference/base/roboglia.base.StepLoop.rst
diff --git a/docs/reference/dynamixel.rst b/docs/reference/dynamixel.rst
@@ -4,7 +4,7 @@
 
 .. automodule:: roboglia.dynamixel
 
-This module contains classes that are specific for interation with dynamixel
+This module contains classes that are specific for interaction with dynamixel
 devices.
 
 *Buses*
@@ -14,9 +14,8 @@ devices.
    :toctree: dynamixel
 
    DynamixelBus
-   ShareableDynamixelBus
+   SharedDynamixelBus
    MockPacketHandler
-   MockDynamixelBus
 
 *Devices*
 

diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelAXBaudRateRegister.rst b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelAXBaudRateRegister.rst
@@ -26,7 +26,23 @@ roboglia.dynamixel.DynamixelAXBaudRateRegister
 
    .. autosummary::
 
+      ~DynamixelAXBaudRateRegister.access
+      ~DynamixelAXBaudRateRegister.address
+      ~DynamixelAXBaudRateRegister.default
+      ~DynamixelAXBaudRateRegister.device
+      ~DynamixelAXBaudRateRegister.int_value
+      ~DynamixelAXBaudRateRegister.max_ext
+      ~DynamixelAXBaudRateRegister.maxim
+      ~DynamixelAXBaudRateRegister.min_ext
+      ~DynamixelAXBaudRateRegister.minim
+      ~DynamixelAXBaudRateRegister.name
+      ~DynamixelAXBaudRateRegister.order
+      ~DynamixelAXBaudRateRegister.range
+      ~DynamixelAXBaudRateRegister.range_ext
+      ~DynamixelAXBaudRateRegister.size
+      ~DynamixelAXBaudRateRegister.sync
       ~DynamixelAXBaudRateRegister.value
+      ~DynamixelAXBaudRateRegister.word
 
 
 

diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelAXComplianceSlopeRegister.rst b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelAXComplianceSlopeRegister.rst
@@ -26,7 +26,23 @@ roboglia.dynamixel.DynamixelAXComplianceSlopeRegister
 
    .. autosummary::
 
+      ~DynamixelAXComplianceSlopeRegister.access
+      ~DynamixelAXComplianceSlopeRegister.address
+      ~DynamixelAXComplianceSlopeRegister.default
+      ~DynamixelAXComplianceSlopeRegister.device
+      ~DynamixelAXComplianceSlopeRegister.int_value
+      ~DynamixelAXComplianceSlopeRegister.max_ext
+      ~DynamixelAXComplianceSlopeRegister.maxim
+      ~DynamixelAXComplianceSlopeRegister.min_ext
+      ~DynamixelAXComplianceSlopeRegister.minim
+      ~DynamixelAXComplianceSlopeRegister.name
+      ~DynamixelAXComplianceSlopeRegister.order
+      ~DynamixelAXComplianceSlopeRegister.range
+      ~DynamixelAXComplianceSlopeRegister.range_ext
+      ~DynamixelAXComplianceSlopeRegister.size
+      ~DynamixelAXComplianceSlopeRegister.sync
       ~DynamixelAXComplianceSlopeRegister.value
+      ~DynamixelAXComplianceSlopeRegister.word
 
 
 

diff --git a/docs/reference/dynamixel/roboglia.dynamixel.DynamixelDevice.rst b/docs/reference/dynamixel/roboglia.dynamixel.DynamixelDevice.rst
@@ -30,8 +30,8 @@ roboglia.dynamixel.DynamixelDevice
 
    .. autosummary::
 
-      ~DynamixelDevice.auto_open
       ~DynamixelDevice.bus
+      ~DynamixelDevice.cache
       ~DynamixelDevice.dev_id
       ~DynamixelDevice.name
       ~DynamixelDevice.registers