cookie_description 1.0.0__tar.gz

cookie_description-1.0.0/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Start this changelog.
+
+[unreleased]: https://codeberg.org/stephane-caron/cookie_description/compare/v1.0.0...main
+[1.0.0]: https://codeberg.org/stephane-caron/cookie_description/releases/tag/v1.0.0

cookie_description-1.0.0/LICENSE

@@ -0,0 +1,212 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+   COOKIE SUBCOMPONENTS:
+
+   This project includes visual mesh files from mjbots Robotic Systems
+   <https://mjbots.com/> and distributed under the Apache License, Version 2.0.
+   The original files were the mj5208 CAD model and qdd100 STEP file.
+
+   This project includes a mesh file distributed under the MIT License at:
+   <https://github.com/luxonis/oak-hardware/tree/7d569e3ccdff30014a498dc6c64a2e0dcad6964c/DM9095_OAK-D-LITE_DepthAI_USB3C/3D_Models>.
+   The original file was named `DM9095_enclosure.STL`. The mesh was rescaled
+   the origin of its coordinate system was centered.

cookie_description-1.0.0/NOTICE

@@ -0,0 +1,6 @@
+This project includes contributions made under the following copyrights:
+
+- Copyright 2022 mjbots Robotic Systems
+- Copyright 2024 Luxonis Holding Corporation
+- Copyright 2024 Michael Mathieu
+- Copyright 2022-2026 Stéphane Caron

