Mirrors_Framework/ODrive
1
0
Fork 0
mirror of https://github.com/odriverobotics/ODrive.git synced 2026-08-18 01:18:52 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fixed api links

Browse Source
This commit is contained in:
nick-a-schneider
2021-12-06 14:19:10 -05:00
parent 6d5c2e482b
commit e17df54652
2 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reStructuredText/commands.rst
+6 -6
View File
@@ -19,9 +19,9 @@ For the most part, both axes on the ODrive can be controlled independently.
State Machine
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The current state of an axis is indicated by :ref:`<axis>.current_state <api/odrive.axis-current_state>`.
The user can request a new state by assigning a new value to :ref:`<axis>.requested_state <api/odrive.axis-current_state>`.
The default state after startup is :code:`AXIS_STATE_IDLE`. A description of all states can be found :ref:`here <api/odrive.axis.axisstate>`.
The current state of an axis is indicated by :attr:`<axis>.current_state <api/odrive.axis-current_state>`.
The user can request a new state by assigning a new value to :attr:`<axis>.requested_state <api/odrive.axis-current_state>`.
The default state after startup is :code:`AXIS_STATE_IDLE`. A description of all states can be found :attr:`here <api/odrive.axis.axisstate>`.
.. _commands-startup-procedure:
@@ -37,14 +37,14 @@ The ODrive will sequence all enabled startup actions selected in the order shown
* :code:`<axis>.config.startup_encoder_offset_calibration`
* :code:`<axis>.config.startup_closed_loop_control`
See :ref:`here <api/odrive.axis.axisstate>` for a description of each state.
See :attr:`here <api/odrive.axis.axisstate>` for a description of each state.
Control Mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The default control mode is position control.
If you want a different mode, you can change :code:`<axis>.controller.config.control_mode`.
Possible values are listed :ref:`here <api/odrive.controller.controlmode`.
Possible values are listed :attr:`here <api/odrive.controller.controlmode>`.
Input Mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -63,7 +63,7 @@ Control Commands
Modes can be selected by changing :code:`<axis>.controller.config.input_mode`.
The default input mode is :code:`INPUT_MODE_PASSTHROUGH`.
Possible values are listed :ref:`here <api/odrive.controller.inputmode>`.
Possible values are listed :attr:`here <api/odrive.controller.inputmode>`.
System Monitoring Commands
-------------------------------------------------------------------------------
docs/reStructuredText/troubleshooting.rst
+7 -7
View File
@@ -7,7 +7,7 @@ Troubleshooting
.. contents::
:depth: 1
:local:
.. _error-codes:
Error Codes
@@ -18,12 +18,12 @@ This will dump a list of all the errors that are present. To clear all the error
With this information you can look up the API documentation for your error(s):
* System error flags documented :ref:`here <api/odrive.error>`.
* Axis error flags documented :ref:`here <api/odrive.axis.error>`.
* Motor error flags documented :ref:`here <api/odrive.motor.error>`.
* Encoder error flags documented :ref:`here <api/odrive.encoder.error>`.
* Controller error flags documented :ref:`here <api/odrive.controller.error>`.
* Sensorless estimator error flags documented :ref:`here <api/odrive.sensorlessestimator.error>`.
* System error flags documented :attr:`here <api/odrive.error>`.
* Axis error flags documented :attr:`here <api/odrive.axis.error>`.
* Motor error flags documented :attr:`here <api/odrive.motor.error>`.
* Encoder error flags documented :attr:`here <api/odrive.encoder.error>`.
* Controller error flags documented :attr:`here <api/odrive.controller.error>`.
* Sensorless estimator error flags documented :attr:`here <api/odrive.sensorlessestimator.error>`.
What if :code:`dump_errors()` gives me python errors?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~