Skip to content

Commit 17dbebe

Browse files
deploy: d1cab0b
1 parent 949b971 commit 17dbebe

File tree

8 files changed

+38
-8
lines changed

8 files changed

+38
-8
lines changed

.nojekyll

Whitespace-only changes.

docs/genindex.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2079,7 +2079,11 @@ <h2 id="G">G</h2>
20792079
<li><a href="simulation/controller.html#robosuite.controllers.composite.composite_controller.CompositeController.get_controller">get_controller() (robosuite.controllers.composite.composite_controller.CompositeController method)</a>, <a href="source/robosuite.controllers.composite.html#robosuite.controllers.composite.composite_controller.CompositeController.get_controller">[1]</a>
20802080
</li>
20812081
<li><a href="simulation/controller.html#robosuite.controllers.composite.composite_controller.CompositeController.get_controller_base_pose">get_controller_base_pose() (robosuite.controllers.composite.composite_controller.CompositeController method)</a>, <a href="source/robosuite.controllers.composite.html#robosuite.controllers.composite.composite_controller.CompositeController.get_controller_base_pose">[1]</a>
2082+
2083+
<ul>
2084+
<li><a href="source/robosuite.utils.html#robosuite.utils.ik_utils.IKSolver.get_controller_base_pose">(robosuite.utils.ik_utils.IKSolver method)</a>
20822085
</li>
2086+
</ul></li>
20832087
<li><a href="simulation/device.html#robosuite.devices.device.Device.get_controller_state">get_controller_state() (robosuite.devices.device.Device method)</a>, <a href="source/robosuite.devices.html#robosuite.devices.device.Device.get_controller_state">[1]</a>
20842088

20852089
<ul>
@@ -2221,6 +2225,8 @@ <h2 id="G">G</h2>
22212225
<li><a href="source/robosuite.utils.html#robosuite.utils.ik_utils.IKSolver.get_targets">get_targets() (robosuite.utils.ik_utils.IKSolver method)</a>
22222226
</li>
22232227
<li><a href="source/robosuite.utils.html#robosuite.utils.mjmod.TextureModder.get_texture">get_texture() (robosuite.utils.mjmod.TextureModder method)</a>
2228+
</li>
2229+
<li><a href="source/robosuite.devices.html#robosuite.devices.device.Device.get_torso_action">get_torso_action() (robosuite.devices.device.Device method)</a>
22242230
</li>
22252231
<li><a href="modeling/object_model.html#robosuite.models.objects.objects.MujocoGeneratedObject.get_visual_attrib_template">get_visual_attrib_template() (robosuite.models.objects.objects.MujocoGeneratedObject static method)</a>, <a href="source/robosuite.models.objects.html#robosuite.models.objects.objects.MujocoGeneratedObject.get_visual_attrib_template">[1]</a>
22262232
</li>

docs/objects.inv

42 Bytes
Binary file not shown.

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/simulation/device.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -653,7 +653,7 @@ <h2>MjGUI Device<a class="headerlink" href="#mjgui-device" title="Link to this h
653653

654654
<dl class="py method">
655655
<dt class="sig sig-object py" id="robosuite.devices.mjgui.MJGUI.input2action">
656-
<span class="sig-name descname"><span class="pre">input2action</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#robosuite.devices.mjgui.MJGUI.input2action" title="Link to this definition">#</a></dt>
656+
<span class="sig-name descname"><span class="pre">input2action</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">goal_update_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'desired'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#robosuite.devices.mjgui.MJGUI.input2action" title="Link to this definition">#</a></dt>
657657
<dd><p>Uses mocap body poses to determine action for robot. Obtain input_type
658658
(i.e. absolute actions or delta actions) and input_ref_frame (i.e. world frame, base frame or eef frame)
659659
from the controller itself.</p>