cookie_description-1.0.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: cookie_description
+Version: 1.0.0
+Summary: Robot description for Cookie.
+Author-email: Stéphane Caron <stephane.caron@normalesup.org>
+Maintainer-email: Stéphane Caron <stephane.caron@normalesup.org>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+License-File: LICENSE
+Project-URL: Changelog, https://codeberg.org/stephane-caron/cookie_description/blob/master/CHANGELOG.md
+Project-URL: Source, https://codeberg.org/stephane-caron/cookie_description
+Project-URL: Tracker, https://codeberg.org/stephane-caron/cookie_description/issues
+
+# Cookie wheeled biped robot
+
+<img src="https://user-images.githubusercontent.com/1189580/169594012-2d685579-2b66-4470-9def-57bd0656b420.png" align="right" width="300">
+
+[![PyPI version](https://img.shields.io/pypi/v/cookie_description)](https://pypi.org/project/cookie_description/)
+
+URDF descriptions for [Cookie](https://github.com/orgs/upkie/discussions/545), an original redesign of [Upkie wheeled bipeds](https://github.com/upkie/upkie).
+
+## Trying it out
+
+You can use [uv](https://docs.astral.sh/uv/) to check out the robot description directly from the command line:
+
+```console
+uvx cookie_description simulation   # simulate a Cookie in PyBullet
+uvx cookie_description visualizer   # display the Cookie description in Viser
+```
+
+If you have [pixi](https://pixi.prefix.dev/), you can run the same commands with `pixi run`.
+
+## Python module
+
+The `cookie_description` module helps retrieve the robot description in Python. It can be installed from PyPI:
+
+```
+pip install cookie_description
+```
+
+Start by importing it:
+
+```python
+import cookie_description
+```
+
+The module provides the following paths:
+
+<dl>
+    <dt>
+        <code>cookie_description.PATH</code>
+    </dt>
+    <dd>
+        Path to the "cookie_description" folder itself.
+    </dd>
+    <dt>
+        <code>cookie_description.MESHES_PATH</code>
+    </dt>
+    <dd>
+        Path to the "meshes" folder.
+    </dd>
+    <dt>
+        <code>cookie_description.URDF_PATH</code>
+    </dt>
+    <dd>
+        Path to the URDF file of the model.
+    </dd>
+    <dt>
+        <code>cookie_description.XACRO_PATH</code>
+    </dt>
+    <dd>
+        Path to the Xacro file of the model.
+    </dd>
+</dl>
+

cookie_description-1.0.0/README.md

@@ -0,0 +1,61 @@
+# Cookie wheeled biped robot
+
+<img src="https://user-images.githubusercontent.com/1189580/169594012-2d685579-2b66-4470-9def-57bd0656b420.png" align="right" width="300">
+
+[![PyPI version](https://img.shields.io/pypi/v/cookie_description)](https://pypi.org/project/cookie_description/)
+
+URDF descriptions for [Cookie](https://github.com/orgs/upkie/discussions/545), an original redesign of [Upkie wheeled bipeds](https://github.com/upkie/upkie).
+
+## Trying it out
+
+You can use [uv](https://docs.astral.sh/uv/) to check out the robot description directly from the command line:
+
+```console
+uvx cookie_description simulation   # simulate a Cookie in PyBullet
+uvx cookie_description visualizer   # display the Cookie description in Viser
+```
+
+If you have [pixi](https://pixi.prefix.dev/), you can run the same commands with `pixi run`.
+
+## Python module
+
+The `cookie_description` module helps retrieve the robot description in Python. It can be installed from PyPI:
+
+```
+pip install cookie_description
+```
+
+Start by importing it:
+
+```python
+import cookie_description
+```
+
+The module provides the following paths:
+
+<dl>
+    <dt>
+        <code>cookie_description.PATH</code>
+    </dt>
+    <dd>
+        Path to the "cookie_description" folder itself.
+    </dd>
+    <dt>
+        <code>cookie_description.MESHES_PATH</code>
+    </dt>
+    <dd>
+        Path to the "meshes" folder.
+    </dd>
+    <dt>
+        <code>cookie_description.URDF_PATH</code>
+    </dt>
+    <dd>
+        Path to the URDF file of the model.
+    </dd>
+    <dt>
+        <code>cookie_description.XACRO_PATH</code>
+    </dt>
+    <dd>
+        Path to the Xacro file of the model.
+    </dd>
+</dl>

cookie_description-1.0.0/cookie_description/__init__.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Robot description for Cookie."""
+
+from .paths import MESHES_PATH, PATH, URDF_PATH, XACRO_PATH
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "MESHES_PATH",
+    "PATH",
+    "URDF_PATH",
+    "XACRO_PATH",
+]

cookie_description-1.0.0/cookie_description/__main__.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Entry point for ``uvx cookie_description <command>``."""
+
+import runpy
+import sys
+
+COMMANDS = {
+    "simulation": "cookie_description.simulation",
+    "visualizer": "cookie_description.visualizer",
+}
+
+
+def main():
+    """Run a cookie_description command."""
+    if len(sys.argv) < 2 or sys.argv[1] not in COMMANDS:
+        available = ", ".join(sorted(COMMANDS))
+        print("Usage: cookie_description <command>")
+        print(f"Available commands: {available}")
+        sys.exit(1)
+    command = sys.argv[1]
+    sys.argv = sys.argv[1:]  # shift so the submodule sees clean argv
+    runpy.run_module(COMMANDS[command], run_name="__main__")
+
+
+if __name__ == "__main__":
+    main()

cookie_description-1.0.0/cookie_description/collision_viser_visualizer.py

@@ -0,0 +1,96 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from pinocchio import visualize
+
+
+class CollisionViserVisualizer(visualize.ViserVisualizer):
+    """ViserVisualizer that renders collision geometries as wireframes.
+
+    While making Cookie's URDF, it is useful to overlay collision meshes on top
+    of the visual meshes to verify their fit. Viser's alpha-blending is
+    order-dependent and doesn't perform depth sorting, so transparent collision
+    meshes appear incorrectly from certain viewing angles. We thus render them
+    as wireframes.
+    """
+
+    _visual_opacity: float = 1.0
+    _visual_handles: list  # list of (handle, parent_frame_id) pairs
+    _collision_handles: list  # list of (handle, parent_frame_id) pairs
+
+    def loadViewerModel(self, *args, **kwargs):
+        """Reset tracked handles before (re)loading the model."""
+        self._visual_handles = []
+        self._collision_handles = []
+        super().loadViewerModel(*args, **kwargs)
+
+    def loadViewerGeometryObject(self, geometry_object, prefix="", color=None):
+        """Load geometry object with wireframe rendering for collision meshes.
+
+        Temporarily patches the Viser scene creation methods to inject
+        wireframe=True before delegating to the parent implementation. The
+        patch is scoped to a single geometry object and cleaned up in a finally
+        block.
+        """
+        scene = self.viewer.scene
+        _METHODS = ("add_box", "add_icosphere", "add_mesh_simple")
+
+        is_collision = "collision" in prefix
+        parent_frame = int(geometry_object.parentFrame)
+
+        for method_name in _METHODS:
+            original = getattr(scene, method_name)
+
+            def patched(
+                *args,
+                _orig=original,
+                _collision=is_collision,
+                _pf=parent_frame,
+                **kwargs,
+            ):
+                if _collision:
+                    kwargs["wireframe"] = True
+                    kwargs.pop("opacity", None)
+                else:
+                    kwargs["opacity"] = self._visual_opacity
+                handle = _orig(*args, **kwargs)
+                if _collision:
+                    self._collision_handles.append((handle, _pf))
+                else:
+                    self._visual_handles.append((handle, _pf))
+                return handle
+
+            setattr(scene, method_name, patched)
+
+        try:
+            super().loadViewerGeometryObject(geometry_object, prefix, color)
+        finally:
+            for method_name in _METHODS:
+                delattr(scene, method_name)
+
+    def set_visual_opacity(self, value: float) -> None:
+        """Update opacity of all loaded visual meshes uniformly."""
+        self._visual_opacity = value
+        for handle, _ in self._visual_handles:
+            handle.opacity = value
+
+    def set_joint_focus(
+        self, highlighted_frames: frozenset, dim_opacity: float = 0.2
+    ) -> None:
+        """Make parent and child link visuals opaque, dim everything else.
+
+        Also restricts collision mesh visibility to the highlighted frames.
+        """
+        for handle, parent_frame in self._visual_handles:
+            handle.opacity = (
+                1.0 if parent_frame in highlighted_frames else dim_opacity
+            )
+        for handle, parent_frame in self._collision_handles:
+            handle.visible = parent_frame in highlighted_frames
+
+    def set_all_collisions_visible(self, visible: bool) -> None:
+        """Set visibility on all individual collision handles."""
+        for handle, _ in self._collision_handles:
+            handle.visible = visible

cookie_description-1.0.0/cookie_description/paths.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+Paths to the URDF package and main description for Cookie.
+"""
+
+import os
+
+# Path to the cookie_description module
+PATH = os.path.dirname(os.path.realpath(__file__))
+
+# Path to the meshes folder
+MESHES_PATH = os.path.join(PATH, "meshes")
+
+# Path to the robot's URDF
+URDF_PATH = os.path.join(PATH, "urdf", "cookie.urdf")
+
+# Path to the robot's Xacro source
+XACRO_PATH = os.path.join(PATH, "xacro", "cookie.xacro")
+
+__all__ = [
+    "MESHES_PATH",
+    "PATH",
+    "URDF_PATH",
+    "XACRO_PATH",
+]

cookie_description-1.0.0/cookie_description/simulation.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+Load a robot description, specified from the command line, in PyBullet.
+
+This example requires PyBullet, which is installed by ``pip install pybullet``.
+"""
+
+import math
+import os
+
+import loop_rate_limiters
+import pybullet
+import pybullet_data
+
+from .paths import PATH, URDF_PATH
+
+if __name__ == "__main__":
+    pybullet.connect(pybullet.GUI)
+    pybullet.configureDebugVisualizer(pybullet.COV_ENABLE_GUI, 0)
+    pybullet.configureDebugVisualizer(pybullet.COV_ENABLE_SHADOWS, 0)
+    pybullet.setAdditionalSearchPath(PATH)
+    pybullet.setAdditionalSearchPath(os.path.dirname(PATH))
+    robot = pybullet.loadURDF(URDF_PATH)
+    pybullet.setGravity(0, 0, -9.81)
+    pybullet.setAdditionalSearchPath(pybullet_data.getDataPath())
+    plane = pybullet.loadURDF("plane.urdf")
+    pybullet.resetBasePositionAndOrientation(
+        robot, [0, 0, 1.5], [0, 0.5, 0.7, 0.3]
+    )
+
+    # Find hip and knee joint indices
+    hip_indices = []
+    knee_indices = []
+    for i in range(pybullet.getNumJoints(robot)):
+        joint_info = pybullet.getJointInfo(robot, i)
+        joint_name = joint_info[1].decode("utf-8")
+        if joint_info[2] != pybullet.JOINT_REVOLUTE:
+            continue
+        pybullet.setJointMotorControl2(
+            robot, i, pybullet.VELOCITY_CONTROL, force=0
+        )
+        if "hip" in joint_name:
+            hip_indices.append(i)
+        elif "knee" in joint_name:
+            knee_indices.append(i)
+
+    rate = loop_rate_limiters.RateLimiter(frequency=200.0)
+    pybullet.setTimeStep(rate.dt)
+    t = 0.0
+    while True:
+        hip_target = 0.4 * math.sin(2.0 * math.pi * 0.5 * t)
+        knee_target = -2.0 * hip_target
+        for idx in hip_indices:
+            pybullet.setJointMotorControl2(
+                robot, idx, pybullet.POSITION_CONTROL,
+                targetPosition=hip_target, force=10.0,
+            )
+        for idx in knee_indices:
+            pybullet.setJointMotorControl2(
+                robot, idx, pybullet.POSITION_CONTROL,
+                targetPosition=knee_target, force=10.0,
+            )
+        pybullet.stepSimulation()
+        t += rate.dt
+        rate.sleep()