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

updated documentation with new classes #43

Merged
merged 1 commit into from
May 17, 2020
Merged

updated documentation with new classes #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/reference/base/roboglia.base.BaseDevice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ roboglia.base.BaseDevice

.. autosummary::

~BaseDevice.auto_open
~BaseDevice.bus
~BaseDevice.cache
~BaseDevice.dev_id
~BaseDevice.name
~BaseDevice.registers
Expand Down
16 changes: 16 additions & 0 deletions docs/reference/base/roboglia.base.BaseRegister.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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



Expand Down
2 changes: 2 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 @@ -29,8 +29,10 @@ roboglia.base.BaseRobot
~BaseRobot.buses
~BaseRobot.devices
~BaseRobot.groups
~BaseRobot.inits
~BaseRobot.joints
~BaseRobot.name
~BaseRobot.sensors
~BaseRobot.syncs


Expand Down
16 changes: 16 additions & 0 deletions docs/reference/base/roboglia.base.BoolRegister.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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



Expand Down
18 changes: 18 additions & 0 deletions docs/reference/base/roboglia.base.RegisterWithConversion.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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



Expand Down
18 changes: 18 additions & 0 deletions docs/reference/base/roboglia.base.RegisterWithThreshold.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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



Expand Down
46 changes: 46 additions & 0 deletions docs/reference/base/roboglia.base.Sensor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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__


39 changes: 0 additions & 39 deletions docs/reference/base/roboglia.base.ShareableBus.rst
View file
Open in desktop

This file was deleted.

57 changes: 0 additions & 57 deletions docs/reference/base/roboglia.base.ShareableFileBus.rst
View file
Open in desktop

This file was deleted.

40 changes: 0 additions & 40 deletions docs/reference/base/roboglia.base.StepLoop.rst
View file
Open in desktop

This file was deleted.

5 changes: 2 additions & 3 deletions docs/reference/dynamixel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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*
Expand All @@ -14,9 +14,8 @@ devices.
:toctree: dynamixel

DynamixelBus
ShareableDynamixelBus
SharedDynamixelBus
MockPacketHandler
MockDynamixelBus

*Devices*

Expand Down
16 changes: 16 additions & 0 deletions docs/reference/dynamixel/roboglia.dynamixel.DynamixelAXBaudRateRegister.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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



Expand Down
16 changes: 16 additions & 0 deletions docs/reference/dynamixel/roboglia.dynamixel.DynamixelAXComplianceSlopeRegister.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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



Expand Down
2 changes: 1 addition & 1 deletion docs/reference/dynamixel/roboglia.dynamixel.DynamixelDevice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ roboglia.dynamixel.DynamixelDevice

.. autosummary::

~DynamixelDevice.auto_open
~DynamixelDevice.bus
~DynamixelDevice.cache
~DynamixelDevice.dev_id
~DynamixelDevice.name
~DynamixelDevice.registers
Expand Down
Loading