docs/source/robosuite.devices.html

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,7 @@ <h2> Contents </h2>
419419
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.base_mode"><code class="docutils literal notranslate"><span class="pre">Device.base_mode</span></code></a></li>
420420
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.get_arm_action"><code class="docutils literal notranslate"><span class="pre">Device.get_arm_action()</span></code></a></li>
421421
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.get_controller_state"><code class="docutils literal notranslate"><span class="pre">Device.get_controller_state()</span></code></a></li>
422+
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.get_torso_action"><code class="docutils literal notranslate"><span class="pre">Device.get_torso_action()</span></code></a></li>
422423
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.grasp"><code class="docutils literal notranslate"><span class="pre">Device.grasp</span></code></a></li>
423424
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.input2action"><code class="docutils literal notranslate"><span class="pre">Device.input2action()</span></code></a></li>
424425
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.start_control"><code class="docutils literal notranslate"><span class="pre">Device.start_control()</span></code></a></li>
@@ -518,20 +519,32 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
518519
<dd><p>Returns the current state of the device, a dictionary of pos, orn, grasp, and reset.</p>
519520
</dd></dl>
520521

522+
<dl class="py method">
523+
<dt class="sig sig-object py" id="robosuite.devices.device.Device.get_torso_action">
524+
<span class="sig-name descname"><span class="pre">get_torso_action</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">robot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device_input</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#robosuite.devices.device.Device.get_torso_action" title="Link to this definition">#</a></dt>
525+
<dd><p>Generate torso action from device input</p>
526+
</dd></dl>
527+
521528
<dl class="py property">
522529
<dt class="sig sig-object py" id="robosuite.devices.device.Device.grasp">
523530
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">grasp</span></span><a class="headerlink" href="#robosuite.devices.device.Device.grasp" title="Link to this definition">#</a></dt>
524531
<dd></dd></dl>
525532

526533
<dl class="py method">
527534
<dt class="sig sig-object py" id="robosuite.devices.device.Device.input2action">
528-
<span class="sig-name descname"><span class="pre">input2action</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mirror_actions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#robosuite.devices.device.Device.input2action" title="Link to this definition">#</a></dt>
535+
<span class="sig-name descname"><span class="pre">input2action</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mirror_actions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">goal_update_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'target'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#robosuite.devices.device.Device.input2action" title="Link to this definition">#</a></dt>
529536
<dd><p>Converts an input from an active device into a valid action sequence that can be fed into an env.step() call</p>
530537
<p>If a reset is triggered from the device, immediately returns None. Else, returns the appropriate action</p>
531538
<dl class="field-list simple">
532539
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
533-
<dd class="field-odd"><p><strong>mirror_actions</strong> (<em>bool</em>) – actions corresponding to viewing robot from behind.
534-
first axis: left/right. second axis: back/forward. third axis: down/up.</p>
540+
<dd class="field-odd"><ul class="simple">
541+
<li><p><strong>mirror_actions</strong> (<em>bool</em>) – actions corresponding to viewing robot from behind.
542+
first axis: left/right. second axis: back/forward. third axis: down/up.</p></li>
543+
<li><p><strong>goal_update_mode</strong> (<em>str</em>) – the mode to update the goal in. Can be ‘target’ or ‘achieved’.</p></li>
544+
<li><p><strong>'target'</strong> (<em>If</em>)</p></li>
545+
<li><p><strong>'achieved'</strong> (<em>the goal is updated based on the current target goal. If</em>)</p></li>
546+
<li><p><strong>state.</strong> (<em>the goal is updated based on the current achieved</em>)</p></li>
547+
</ul>
535548
</dd>
536549
<dt class="field-even">Returns<span class="colon">:</span></dt>
537550
<dd class="field-even"><p><dl class="simple">
@@ -752,7 +765,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
752765

753766
<dl class="py method">
754767
<dt class="sig sig-object py" id="robosuite.devices.mjgui.MJGUI.input2action">
755-
<span class="sig-name descname"><span class="pre">input2action</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#robosuite.devices.mjgui.MJGUI.input2action" title="Link to this definition">#</a></dt>
768+
<span class="sig-name descname"><span class="pre">input2action</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">goal_update_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'desired'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#robosuite.devices.mjgui.MJGUI.input2action" title="Link to this definition">#</a></dt>
756769
<dd><p>Uses mocap body poses to determine action for robot. Obtain input_type
757770
(i.e. absolute actions or delta actions) and input_ref_frame (i.e. world frame, base frame or eef frame)
758771
from the controller itself.</p>
@@ -839,6 +852,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
839852
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.base_mode"><code class="docutils literal notranslate"><span class="pre">Device.base_mode</span></code></a></li>
840853
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.get_arm_action"><code class="docutils literal notranslate"><span class="pre">Device.get_arm_action()</span></code></a></li>
841854
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.get_controller_state"><code class="docutils literal notranslate"><span class="pre">Device.get_controller_state()</span></code></a></li>
855+
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.get_torso_action"><code class="docutils literal notranslate"><span class="pre">Device.get_torso_action()</span></code></a></li>
842856
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.grasp"><code class="docutils literal notranslate"><span class="pre">Device.grasp</span></code></a></li>
843857
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.input2action"><code class="docutils literal notranslate"><span class="pre">Device.input2action()</span></code></a></li>
844858
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#robosuite.devices.device.Device.start_control"><code class="docutils literal notranslate"><span class="pre">Device.start_control()</span></code></a></li>

