mjlab/docs/source/api/actuator.rst
Upstream Snapshot 32a241c28f
Some checks failed
nightly / Test against latest dependencies (py3.10) (push) Has been cancelled
nightly / Test against latest dependencies (py3.13) (push) Has been cancelled
tests / tests (3.13, locked) (push) Has been cancelled
tests / tests (3.13, unlocked) (push) Has been cancelled
tests / pyright (3.10) (push) Has been cancelled
tests / lint-format (push) Has been cancelled
tests / tests (3.10, locked) (push) Has been cancelled
tests / tests (3.11, locked) (push) Has been cancelled
tests / tests (3.12, locked) (push) Has been cancelled
tests / pyright (3.11) (push) Has been cancelled
tests / pyright (3.12) (push) Has been cancelled
tests / pyright (3.13) (push) Has been cancelled
tests / ty-check (3.10) (push) Has been cancelled
tests / ty-check (3.11) (push) Has been cancelled
tests / ty-check (3.12) (push) Has been cancelled
tests / ty-check (3.13) (push) Has been cancelled
tests / stubs (push) Has been cancelled
tests / smoke-test (push) Has been cancelled
Docker / check_paths (push) Has been cancelled
docs / build (push) Has been cancelled
Docker / build (push) Has been cancelled
Import upstream snapshot c19f713c415a699a79d71cd96aa13c3104a05047
Upstream: https://github.com/michaelgillett/mjlab
Upstream-Commit: c19f713c415a699a79d71cd96aa13c3104a05047
Upstream-Branch: main
2026-08-28 15:42:17 +08:00

183 lines
3.3 KiB
ReStructuredText

mjlab.actuator
==============
.. automodule:: mjlab.actuator
.. rubric:: Classes
.. hlist::
:columns: 3
- :class:`Actuator`
- :class:`ActuatorCfg`
- :class:`ActuatorCmd`
- :class:`BuiltinActuatorGroup`
- :class:`BuiltinMotorActuator`
- :class:`BuiltinMotorActuatorCfg`
- :class:`BuiltinPositionActuator`
- :class:`BuiltinPositionActuatorCfg`
- :class:`BuiltinVelocityActuator`
- :class:`BuiltinVelocityActuatorCfg`
- :class:`BuiltinPdActuator`
- :class:`BuiltinPdActuatorCfg`
- :class:`BuiltinDcMotorActuator`
- :class:`BuiltinDcMotorActuatorCfg`
- :class:`DcMotorInputMode`
- :class:`DcMotorDatasheetParams`
- :class:`DcMotorPhysicalParams`
- :class:`BuiltinMuscleActuator`
- :class:`BuiltinMuscleActuatorCfg`
- :class:`XmlActuator`
- :class:`XmlActuatorCfg`
- :class:`IdealPdActuator`
- :class:`IdealPdActuatorCfg`
- :class:`DcMotorActuator`
- :class:`DcMotorActuatorCfg`
- :class:`LearnedMlpActuator`
- :class:`LearnedMlpActuatorCfg`
Base
----
.. autoclass:: Actuator
:members:
:show-inheritance:
.. autoclass:: ActuatorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: ActuatorCmd
:members:
:exclude-members: __init__
:undoc-members:
Builtin Actuators
-----------------
.. autoclass:: BuiltinActuatorGroup
:members:
:show-inheritance:
.. autoclass:: BuiltinMotorActuator
:members:
:show-inheritance:
.. autoclass:: BuiltinMotorActuatorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: BuiltinPositionActuator
:members:
:show-inheritance:
.. autoclass:: BuiltinPositionActuatorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: BuiltinVelocityActuator
:members:
:show-inheritance:
.. autoclass:: BuiltinVelocityActuatorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: BuiltinPdActuator
:members:
:show-inheritance:
.. autoclass:: BuiltinPdActuatorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: BuiltinDcMotorActuator
:members:
:show-inheritance:
.. autoclass:: BuiltinDcMotorActuatorCfg
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: DcMotorInputMode
:members:
:show-inheritance:
.. autoclass:: DcMotorDatasheetParams
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: DcMotorPhysicalParams
:members:
:exclude-members: __init__
:undoc-members:
.. autoclass:: BuiltinMuscleActuator
:members:
:show-inheritance:
.. autoclass:: BuiltinMuscleActuatorCfg
:members:
:exclude-members: __init__
:undoc-members:
XML Actuators
-------------
.. autoclass:: XmlActuator
:members:
:show-inheritance:
.. autoclass:: XmlActuatorCfg
:members:
:exclude-members: __init__
:undoc-members:
Ideal PD Actuator
-----------------
.. autoclass:: IdealPdActuator
:members:
:show-inheritance:
.. autoclass:: IdealPdActuatorCfg
:members:
:exclude-members: __init__
:undoc-members:
DC Motor Actuator
-----------------
.. autoclass:: DcMotorActuator
:members:
:show-inheritance:
.. autoclass:: DcMotorActuatorCfg
:members:
:exclude-members: __init__
:undoc-members:
Learned MLP Actuator
--------------------
.. autoclass:: LearnedMlpActuator
:members:
:show-inheritance:
.. autoclass:: LearnedMlpActuatorCfg
:members:
:exclude-members: __init__