docs/source/robosuite.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -464,6 +464,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
464464
<li class="toctree-l4"><a class="reference internal" href="robosuite.devices.html#robosuite.devices.device.Device.base_mode"><code class="docutils literal notranslate"><span class="pre">Device.base_mode</span></code></a></li>
465465
<li class="toctree-l4"><a class="reference internal" href="robosuite.devices.html#robosuite.devices.device.Device.get_arm_action"><code class="docutils literal notranslate"><span class="pre">Device.get_arm_action()</span></code></a></li>
466466
<li class="toctree-l4"><a class="reference internal" href="robosuite.devices.html#robosuite.devices.device.Device.get_controller_state"><code class="docutils literal notranslate"><span class="pre">Device.get_controller_state()</span></code></a></li>
467+
<li class="toctree-l4"><a class="reference internal" href="robosuite.devices.html#robosuite.devices.device.Device.get_torso_action"><code class="docutils literal notranslate"><span class="pre">Device.get_torso_action()</span></code></a></li>
467468
<li class="toctree-l4"><a class="reference internal" href="robosuite.devices.html#robosuite.devices.device.Device.grasp"><code class="docutils literal notranslate"><span class="pre">Device.grasp</span></code></a></li>
468469
<li class="toctree-l4"><a class="reference internal" href="robosuite.devices.html#robosuite.devices.device.Device.input2action"><code class="docutils literal notranslate"><span class="pre">Device.input2action()</span></code></a></li>
469470
<li class="toctree-l4"><a class="reference internal" href="robosuite.devices.html#robosuite.devices.device.Device.start_control"><code class="docutils literal notranslate"><span class="pre">Device.start_control()</span></code></a></li>
@@ -1768,6 +1769,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
17681769
<li class="toctree-l3"><a class="reference internal" href="robosuite.utils.html#robosuite.utils.ik_utils.IKSolver"><code class="docutils literal notranslate"><span class="pre">IKSolver</span></code></a><ul>
17691770
<li class="toctree-l4"><a class="reference internal" href="robosuite.utils.html#robosuite.utils.ik_utils.IKSolver.action_split_indexes"><code class="docutils literal notranslate"><span class="pre">IKSolver.action_split_indexes()</span></code></a></li>
17701771
<li class="toctree-l4"><a class="reference internal" href="robosuite.utils.html#robosuite.utils.ik_utils.IKSolver.forward_kinematics"><code class="docutils literal notranslate"><span class="pre">IKSolver.forward_kinematics()</span></code></a></li>
1772+
<li class="toctree-l4"><a class="reference internal" href="robosuite.utils.html#robosuite.utils.ik_utils.IKSolver.get_controller_base_pose"><code class="docutils literal notranslate"><span class="pre">IKSolver.get_controller_base_pose()</span></code></a></li>
17711773
<li class="toctree-l4"><a class="reference internal" href="robosuite.utils.html#robosuite.utils.ik_utils.IKSolver.get_targets"><code class="docutils literal notranslate"><span class="pre">IKSolver.get_targets()</span></code></a></li>
17721774
<li class="toctree-l4"><a class="reference internal" href="robosuite.utils.html#robosuite.utils.ik_utils.IKSolver.reset_to_initial_state"><code class="docutils literal notranslate"><span class="pre">IKSolver.reset_to_initial_state()</span></code></a></li>
17731775
<li class="toctree-l4"><a class="reference internal" href="robosuite.utils.html#robosuite.utils.ik_utils.IKSolver.set_target_positions"><code class="docutils literal notranslate"><span class="pre">IKSolver.set_target_positions()</span></code></a></li>

0 commit comments

Comments
 (0)